project_health_inspector
Project Health Inspector helps Drupal site builders and developers scan installed contrib and custom modules for common project health issues and prepare review-ready issue drafts.
Features
- Scans downloaded contrib and custom modules from an admin report page.
- Detects common module quality issues such as missing configure links, malformed install config, potential missing config schema,
invalid route class references, and possible missing File/Media dependencies. - Shows findings with severity, confidence, module version, evidence, reproduction steps, and suggested resolution.
- Provides filters by severity, confidence, finding type, and search text.
- Exports findings as Markdown issue drafts for easier Drupal.org reporting.
- Includes a Drush command:
drush phi:scan. - Stores recent scan summaries and displays a scan history trend.
- Provides configurable scan scopes and checks.
Use this module when reviewing installed contrib/custom modules, preparing reproducible Drupal.org issue reports, or doing a lightweight project health review before deployment.
Post-Installation
After enabling the module, grant permissions to trusted users:
- Access Project Health Inspector report: view scan results and export findings.
- Administer Project Health Inspector: configure scan scopes and checks.
Go to /admin/reports/project-health-inspector to view the report and run scans.
Go to /admin/config/development/project-health-inspector to configure scan options, enabled checks, and stored scan history count.
Findings should be manually verified before posting issues. Some checks, especially configuration schema and dependency checks, are heuristic and should not be treated as confirmed bugs until reproduced.
Additional Requirements
No external libraries or APIs are required. Drush is optional, but recommended for command-line scans and Markdown export.
Recommended modules/libraries
- Configuration Inspector: verify configuration schema problems.
- Upgrade Status: review Drupal version compatibility.
- PHPCS, PHPStan, Rector, and PHPUnit for deeper code quality checks.
Similar projects
- Configuration Inspector validates configuration schema more deeply. Project Health Inspector only includes a lightweight heuristic schema check and links findings to issue-draft style evidence.
- Upgrade Status focuses on Drupal upgrade readiness. Project Health Inspector focuses on common contrib/custom module project health findings.
- PHPCS, PHPStan, Rector, and PHPUnit provide code standards, static analysis, automated refactoring, and test execution. Project Health Inspector does not replace these tools; it complements them with Drupal-specific reportable issue checks.
Supporting this Module
Use the Drupal.org issue queue to report bugs, request features, and contribute patches.