Documentation
¶
Overview ¶
Package validate checks for undocumented package managers, config files, and directories.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CheckConfigFiles ¶
CheckConfigFiles detects config files not documented in CONVENTIONS.md.
Scans for common configuration files (.eslintrc, .prettierrc, tsconfig.json, etc.) and suggests documenting them if CONVENTIONS.md doesn't mention the related topic.
Parameters:
- ctx: Loaded context containing the files
Returns:
- []Action: Suggested actions for undocumented configurations
func CheckNewDirectories ¶
CheckNewDirectories detects important directories not in ARCHITECTURE.md.
Scans top-level directories for common code directories (src, lib, cmd, etc.) and suggests documenting them if ARCHITECTURE.md doesn't mention them. Skips hidden directories and common non-code directories (node_modules, vendor, dist, build).
Parameters:
- ctx: Loaded context containing the files
Returns:
- []Action: Suggested actions for undocumented directories
func CheckPackageFiles ¶
CheckPackageFiles detects package manager files without dependency documentation.
Checks for common package files (package.json, go.mod, etc.) and suggests documenting dependencies if no DEPENDENCIES.md exists or ARCHITECTURE.md doesn't mention dependencies.
Parameters:
- ctx: Loaded context containing the files
Returns:
- []Action: Suggested actions for undocumented dependencies
Types ¶
This section is empty.
Source Files