Annotations Audit

Submodule of the Annotations suite.

Combines site structure scanning and annotation coverage reporting. Crawls opted-in annotation targets on cron to snapshot the Drupal content architecture, then reports how completely each target has been annotated.

---

Requirements

• annotations (core Annotations module)

---

Installation

ddev drush en annotations_audit

---

Pages

Path	Permission	Description
/admin/config/annotations/audit/coverage	view annotation audit coverage	Coverage report with score, status per target, and gap details
/admin/config/annotations/audit/scan	administer annotations audit scan	Last waypoint timestamp, accumulated structural changes, scope drift (out-of-scope fields), snapshot grouped by entity type, "Check for changes" and "Save waypoint" buttons

---

Drush

# Run a scan, print summary, save snapshot
ddev drush annotations:scan

# Include field names in output
ddev drush ann:scan --fields

# Compare against last snapshot
ddev drush ann:scan --diff

# Exit non-zero if structural changes detected (pre-commit hook use)
ddev drush ann:scan --check

# Output as JSON or YAML
ddev drush ann:scan --format=json

---

affects_coverage

Whether a given annotation type degrades coverage status is controlled by the affects_coverage flag on each annotation type. Configure it via the annotation type edit form (visible when this module is installed). Default is FALSE — opt-in only.

---

See DEVELOPING.md for the CoverageService and ScanService PHP APIs and a performance note.