get-alex/alex
Alex
Alex is an inclusive language linter and content auditor designed to detect and flag insensitive, inconsiderate, or gendered phrasing. It serves as a profanity detection tool that identifies offensive words based on configurable certainty ratings to ensure professional and neutral content.
The tool distinguishes itself through diff-aware analysis, allowing it to function as a continuous integration validator. By analyzing pull request deltas, it can flag new insensitive phrasing while ignoring existing legacy issues to prevent old warnings from blocking new merges.
The project supports multi-format text parsing for Markdown, MDX, and HTML files. It includes capabilities for rule configuration, term suppression, and file exclusion via JSON, YAML, or JavaScript files, as well as the ability to suppress specific text blocks using inline comments.
The tool is available as a command line interface for scanning directories and files.
Features
- Inclusive Language Auditors - Scans text files to detect and flag insensitive, inconsiderate, or gendered phrasing for inclusive writing.
- Text File Linting - Provides a command line interface to scan directories and files for insensitive or inconsiderate phrasing.
- Text Toxicity Detection - Identifies potentially offensive words and profanity based on configurable certainty ratings.
- Diff-Aware Result Filtering - Filters linting results to flag only changes in new lines, preventing legacy issues from blocking merges.
- Linguistic Quality Checkers - Applies linguistic rules to documentation to remove gendered or ableist terms during the editing process.
- Content Auditors - Provides static analysis for Markdown, HTML, and MDX files to suggest neutral alternatives to problematic terminology.
- Dictionary-Based Pattern Matching - Detects insensitive phrasing by comparing text against predefined lists of problematic words and inclusive alternatives.
- Continuous Integration Checks - Executes automated inclusive language checks on pull requests within continuous integration pipelines.
- Profanity Detectors - Identifies offensive words and profanities based on configurable certainty ratings to ensure professional content.
- Inclusive Content Reviews - Detects gendered, ableist, or intolerant language and suggests more inclusive alternatives.
- Linting Rule Configurations - Provides settings to define which linguistic checks are applied via external JSON, YAML, or JavaScript files.
- Delta-Aware Analysis - Analyzes only changed lines in a pull request to prevent existing legacy warnings from blocking new merges.
- Content Accessibility Audits - Analyzes Markdown and HTML files to ensure language is neutral and accessible to a diverse audience.
- Plain Text Extraction - Extracts plain text from Markdown, MDX, and HTML files for linguistic analysis.
- Content Format Support - Scans plain text, Markdown, MDX, and HTML files for insensitive language via CLI or API.
- Certainty-Rated Detection - Identifies offensive words using configurable certainty ratings to determine the severity of warnings.
- False Positive Suppression Lists - Suppresses warnings for designated words via configuration files to prevent false positives.
- Rule Suppression Comments - Supports the use of inline comments to disable specific linting rules for targeted text blocks.
- Documentation Validation - Automates checks within continuous integration pipelines to prevent insensitive language from being merged into a codebase.
- Merge Change Validations - Analyzes pull request diffs to ensure no new insensitive language is introduced before merging.
- Command Line Tools - Linter for insensitive or unequal phrasing.
- General Utilities - Catch insensitive, inconsiderate writing.
- Quality Assurance Tools - Catches insensitive or inconsiderate writing in documentation.
- Terminal Utilities - Linter for insensitive or unequal phrasing.
Star history
How this analysis was created: This summary and feature list were written by an AI model that read the project's README and public documentation pages. Each feature links to the documentation it came from; stars, license and language come straight from the GitHub API. The model does not read the source code, and the analysis is refreshed when the project is re-analysed. Learn more on our About page.
