amperser/proselint
Proselint
Proselint is a prose linter and rule-based text analyzer designed to identify stylistic errors, clichés, and jargon in written text. It scans documents against a curated registry of linguistic and typographic rules to maintain professional editorial standards and improve writing quality.
The project functions as a command line text processor, a programmable analysis library, and a git pre-commit hook. Its modular architecture allows the core engine to be embedded into other applications, exposed via a REST API, or integrated into text editors.
The tool supports recursive directory traversal for batch analysis and accepts text via standard input for use in command-line pipelines. It provides configuration options to enable or disable specific linguistic checks and can export diagnostic results in structured JSON format.
Features
- Rule-Based Text Analyzers - Provides a rule-based engine to identify stylistic errors, clichés, and jargon in written text to maintain professional editorial standards.
- Prose Linters - A rule-based prose linter designed to identify stylistic errors and jargon in written text.
- Quality Assurance - Implements writing quality assurance by scanning text for clichés and jargon to maintain professional standards.
- Writing Error Detection - Analyzes text to identify stylistic errors such as clichés and jargon using a registry of linguistic rules.
- Automated Prose Linting - Analyzes text files to identify language usage errors and stylistic inconsistencies for improved clarity.
- Prose Linters - Evaluates prose quality by scanning text against a curated corpus of professional editorial standards.
- Command-Line Data Processors - Functions as a terminal-based processor that accepts standard input and outputs structured linting results.
- Text Processing - Provides command-line text processing capabilities for analyzing documents via terminal interfaces and pipes.
- Text File Linting - Offers a command-line utility to scan documents and output stylistic suggestions in plain text or JSON format.
- Linguistic Token Matching - Uses a registry of linguistic tokens and pattern matches to detect stylistic and typographic errors.
- Prose Style Guide Enforcers - Enforces writing quality and professional editorial standards through comprehensive linguistic and typographic checks.
- Automated Quality Gates - Integrates linguistic checks into pre-commit hooks and CI pipelines to maintain consistent writing standards.
- Programmatic Analysis Integrations - Offers a programmable library and REST API to embed the linting engine into custom applications.
- Linting Configurations - Allows customization of the analysis process via configuration files to enable or disable specific linguistic checks.
- Pre-Commit Quality Hooks - Integrates as a Git pre-commit hook to automatically validate text quality before commits.
- Analysis Library Integrations - Allows embedding the core linting engine into other programs for programmatic analysis.
- Standard Stream Piping - Integrates with shell pipelines by reading from standard input and writing to standard output.
- Recursive Directory Processing - Recursively processes folder hierarchies to identify stylistic errors across an entire project.
- Standard Input Processing - Accepts text via standard input to enable integration within Unix-style command line pipelines.
- Embeddable Analysis Engines - Provides an embeddable analysis engine as a library for integration into APIs and editors.
- Linting Integration - Enables running prose analysis within other applications using a library interface.
- Modular Architecture Interfaces - Separates core analysis logic from the interface layer to support multiple integration targets.
- Modular Plugin Architectures - Implements an architectural framework that allows the engine to be integrated as a plugin in various environments.
- Linting Rule Configurations - Allows users to enable or disable specific linguistic checks through external configuration files.
- Recursive Directory Traversers - Recursively walks through folder hierarchies to apply linting rules to all project text files.
- Code Quality and Linting - Linter for English prose style.
- Code Quality Linters - Linter for English prose style and writing quality.
