{"id":15590098,"url":"https://github.com/bkeepers/retext-words","last_synced_at":"2026-04-29T05:01:53.861Z","repository":{"id":66302944,"uuid":"66239172","full_name":"bkeepers/retext-words","owner":"bkeepers","description":null,"archived":false,"fork":false,"pushed_at":"2016-08-22T04:26:04.000Z","size":24,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-11T18:55:00.595Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/bkeepers.png","metadata":{"files":{"readme":"readme.md","changelog":"history.md","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":"2016-08-22T04:18:53.000Z","updated_at":"2023-02-02T14:03:46.000Z","dependencies_parsed_at":"2023-02-20T21:00:52.523Z","dependency_job_id":null,"html_url":"https://github.com/bkeepers/retext-words","commit_stats":{"total_commits":19,"total_committers":4,"mean_commits":4.75,"dds":0.3157894736842105,"last_synced_commit":"b1aa565b38d8c577b13fb4902cc695a4668e75af"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/bkeepers/retext-words","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bkeepers%2Fretext-words","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bkeepers%2Fretext-words/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bkeepers%2Fretext-words/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bkeepers%2Fretext-words/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bkeepers","download_url":"https://codeload.github.com/bkeepers/retext-words/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bkeepers%2Fretext-words/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28020094,"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","status":"online","status_checked_at":"2025-12-25T02:00:05.988Z","response_time":58,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2024-10-02T23:19:52.485Z","updated_at":"2025-12-25T05:11:40.650Z","avatar_url":"https://github.com/bkeepers.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# retext-words [![Build Status][travis-badge]][travis] [![Coverage Status][codecov-badge]][codecov]\n\nCheck phrases for alternatives with [**retext**][retext].\n\n## Installation\n\n[npm][]:\n\n```bash\nnpm install retext-words\n```\n\n## Usage\n\n```js\nvar retext = require('retext');\nvar words = require('retext-words');\nvar report = require('vfile-reporter');\n\nretext()\n    .use(words, {\n      patterns: {\n        \"utilize\": { replace: \"use\" },\n        \"be advised\": { omit: true },\n        \"appropriate\": { replace: [ \"proper\", \"right\" ], omit: true },\n        \"git\": { replace: \"Git\", caseSensitive: true }\n      }\n    })\n    .process([\n        'You can utilize a shorter word.',\n        'Be advised, don’t do this.',\n        'That’s the appropriate thing to do.'\n    ].join('\\n'), function (err, file) {\n        console.log(report(file));\n    });\n```\n\nYields:\n\n```txt\n   1:9-1:16  warning  Replace “utilize” with “use”                                utilize\n   2:1-2:11  warning  Remove “Be advised”                                         be-advised\n  3:12-3:23  warning  Replace “appropriate” with “proper”, “right”, or remove it  appropriate\n\n⚠ 3 warnings\n```\n\n## API\n\n### `retext().use(words[, options])`\n\nCheck phrases for simpler alternatives.\n\n###### `options`\n\n*   `ignore` (`Array.\u003cstring\u003e`) — phrases _not_ to warn about.\n\n## License\n\n[MIT][license] © [Titus Wormer][author]\n\n\u003c!-- Definitions --\u003e\n\n[travis-badge]: https://img.shields.io/travis/wooorm/retext-words.svg\n\n[travis]: https://travis-ci.org/wooorm/retext-words\n\n[codecov-badge]: https://img.shields.io/codecov/c/github/wooorm/retext-words.svg\n\n[codecov]: https://codecov.io/github/wooorm/retext-words\n\n[npm]: https://docs.npmjs.com/cli/install\n\n[license]: LICENSE\n\n[author]: http://wooorm.com\n\n[retext]: https://github.com/wooorm/retext\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbkeepers%2Fretext-words","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbkeepers%2Fretext-words","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbkeepers%2Fretext-words/lists"}