textlint-rule-alex
v5.0.0
Published
textlint rule for alex
Downloads
3,245
Readme
textlint-rule-alex
Whether your own or someone else’s writing, alex helps you find gender favouring, polarising, race related, religion inconsiderate, or other unequal phrasing. -- wooorm/alex: Catch insensitive, inconsiderate writing
Installation
npm install textlint-rule-alex
Usage
Via .textlintrc
(Recommended)
{
"rules": {
"alex": {
"allow": []
}
}
}
Via CLI
$ textlint --rule alex README.md
Options
See Alex's configuration documentation.
allow
{
"rules": {
"alex": {
"allow": ["boogeyman-boogeywoman"]
}
}
}
deny
{
"rules": {
"alex": {
"deny": ["boogeyman-boogeywoman"]
}
}
}
noBinary
{
"rules": {
"alex": {
"noBinary": true
}
}
}
profanitySureness
{
"rules": {
"alex": {
"profanitySureness": 2
}
}
}
Tests
corepack enable npm
npm test
Contributing
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature
- Commit your changes:
git commit -am 'Add some feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull request :D
License
MIT