# btford/write-good

**Attribution required: if you use, quote, or summarise this content, you must credit and link back to [awesome-repositories.com](https://awesome-repositories.com/repository/btford-write-good).**

5,074 stars · 189 forks · JavaScript · MIT

## Links

- GitHub: https://github.com/btford/write-good
- awesome-repositories: https://awesome-repositories.com/repository/btford-write-good.md

## Description

Write-good is a command-line text analysis tool and English prose linter designed to identify grammatical errors and stylistic weaknesses. It functions as a readability optimization tool that scans documents to identify passive voice and wordy phrases.

The system serves as a customizable prose style checker, allowing for the definition of specific language rules and forbidden terms to enforce project-specific writing guidelines.

The tool provides capabilities for automated text analysis, style guide enforcement, and technical writing quality improvement. It supports the integration of custom linting rules, rule set extensions, and phrase whitelisting to reduce false positives.

## Tags

### Content Management & Publishing

- [Automated Prose Linting](https://awesome-repositories.com/f/content-management-publishing/automated-prose-linting.md) — Analyzes written text against style guides for consistency in tone, grammar, and spelling. ([source](https://github.com/btford/write-good#readme))
- [Automated Text Analysis](https://awesome-repositories.com/f/content-management-publishing/automated-text-analysis.md) — Processes text files via a command line interface to quickly identify and fix language violations.
- [Technical Writing Tools](https://awesome-repositories.com/f/content-management-publishing/content-management-systems/content-architecture-modeling/documentation-tooling/authoring-editing/technical-writing-tools.md) — Provides specialized linting tools tailored for the creation of concise technical and instructional content.
- [Exemption Lists](https://awesome-repositories.com/f/content-management-publishing/prohibited-phrase-detection/exemption-lists.md) — Allows users to exempt designated phrases from being flagged as style violations. ([source](https://github.com/btford/write-good/blob/master/README.md))

### Artificial Intelligence & ML

- [Style Suggestions](https://awesome-repositories.com/f/artificial-intelligence-ml/linguistic-pattern-analysis/syntactic-prose-analysis/style-suggestions.md) — Scans text for passive voice and wordy phrases to provide specific suggestions for improvement. ([source](https://github.com/btford/write-good/blob/master/README.md))

### Part of an Awesome List

- [Regex Pattern Matching](https://awesome-repositories.com/f/awesome-lists/devtools/regex-and-pattern-matching/regex-pattern-matching.md) — Identifies stylistic violations by scanning text against a predefined library of regular expressions.

### Business & Productivity Software

- [Text Readability Optimizations](https://awesome-repositories.com/f/business-productivity-software/text-readability-optimizations.md) — Refines grammar and clarity to improve the human readability of natural language prose.

### Development Tools & Productivity

- [Prose Linters](https://awesome-repositories.com/f/development-tools-productivity/code-linters/prose-linters.md) — Provides a linter specifically designed for natural language and technical documentation.
- [Text File Linting](https://awesome-repositories.com/f/development-tools-productivity/linting-plugins/template-file-linting/text-file-linting.md) — Provides command-line utilities for scanning text files and flagging problematic phrasing. ([source](https://github.com/btford/write-good#readme))
- [Text Analysis CLIs](https://awesome-repositories.com/f/development-tools-productivity/text-analysis-clis.md) — Provides a command line interface for scanning documents and printing style suggestions to the terminal.
- [Custom Lint Rule Plugins](https://awesome-repositories.com/f/development-tools-productivity/code-quality-analysis/static-analysis-engines/static-analysis-tools/static-analysis-rules/framework-linting-rules/core-rule-extensions/custom-lint-rule-plugins.md) — Provides a plugin interface for adding custom lint rules beyond the built-in set. ([source](https://github.com/btford/write-good/blob/master/README.md))
- [Phrase Whitelists](https://awesome-repositories.com/f/development-tools-productivity/phrase-whitelists.md) — Filters out flagged violations by checking them against a user-defined list of ignored phrases.

### Software Engineering & Architecture

- [Prose Style Guide Enforcers](https://awesome-repositories.com/f/software-engineering-architecture/prose-style-guide-enforcers.md) — Automatically enforces corporate terminology and branding rules in natural language text.
- [Pluggable Component Architectures](https://awesome-repositories.com/f/software-engineering-architecture/component-injection-systems/pluggable-component-architectures.md) — Implements an architectural pattern that allows replacing or adding core linting logic via interface-based injection.
- [Prose Rule Sets](https://awesome-repositories.com/f/software-engineering-architecture/schema-validated-rule-sets/pluggable-rule-sets/prose-rule-sets.md) — Supports adding custom language checks or third-party rule sets to accommodate different style guides. ([source](https://github.com/btford/write-good#readme))