Overview of the Gridfinity Catalog Validation Tool
mainThe validation tool is a zero-dependency, extensible JavaScript framework located in the validate/ directory. It is designed to validate the structure and content of the README.md file in the gridfinity-catalog repository, which contains markdown tables organized by section.
Key components include:
- Parser (
parser.js): Splits the markdown file into sections and extracts tables into structured data. - Rule Engine (
engine.js): Uses a registry pattern to manage both global rules and section-specific rules. - Rules (
rules/): Contains individual files for each section (e.g.,baseplates.js,bins.js,stackfinity.js) and shared helpers. This allows for easy extension by adding new files. - CLI (
index.js): The command-line interface for running validations. - Printable Checklist (
warnings-checklist.html): A print-ready HTML file with CSS checkboxes for manual verification of warnings.