https://github.com/textlint-rule/textlint-rule-alex
textlint rule for alex
https://github.com/textlint-rule/textlint-rule-alex
alex textlint
Last synced: 3 months ago
JSON representation
textlint rule for alex
- Host: GitHub
- URL: https://github.com/textlint-rule/textlint-rule-alex
- Owner: textlint-rule
- License: mit
- Created: 2016-02-14T15:46:35.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2025-03-19T06:38:23.000Z (3 months ago)
- Last Synced: 2025-04-02T21:57:47.722Z (3 months ago)
- Topics: alex, textlint
- Language: JavaScript
- Size: 592 KB
- Stars: 11
- Watchers: 2
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# textlint-rule-alex [](https://github.com/textlint-rule/textlint-rule-alex/actions?query=workflow%3A"test")
[textlint](https://github.com/textlint/textlint "textlint") rule for [ALEX](http://alexjs.com/ "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](https://github.com/wooorm/alex#alexvalue-allow "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](https://github.com/get-alex/alex#configuration).
### `allow`
```json
{
"rules": {
"alex": {
"allow": ["boogeyman-boogeywoman"]
}
}
}
```
### `deny`
```json
{
"rules": {
"alex": {
"deny": ["boogeyman-boogeywoman"]
}
}
}
```
### `noBinary`
```json
{
"rules": {
"alex": {
"noBinary": true
}
}
}
```
### `profanitySureness`
```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