Write Good

Write-good est un outil d'analyse de texte en ligne de commande et un linter de prose anglaise conçu pour identifier les erreurs grammaticales et les faiblesses stylistiques. Il fonctionne comme un outil d'optimisation de la lisibilité qui scanne les documents pour identifier la voix passive et les phrases verbeuses.

Le système sert de vérificateur de style de prose personnalisable, permettant la définition de règles de langage spécifiques et de termes interdits pour appliquer des directives d'écriture spécifiques au projet.

L'outil fournit des capacités pour l'analyse de texte automatisée, l'application de guides de style et l'amélioration de la qualité de l'écriture technique. Il supporte l'intégration de règles de linting personnalisées, d'extensions de jeux de règles et de listes blanches de phrases pour réduire les faux positifs.

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.

Historique des stars

btfordwrite-good

Name: btford/write-good
Author: btford

View on GitHub

5,074 stars189 forksJavaScriptMIT9 vues

Write Good

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.

Alternatives open source à Write Good

Projets open source similaires, classés selon le nombre de fonctionnalités partagées avec Write Good.

vale-cli/vale
vale-cli/vale
5,477Voir sur GitHub
Vale is a markup-aware prose linter and command-line interface tool designed to enforce editorial style guides and grammar rules across various document formats. It functions as a YAML-based style guide engine that analyzes text for consistency in tone, spelling, and terminology while ignoring non-prose elements like code blocks. The project distinguishes itself through a flexible extensibility model that allows users to define custom linting rules using YAML configurations, regular expressions, and external scripts for complex validation logic. It supports a wide array of documentation forma
Golinterlintingvale
Voir sur GitHub5,477
amperser/proselint
amperser/proselint
4,542Voir sur GitHub
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
JavaScript
Voir sur GitHub4,542
chmln/sd
chmln/sd
7,220Voir sur GitHub
sd is a command line text manipulation utility designed for searching and replacing text patterns across multiple files. It functions as a regex-based find and replace tool that allows for in-place file editing directly from the terminal. The project supports both regular expression replacements, including the use of capture groups for complex transformations, and fixed string replacement for literal text substitutions. It specifically handles multi-line text replacement by processing file contents as single blocks to match patterns that span across newline characters. The tool provides capa
Rust
Voir sur GitHub7,220

Questions fréquentes

Que fait btford/write-good ?

Quelles sont les fonctionnalités principales de btford/write-good ?

Les fonctionnalités principales de btford/write-good sont : Automated Prose Linting, Style Suggestions, Regex Pattern Matching, Text Readability Optimizations, Automated Text Analysis, Prose Linters, Text File Linting, Text Analysis CLIs.

Quelles sont les alternatives open-source à btford/write-good ?

Les alternatives open-source à btford/write-good incluent : vale-cli/vale — Vale is a markup-aware prose linter and command-line interface tool designed to enforce editorial style guides and… amperser/proselint — Proselint is a prose linter and rule-based text analyzer designed to identify stylistic errors, clichés, and jargon in… chmln/sd — sd is a command line text manipulation utility designed for searching and replacing text patterns across multiple… get-alex/alex — Alex is an inclusive language linter and content auditor designed to detect and flag insensitive, inconsiderate, or… benhmoore/knwl.js — Knwl.js is a JavaScript named entity recognition library and text entity extractor. It functions as an extensible text… automattic/harper — Harper is a local English linter and grammar checker designed as an IDE writing assistant. It operates as a language…