Miss any of our Open RFC calls?Watch the recordings here! »

textlint-rule-alex

3.0.0 • Public • Published

textlint-rule-alex Build Status

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

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

Keywords

Install

npm i textlint-rule-alex

DownloadsWeekly Downloads

167

Version

3.0.0

License

MIT

Unpacked Size

11.4 kB

Total Files

6

Last publish

Collaborators

  • avatar