verify-module

To verify module documentation and structure, scan the module directory tree to confirm required files like README.md and DESIGN.md are present, discover source and test directories, and flag missing or underspecified files to prevent incomplete modules from shipping.

A module audit is a repository scan that validates structural integrity by checking for required documentation and test directories. It ensures modules meet documentation expectations during new module creation, refactoring, pre-commit checks, or release preparation.

Yes, you can use a module scanner for pre-commit checks in Node.js. It generates human-readable reports or JSON output with appropriate exit codes, allowing CI integration to block commits that lack design reasoning or basic usage documentation.

To check for missing README or DESIGN files, run a module directory scan that validates documentation presence and structural integrity. The scanner flags missing or underspecified files and produces a report detailing which modules lack design reasoning or basic usage docs.

Yes, the module audit tool supports JSON output for CI integration. It produces machine-readable JSON and human-readable reports with appropriate exit codes, allowing automated workflows to fail when modules lack required documentation or test directories.