README.md

textlint-rule-alex

textlint rule for 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

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request :D

License

MIT