Checks that the list of Juneau modules in artifact-paths.json matches the modules[] of the projects in src/data/projects.ts, and that artifact-packages.json and the allow-list agree with it.
verify-docs.py instead.python3 scripts/check-doc-inventory.py python3 scripts/check-doc-inventory.py --strict python3 scripts/check-doc-inventory.py --json
Standard library only; it does not invoke Maven or Docusaurus.
| Option | Argument | Default | Meaning |
|---|---|---|---|
--strict | none | off | Warnings also make the exit code non-zero. |
--json | none | off | Print a JSON report (summary and findings) instead of text. |
--docs-dir | directory | parent of scripts/ | Docs root to check. |
artifact-paths.json, artifact-packages.json, the projects from src/data/projects.ts (through project_index.py) and scripts/check-doc-inventory-allowlist.txt (one module name per line, # comments; missing file means empty).artifact-paths.json minus the AGGREGATOR_POMS set (defined in project_index.py) minus the allow-list.modules[]; a module in none (and not allow-listed) is an error, as is an unreadable projects.ts.modules[] must be a key of artifact-paths.json.artifact-packages.json key must be a key of artifact-paths.json (error); a publishable module with no packages entry is a warning.artifact-paths.json (error), and must not also be in a project's modules[] (error).Text report on stdout (or JSON with --json); nothing is written. The text ends with check-doc-inventory: N errors, M warnings.
| Code | Meaning |
|---|---|
| 0 | No errors (and no warnings under --strict). |
| 1 | At least one error, or a warning under --strict. |
| 2 | artifact-paths.json or artifact-packages.json is missing. |
AGGREGATOR_POMS is in project_index.py; update it when the reactor structure changes.build-docs.py, so run this after a build if you want it to see current modules.modules[] entries are read by the strict projects.ts parser; a format error in that file is reported as an inventory error with its line number.verify-docs.py, build-docs.py