Shell
122 stars
In today's rapidly evolving landscape, vale-ai-tells is a comprehensive, cutting-edge Vale style package that empowers writers to seamlessly delve into the rich tapestry of AI tells. It's not just a rule set; it's a game-changer that supercharges your prose, unlocks new possibilities, and really lands. Ship cleaner prose. Full stop. 🚀
### Overview:
vale-ai-tells is a comprehensive, cutting-edge package designed to enhance technical documentation by detecting and correcting linguistic patterns commonly associated with AI-generated prose. This package is particularly useful for writers aiming to improve the clarity and directness of their technical content, making it an invaluable tool for ensuring clean, professional writing.
### Key Features:
- **AI-generated commit messages detection**: Identifies and corrects patterns in AI-generated commit messages, including self-referential preambles, trailing justification clauses, buzzword adjective-noun pairs, and gitmoji patterns.
- **Opt-in structural rules**: Provides 15 rules specifically designed for commit messages, separate from the prose rules, allowing for a more focused approach to improving commit message quality.
### Tech Stack:
The package is built using Shell scripting, leveraging Vale's powerful linting capabilities to enforce stylistic and structural rules.
### Why It Matters:
For technical documentation, where precision and clarity are paramount, vale-ai-tells offers a significant enhancement. It helps writers maintain a consistent and professional tone, ensuring that AI-generated content is not disguised as human-written. This tool is particularly useful in environments where AI-generated content is expected to be treated as genuine technical documentation.
### GitHub Stars:
The repository has been starred by 122 developers, indicating its growing popularity and utility in the technical documentation community.
### Installation:
To use vale-ai-tells, add the package to your `.vale.ini` configuration file, specifying the `ai-tells` style and optionally the `ai-tells-commits` style for commit