Code quality¶

PHPStan, PHP CodeSniffer and cspell¶

Each tool runs with the configuration of the project being checked, or a default one when the project has none:

ddev phpstan core/modules/node         # PHPStan on specific paths
ddev phpstan modules/contrib/token     # the module's own configuration, if it has one
ddev phpstan                           # full analysis with core's baseline, from the project root
ddev phpcs core/modules/node           # coding standard checks
ddev phpcs                             # whole codebase, from the project root
ddev cspell core/modules/node/**       # spell checking (globs)
ddev cspell                            # whole codebase, from the project root

ddev cspell needs core's node dependencies. Install them once:

ddev exec 'corepack enable && cd core && yarn install'

Paths¶

Paths and globs are relative to the directory you run the command from. Without any, a command checks that directory. From the project root, that is the whole codebase:

cd modules/contrib/token
ddev phpstan                           # the module
ddev phpcs src                         # the module's src directory

Paths that belong to several projects are checked one project at a time, each with its own configuration.

Which configuration is used¶

Each command takes the nearest configuration in the checked path or a parent directory, the same way contrib CI finds one:

A project without a configuration of its own falls back to a default:

• A contrib project (one with a .gitlab-ci.yml) gets the default configuration contrib CI uses.
• Everything else gets core's.

ddev phpstan analyses against the PHP version core declares in config.platform, not the container's PHP version, so results match core's CI.

Contrib projects¶

A contrib project is checked the way contrib CI checks it. Contrib CI's defaults differ from core's:

• PHP CodeSniffer uses the full Drupal ruleset. Core's standard skips some rules, such as the line length check in tests.
• PHPStan runs at level 0 and adds the project's baseline (phpstan-baseline.neon, or whatever _PHPSTAN_BASELINE_FILENAME names). Core's configuration runs at level 1, with rules only core uses.
• cspell flags fewer words than core's configuration.

The project's .gitlab-ci.yml variables are applied too:

cspell also gets what contrib CI adds to every project's configuration: the module names, a few common words and core's dictionaries.

_PHPCS_EXTRA, _PHPSTAN_EXTRA and _CSPELL_EXTRA are not applied.

Checking a change before committing¶

ddev commit-code-check runs core's core/scripts/dev/commit-code-check.sh. It checks only the files you changed, with cspell, PHP CodeSniffer, PHPStan, ESLint, Stylelint and a few file checks (file modes, no changes in vendor/ or core/node_modules/):

ddev commit-code-check                      # modified and untracked files in the working directory
ddev commit-code-check --cached             # staged files only
ddev commit-code-check --branch 11.x        # everything your branch changed compared to 11.x
ddev commit-code-check --memory-unlimited   # no PHP memory limit

There has to be something to check: on a clean checkout it prints "There are no files to check" and stops. The spelling and JavaScript checks run through yarn, so the first run installs core's node dependencies, which takes a few minutes.