{"id":13784009,"url":"https://github.com/retextjs/retext-equality","last_synced_at":"2025-05-16T07:04:22.401Z","repository":{"id":36197579,"uuid":"40501802","full_name":"retextjs/retext-equality","owner":"retextjs","description":"plugin to check for possible insensitive, inconsiderate language","archived":false,"fork":false,"pushed_at":"2024-05-30T17:35:04.000Z","size":826,"stargazers_count":160,"open_issues_count":1,"forks_count":56,"subscribers_count":9,"default_branch":"main","last_synced_at":"2025-05-16T01:34:32.676Z","etag":null,"topics":["equality","inclusivity","inconsiderate","insensitive","natural-language","retext","retext-plugin"],"latest_commit_sha":null,"homepage":"https://unifiedjs.com","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/retextjs.png","metadata":{"funding":{"github":"unifiedjs","open_collective":"unified"},"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"license","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-08-10T19:31:37.000Z","updated_at":"2025-05-10T22:50:33.000Z","dependencies_parsed_at":"2022-06-26T07:32:34.007Z","dependency_job_id":"a2254993-05fa-41fb-a7b5-ef2c848b7e78","html_url":"https://github.com/retextjs/retext-equality","commit_stats":{"total_commits":319,"total_committers":42,"mean_commits":7.595238095238095,"dds":"0.19749216300940442","last_synced_commit":"6c71a880135aa254a9674e678c01ced89087a038"},"previous_names":["wooorm/retext-equality"],"tags_count":62,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/retextjs%2Fretext-equality","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/retextjs%2Fretext-equality/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/retextjs%2Fretext-equality/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/retextjs%2Fretext-equality/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/retextjs","download_url":"https://codeload.github.com/retextjs/retext-equality/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254485054,"owners_count":22078767,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["equality","inclusivity","inconsiderate","insensitive","natural-language","retext","retext-plugin"],"created_at":"2024-08-03T19:00:34.327Z","updated_at":"2025-05-16T07:04:22.365Z","avatar_url":"https://github.com/retextjs.png","language":"JavaScript","readme":"# retext-equality\n\n[![Build][build-badge]][build]\n[![Coverage][coverage-badge]][coverage]\n[![Downloads][downloads-badge]][downloads]\n[![Size][size-badge]][size]\n[![Sponsors][sponsors-badge]][collective]\n[![Backers][backers-badge]][collective]\n[![Chat][chat-badge]][chat]\n\n**[retext][]** plugin to check for possible insensitive, inconsiderate language.\n\n## Contents\n\n* [What is this?](#what-is-this)\n* [When should I use this?](#when-should-i-use-this)\n* [Install](#install)\n* [Use](#use)\n* [API](#api)\n  * [`unified().use(retextEquality[, options])`](#unifieduseretextequality-options)\n  * [`Options`](#options)\n* [Messages](#messages)\n* [Types](#types)\n* [Compatibility](#compatibility)\n* [Related](#related)\n* [Contributing](#contributing)\n* [License](#license)\n\n## What is this?\n\nThis package is a [unified][] ([retext][]) plugin to check for certain words\nthat could be considered insensitive, or otherwise inconsiderate, in certain\ncontexts.\n\n## When should I use this?\n\nYou can opt-into this plugin when you’re dealing with your own text and want to\ncheck for potential mistakes.\n\n## Install\n\nThis package is [ESM only][esm].\nIn Node.js (version 16+), install with [npm][]:\n\n```sh\nnpm install retext-equality\n```\n\nIn Deno with [`esm.sh`][esmsh]:\n\n```js\nimport retextEquality from 'https://esm.sh/retext-equality@7'\n```\n\nIn browsers with [`esm.sh`][esmsh]:\n\n```html\n\u003cscript type=\"module\"\u003e\n  import retextEquality from 'https://esm.sh/retext-equality@7?bundle'\n\u003c/script\u003e\n```\n\n## Use\n\nSay our document `example.txt` contains:\n\n```txt\nNow that the child elements are floated, obviously the parent element will collapse.\n```\n\n…and our module `example.js` contains:\n\n```js\nimport retextEnglish from 'retext-english'\nimport retextEquality from 'retext-equality'\nimport retextStringify from 'retext-stringify'\nimport {read} from 'to-vfile'\nimport {unified} from 'unified'\nimport {reporter} from 'vfile-reporter'\n\nconst file = await unified()\n  .use(retextEnglish)\n  .use(retextEquality)\n  .use(retextStringify)\n  .process(await read('example.txt'))\n\nconsole.error(reporter(file))\n```\n\n…then running `node example.js` yields:\n\n```txt\nexample.txt\n1:42-1:51 warning Unexpected potentially insensitive use of `obviously`, try not to use it obvious retext-equality\n\n⚠ 1 warning\n```\n\n## API\n\nThis package exports no identifiers.\nThe default export is [`retextEquality`][api-retext-equality].\n\n### `unified().use(retextEquality[, options])`\n\nCheck potentially insensitive language.\n\n###### Parameters\n\n* `options` ([`Options`][api-options], optional)\n  — configuration\n\n###### Returns\n\nTransform ([`Transformer`][unified-transformer]).\n\n### `Options`\n\nConfiguration (TypeScript type).\n\n###### Fields\n\n* `ignore` (`Array\u003cstring\u003e`, optional)\n  — phrases *not* to warn about\n* `binary` (`boolean`, default: `false`)\n  — whether to allow “he or she”, “garbagemen and garbagewomen”, and similar\n\n## Messages\n\nSee [`rules.md`][file-rules] for a list of rules and how rules work.\n\nEach message is emitted as a [`VFileMessage`][vfile-message] with `source` set\nto `'retext-equality'`, `ruleId` to an `id` from [`rules.md`][file-rules],\n`actual` to the not ok phrase, and `expected` to suggested phrases.\nSome messages also contain a `note` with extra info.\n\n## Types\n\nThis package is fully typed with [TypeScript][].\nIt exports the additional type [`Options`][api-options].\n\n## Compatibility\n\nProjects maintained by the unified collective are compatible with maintained\nversions of Node.js.\n\nWhen we cut a new major release, we drop support for unmaintained versions of\nNode.\nThis means we try to keep the current release line, `retext-equality@^7`,\ncompatible with Node.js 16.\n\n## Related\n\n* [`alex`](https://github.com/get-alex/alex)\n  — Catch insensitive, inconsiderate writing\n* [`retext-passive`](https://github.com/retextjs/retext-passive)\n  — Check passive voice\n* [`retext-profanities`](https://github.com/retextjs/retext-profanities)\n  — Check for profane and vulgar wording\n* [`retext-simplify`](https://github.com/retextjs/retext-simplify)\n  — Check phrases for simpler alternatives\n\n## Contributing\n\nSee [`contributing.md`][contributing] in [`retextjs/.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\nTo create new patterns, add them in the YAML files in the [`data/`][file-data]\ndirectory, and run `npm install` and then `npm test` to build everything.\nPlease see the current patterns for inspiration.\nNew English rules will automatically be added to `rules.md`.\n\nWhen you are happy with the new rule, add a test for it in\n[`test.js`][file-test], and open a pull request.\n\n## License\n\n[MIT][license] © [Titus Wormer][author]\n\n\u003c!-- Definitions --\u003e\n\n[build-badge]: https://github.com/retextjs/retext-equality/workflows/main/badge.svg\n\n[build]: https://github.com/retextjs/retext-equality/actions\n\n[coverage-badge]: https://img.shields.io/codecov/c/github/retextjs/retext-equality.svg\n\n[coverage]: https://codecov.io/github/retextjs/retext-equality\n\n[downloads-badge]: https://img.shields.io/npm/dm/retext-equality.svg\n\n[downloads]: https://www.npmjs.com/package/retext-equality\n\n[size-badge]: https://img.shields.io/bundlejs/size/retext-equality\n\n[size]: https://bundlejs.com/?q=retext-equality\n\n[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg\n\n[backers-badge]: https://opencollective.com/unified/backers/badge.svg\n\n[collective]: https://opencollective.com/unified\n\n[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg\n\n[chat]: https://github.com/retextjs/retext/discussions\n\n[npm]: https://docs.npmjs.com/cli/install\n\n[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c\n\n[esmsh]: https://esm.sh\n\n[typescript]: https://www.typescriptlang.org\n\n[health]: https://github.com/retextjs/.github\n\n[contributing]: https://github.com/retextjs/.github/blob/main/contributing.md\n\n[support]: https://github.com/retextjs/.github/blob/main/support.md\n\n[coc]: https://github.com/retextjs/.github/blob/main/code-of-conduct.md\n\n[license]: license\n\n[author]: https://wooorm.com\n\n[retext]: https://github.com/retextjs/retext\n\n[unified]: https://github.com/unifiedjs/unified\n\n[unified-transformer]: https://github.com/unifiedjs/unified#transformer\n\n[vfile-message]: https://github.com/vfile/vfile-message\n\n[file-rules]: rules.md\n\n[file-data]: data/\n\n[file-test]: test.js\n\n[api-options]: #options\n\n[api-retext-equality]: #unifieduseretextequality-options\n","funding_links":["https://github.com/sponsors/unifiedjs","https://opencollective.com/unified"],"categories":["JavaScript","Plugins"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fretextjs%2Fretext-equality","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fretextjs%2Fretext-equality","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fretextjs%2Fretext-equality/lists"}