![\"alex\"](\"https://raw.githubusercontent.com/get-alex/alex/a192b46/media/logo-alex-purple.svg?sanitize=true\"){kind=logo}
\n \n
\n
\n He walked to class.
').messages\n```\n\nYields:\n\n```js\n[\n [1:18-1:20: `He` may be insensitive, use `They`, `It` instead] {\n message: '`He` may be insensitive, use `They`, `It` instead',\n name: '1:18-1:20',\n reason: '`He` may be insensitive, use `They`, `It` instead',\n line: 1,\n column: 18,\n location: { start: [Object], end: [Object] },\n source: 'retext-equality',\n ruleId: 'he-she',\n fatal: false,\n actual: 'He',\n expected: [ 'They', 'It' ]\n }\n]\n```\n\n### `text(value, config)`\n\nCheck plain text (as in, syntax is checked).\n\n###### Parameters\n\n* `value` ([`VFile`][vfile] or `string`) — Text document\n* `config` (`Object`, optional) — See the [Configuration][] section\n\n###### Returns\n\n[`VFile`][vfile].\n\n###### Example\n\n```js\nimport {markdown, text} from 'alex'\n\nmarkdown('The `boogeyman`.').messages // => []\n\ntext('The `boogeyman`.').messages\n```\n\nYields:\n\n```js\n[\n [1:6-1:15: `boogeyman` may be insensitive, use `boogeymonster` instead] {\n message: '`boogeyman` may be insensitive, use `boogeymonster` instead',\n name: '1:6-1:15',\n reason: '`boogeyman` may be insensitive, use `boogeymonster` instead',\n line: 1,\n column: 6,\n location: Position { start: [Object], end: [Object] },\n source: 'retext-equality',\n ruleId: 'boogeyman-boogeywoman',\n fatal: false,\n actual: 'boogeyman',\n expected: [ 'boogeymonster' ]\n }\n]\n```\n\n## Workflow\n\nThe recommended workflow is to add **alex** to `package.json` and to run it with\nyour tests in Travis.\n\nYou can opt to ignore warnings through [alexrc][configuration] files and\n[control comments][control].\n\nA `package.json` file with [npm scripts][npm-scripts], and additionally using\n[AVA][] for unit tests, could look like so:\n\n```json\n{\n \"scripts\": {\n \"test-api\": \"ava\",\n \"test-doc\": \"alex\",\n \"test\": \"npm run test-api && npm run test-doc\"\n },\n \"devDependencies\": {\n \"alex\": \"^1.0.0\",\n \"ava\": \"^0.1.0\"\n }\n}\n```\n\nIf you’re using Travis for continuous integration, set up something like the\nfollowing in your `.travis.yml`:\n\n```diff\n script:\n - npm test\n+- alex --diff\n```\n\nMake sure to still install alex though!\n\nIf the `--diff` flag is used, and Travis is detected, lines that are not changes\nin this push are ignored.\nUsing this workflow, you can merge PRs if it has warnings, and then if someone\nedits an entirely different file, they won’t be bothered about existing\nwarnings, only about the things they added!\n\n## FAQ\n\n\n\n\n\n### This is stupid!\n\nNot a question.\nAnd yeah, alex isn’t very smart.\nPeople are much better at this.\nBut people make mistakes, and alex is there to help.\n\n### alex didn’t check “X”!\n\nSee [`contributing.md`][contributing] on how to get “X” checked by alex.\n\n### Why is this named alex?\n\nIt’s a nice unisex name, it was free on npm, I like it! :smile:\n\n\n\n## Further reading\n\nNo automated tool can replace studying inclusive communication and listening to\nthe lived experiences of others.\nAn error from `alex` can be an invitation to learn more.\nThese resources are a launch point for deepening your own understanding and\neditorial skills beyond what `alex` can offer:\n\n* The [18F Content Guide](https://content-guide.18f.gov/our-style/inclusive-language/)\n has a helpful list of links to other inclusive language guides used in\n journalism and academic writing.\n* The [Conscious Style Guide](https://consciousstyleguide.com/articles/) has\n articles on many nuanced topics of language. For example, the terms race\n and ethnicity mean different things, and choosing the right word is up to\n you.\n Likewise, a sentence that overgeneralizes about a group of people\n (e.g. “Developers love to code all day”) may not be noticed by `alex`, but\n it is not inclusive. A good human editor can step up to the challenge and\n find a better way to phrase things.\n* Sometimes, the only way to know what is inclusive is to ask.\n In [Disability is a nuanced thing](https://incl.ca/disability-language-is-a-nuanced-thing/),\n Nicolas Steenhout writes about how person-first language, such as\n “a person with a disability,” is not always the right choice.\n* Language is always evolving. A term that is neutral one year ago can be\n problematic today. Projects like the\n [Self-Defined Dictionary](https://github.com/selfdefined/web-app) aim to\n collect the words that we use to define ourselves and others, and connect\n them with the history and some helpful advice.\n* Unconsious bias is present in daily decisions and conversations and can show\n up in writing.\n [Textio](https://textio.com/blog/4-overlooked-types-of-bias-in-business-writing/27521593662)\n\n offers some examples of how descriptive adjective choice and tone can push\n some people away, and how regional language differences can cause confusion.\n* Using complex sentences and uncommon vocabulary can lead to less inclusive\n content. This is described as literacy exclusion in\n [this article by Harver](https://harver.com/blog/inclusive-job-descriptions/).\n This is critical to be aware of if your content has a global audience,\n where a reader’s strongest language may not be the language you are writing\n in.\n\n## Contribute\n\nSee [`contributing.md`][contributing] in [`get-alex/.github`][health] for ways\nto get started.\nSee [`support.md`][support] for ways to get help.\n\nThis project has a [Code of conduct][coc].\nBy interacting with this repository, organization, or community you agree to\nabide by its terms.\n\n## Origin story\n\nThanks to [**@iheanyi**][iheany] for [raising the problem][tweet] and\n[**@sindresorhus**][sindre] for inspiring me ([**@wooorm**][wooorm]) to do\nsomething about it.\n\nWhen alex launched, it got some traction on [twitter][] and [producthunt][].\nThen there was a [lot][tnw] [of][dailydot] [press][vice] [coverage][bustle].\n\n## Acknowledgments\n\nPreliminary work for alex was done [in 2015][preliminary].\nThe project was authored by [**@wooorm**][wooorm].\n\nLots of [people helped since][contributors]!\n\n## License\n\n[MIT][license] © [Titus Wormer][author]\n\n\n\n[build]: https://github.com/get-alex/alex/actions\n\n[build-badge]: https://github.com/get-alex/alex/workflows/main/badge.svg\n\n[coverage]: https://codecov.io/github/get-alex/alex\n\n[coverage-badge]: https://img.shields.io/codecov/c/github/get-alex/alex.svg\n\n[first-timers]: https://www.firsttimersonly.com/\n\n[first-timers-badge]: https://img.shields.io/badge/first--timers--only-friendly-blue.svg\n\n[node]: https://nodejs.org/en/download/\n\n[npm]: https://docs.npmjs.com/cli/install\n\n[yarn]: https://yarnpkg.com/\n\n[setup-tutorial]: https://dev.to/meeshkan/setting-up-the-alex-js-language-linter-in-your-project-3bpl\n\n[demo]: http://alexjs.com/#demo\n\n[screenshot]: screenshot.png\n\n[vfile]: https://github.com/vfile/vfile\n\n[profanities]: https://github.com/retextjs/retext-profanities/blob/main/rules.md\n\n[equality]: https://github.com/retextjs/retext-equality/blob/main/rules.md\n\n[vfile-message]: https://github.com/vfile/vfile#vfilemessages\n\n[literals]: https://github.com/syntax-tree/nlcst-is-literal#isliteralparent-index\n\n[eslintignore]: http://eslint.org/docs/user-guide/configuring.html#ignoring-files-and-directories\n\n[cuss]: https://github.com/words/cuss\n\n[npm-scripts]: https://docs.npmjs.com/misc/scripts\n\n[ava]: http://ava.li\n\n[author]: http://wooorm.com\n\n[health]: https://github.com/get-alex/.github\n\n[contributing]: https://github.com/get-alex/.github/blob/main/contributing.md\n\n[support]: https://github.com/get-alex/.github/blob/main/support.md\n\n[coc]: https://github.com/get-alex/.github/blob/main/code-of-conduct.md\n\n[tweet]: https://twitter.com/kwuchu/status/618799087006130176\n\n[twitter]: https://twitter.com/wooorm/status/639123753490907136\n\n[producthunt]: https://www.producthunt.com/posts/alex\n\n[tnw]: http://thenextweb.com/apps/2015/09/11/alex-stops-you-from-publishing-inconsiderate-content/\n\n[vice]: https://www.vice.com/en_us/article/nzeawx/meet-alex-the-javascript-tool-to-make-your-code-less-offensive\n\n[bustle]: https://www.bustle.com/articles/108684-alex-javascript-tool-corrects-harmful-language-in-your-writing-because-there-are-some-mistakes-spell-check\n\n[dailydot]: https://www.dailydot.com/debug/alex-coding-tool-offensive/\n\n[iheany]: https://github.com/iheanyi\n\n[sindre]: https://github.com/sindresorhus\n\n[wooorm]: https://github.com/wooorm\n\n[preliminary]: https://github.com/get-alex/alex/commit/3621b0a\n\n[contributors]: https://github.com/get-alex/alex/graphs/contributors\n\n[.alexignore]: .alexignore\n\n[license]: license\n\n[control]: #control\n\n[configuration]: #configuration\n\n[ignoring-files]: #ignoring-files\n\n[alexignore]: #alexignore\n\n[mdx]: https://mdxjs.com\n\n[mdx-next]: https://github.com/mdx-js/mdx/issues/1041\n","_attachments":{},"homepage":"https://alexjs.com","bugs":{"url":"https://github.com/get-alex/alex/issues"},"license":"MIT"}