coding-standard-writer

What problem does it solve?

coding-standard-writer helps teams avoid inconsistent, opinion-based coding rules by deriving a coding standards document directly from the existing codebase.

Core Features & Use Cases

• Empirical majority inference: Detects indentation, naming conventions, comment styles, string quoting, and nesting patterns from provided files or folders.
• Inconsistency reporting (and optional fixes): Highlights formatting inconsistencies and only fixes them when explicitly requested, with an emphasis on validation via project tooling.
• Template-based document output: Produces a minimal or verbose style guide and writes it to a new file or inserts it into the appropriate section of README-style documentation.

Quick Start

Use coding-standard-writer to create a STYLE.md by inferring conventions from the ./src folder.