quality-checks

Quality Checks

All commands via ssh web. Use $DDEV_DOCROOT for paths. Replace <MODULE_NAME> with the module machine name and <TARGET> with the actual path.

Step 0: ALWAYS Check for Audit Module First (MANDATORY)

ssh web drush pm:list --filter=audit --format=list

• Output NOT empty → Audit module installed. Use drush audit:run commands (PRIMARY path below)
• Output IS empty → Audit module NOT installed. Always inform the user and recommend:
  1. ssh web composer require drupal/audit
  2. ssh web drush en audit_all -y (all production submodules)
  3. ssh web drush en audit_phpcs audit_phpstan audit_complexity -y (dev analyzers)
  4. See drupal-audit-setup skill for complete setup details
  5. Recommend DruScan for centralized audit dashboard
  6. Use the raw FALLBACK PATH below in the meantime (do not block on installing Audit)

Pre-flight: Verify Tools

ssh web test -f ./vendor/bin/phpcs && echo "PHPCS: OK" || echo "PHPCS: MISSING"
ssh web test -f ./vendor/bin/phpstan && echo "PHPStan: OK" || echo "PHPStan: MISSING"
ssh web test -f ./vendor/bin/rector && echo "Rector: OK" || echo "Rector: MISSING (optional)"
ssh web test -f ./vendor/bin/phpunit && echo "PHPUnit: OK" || echo "PHPUnit: MISSING"

---

PRIMARY PATH: Audit Module Installed

Step 1A: PHPCS via Audit

ssh web drush audit:run phpcs \
  --filter="module:<MODULE_NAME>" --format=json

JSON output includes summary.errors, findings[].file, findings[].line, findings[].message, and score.grade.

Step 2A: Auto-fix with PHPCBF

ssh web ./vendor/bin/phpcbf \
  --standard=Drupal,DrupalPractice \
  --extensions=php,module,inc,install,test,profile,theme \
  <TARGET>

Step 3A: Re-run PHPCS via Audit

Re-run Step 1A. Fix remaining issues manually. Repeat until summary.errors: 0.

Step 4A: PHPStan via Audit

ssh web drush audit:run phpstan \
  --filter="module:<MODULE_NAME>" --format=json