textlint-rule-alex ![Actions Status: test](https://github.com/textlint-rule/textlint-rule-alex/actions?query=workflow%3A"test")

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)

``json
{
"rules": {
"alex": {
"allow": []
}
}
}
`

Via CLI

`sh
$ textlint --rule alex README.md
`

Options

See Alex's configuration documentation.

$3

`json
{
"rules": {
"alex": {
"allow": ["boogeyman-boogeywoman"]
}
}
}
`

$3

`json
{
"rules": {
"alex": {
"deny": ["boogeyman-boogeywoman"]
}
}
}
`

$3

`json
{
"rules": {
"alex": {
"noBinary": true
}
}
}
`

$3

`json
{
"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