btford/write-good
Write Good
Write-good es una herramienta de análisis de texto de línea de comandos y un linter de prosa en inglés diseñado para identificar errores gramaticales y debilidades estilísticas. Funciona como una herramienta de optimización de legibilidad que escanea documentos para identificar voz pasiva y frases redundantes.
El sistema sirve como un corrector de estilo de prosa personalizable, permitiendo la definición de reglas de lenguaje específicas y términos prohibidos para hacer cumplir las pautas de escritura específicas del proyecto.
La herramienta proporciona capacidades para el análisis de texto automatizado, cumplimiento de guías de estilo y mejora de la calidad de la escritura técnica. Admite la integración de reglas de linting personalizadas, extensiones de conjuntos de reglas y listas blancas de frases para reducir los falsos positivos.
Features
- Automated Prose Linting - Analyzes written text against style guides for consistency in tone, grammar, and spelling.
- Style Suggestions - Scans text for passive voice and wordy phrases to provide specific suggestions for improvement.
- Regex Pattern Matching - Identifies stylistic violations by scanning text against a predefined library of regular expressions.
- Text Readability Optimizations - Refines grammar and clarity to improve the human readability of natural language prose.
- Automated Text Analysis - Processes text files via a command line interface to quickly identify and fix language violations.
- Prose Linters - Provides a linter specifically designed for natural language and technical documentation.
- Text File Linting - Provides command-line utilities for scanning text files and flagging problematic phrasing.
- Text Analysis CLIs - Provides a command line interface for scanning documents and printing style suggestions to the terminal.
- Prose Style Guide Enforcers - Automatically enforces corporate terminology and branding rules in natural language text.
- Technical Writing Tools - Provides specialized linting tools tailored for the creation of concise technical and instructional content.
- Exemption Lists - Allows users to exempt designated phrases from being flagged as style violations.
- Custom Lint Rule Plugins - Provides a plugin interface for adding custom lint rules beyond the built-in set.
- Phrase Whitelists - Filters out flagged violations by checking them against a user-defined list of ignored phrases.
- Pluggable Component Architectures - Implements an architectural pattern that allows replacing or adding core linting logic via interface-based injection.
- Prose Rule Sets - Supports adding custom language checks or third-party rule sets to accommodate different style guides.
