get-alex/alex
Alex
Alex एक समावेशी भाषा लिंटर और कंटेंट ऑडिटर है जिसे असंवेदनशील, विचारहीन या लिंग-आधारित वाक्यांशों का पता लगाने और उन्हें फ़्लैग करने के लिए डिज़ाइन किया गया है। यह एक प्रोफैनिटी डिटेक्शन टूल के रूप में कार्य करता है जो पेशेवर और तटस्थ सामग्री सुनिश्चित करने के लिए कॉन्फ़िगर करने योग्य निश्चितता रेटिंग के आधार पर आपत्तिजनक शब्दों की पहचान करता है।
यह टूल डिफ-अवेयर एनालिसिस के माध्यम से खुद को अलग बनाता है, जिससे यह एक निरंतर एकीकरण (CI) वैलिडेटर के रूप में कार्य कर सकता है। पुल रिक्वेस्ट डेल्टास का विश्लेषण करके, यह पुराने चेतावनियों को नए मर्ज को ब्लॉक करने से रोकने के लिए मौजूदा लेगेसी मुद्दों को अनदेखा करते हुए नए असंवेदनशील वाक्यांशों को फ़्लैग कर सकता है।
यह प्रोजेक्ट Markdown, MDX और HTML फ़ाइलों के लिए मल्टी-फ़ॉर्मेट टेक्स्ट पार्सिंग को सपोर्ट करता है। इसमें JSON, YAML या JavaScript फ़ाइलों के माध्यम से नियम कॉन्फ़िगरेशन, टर्म सप्रेशन और फ़ाइल बहिष्करण (exclusion) की क्षमताएं शामिल हैं, साथ ही इनलाइन कमेंट्स का उपयोग करके विशिष्ट टेक्स्ट ब्लॉक्स को दबाने की क्षमता भी है।
यह टूल डायरेक्टरीज़ और फ़ाइलों को स्कैन करने के लिए कमांड लाइन इंटरफ़ेस के रूप में उपलब्ध है।
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.
