{"id":33166890,"url":"https://github.com/davidhund/retext-assuming","last_synced_at":"2026-01-30T21:11:00.033Z","repository":{"id":44729570,"uuid":"108915613","full_name":"davidhund/retext-assuming","owner":"davidhund","description":"Check for unhelpful ‘assuming’ phrases such as ‘just’, ‘simply’ or ‘obviously’ with retext","archived":false,"fork":false,"pushed_at":"2025-08-21T15:52:38.000Z","size":733,"stargazers_count":18,"open_issues_count":5,"forks_count":7,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-04T22:29:21.485Z","etag":null,"topics":["assumptions","documentation","linter","retext","retext-plugin"],"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/davidhund.png","metadata":{"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}},"created_at":"2017-10-30T22:31:21.000Z","updated_at":"2025-06-24T06:58:20.000Z","dependencies_parsed_at":"2024-04-18T16:05:19.037Z","dependency_job_id":null,"html_url":"https://github.com/davidhund/retext-assuming","commit_stats":{"total_commits":16,"total_committers":5,"mean_commits":3.2,"dds":0.625,"last_synced_commit":"10a899a436694e0d60d67714ef49379d6ed08a43"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/davidhund/retext-assuming","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/davidhund%2Fretext-assuming","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/davidhund%2Fretext-assuming/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/davidhund%2Fretext-assuming/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/davidhund%2Fretext-assuming/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/davidhund","download_url":"https://codeload.github.com/davidhund/retext-assuming/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/davidhund%2Fretext-assuming/sbom","scorecard":{"id":326834,"data":{"date":"2025-08-11","repo":{"name":"github.com/davidhund/retext-assuming","commit":"67327845d45723c1110ea5ca6880eb633d207c43"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.2,"checks":[{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Code-Review","score":10,"reason":"all changesets reviewed","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Maintained","score":1,"reason":"2 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 1","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 30 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"13 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw","Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-4gmj-3p3h-gm8h","Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97","Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw","Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9","Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6","Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj","Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-18T02:39:52.977Z","repository_id":44729570,"created_at":"2025-08-18T02:39:52.977Z","updated_at":"2025-08-18T02:39:52.977Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28919470,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-30T20:25:28.696Z","status":"ssl_error","status_checked_at":"2026-01-30T20:25:13.426Z","response_time":66,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["assumptions","documentation","linter","retext","retext-plugin"],"created_at":"2025-11-16T00:00:42.657Z","updated_at":"2026-01-30T21:11:00.027Z","avatar_url":"https://github.com/davidhund.png","language":"JavaScript","funding_links":[],"categories":["Documentation Tools"],"sub_categories":[],"readme":"# retext-assuming\n\n[![npm version](https://img.shields.io/npm/v/retext-assuming.svg)](https://npmjs.com/package/retext-assuming)\n[![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo)\n[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/davidhund/retext-assuming/master/LICENSE)\n\nCheck for unhelpful ‘assuming’ phrases such as 'just', 'simply' or 'obviously' with [**retext**][retext].\n\nUsing these phrases in documentation is unhelpful: “simple” is relative to a users’ knowledge and experience. Often it is fine to leave the phrase out completely:\n\nAvoid:\n\u003e “Simply run the tests. Just type `npm test`…”\n\nBut use:\n\n\u003e “To run the tests type `npm test`…”\n\n\n## Credits\n\nThis plugin is based on the excellent [**retext**][retext] (plugins) by [Wooorm](https://twitter.com/wooorm/).\nNot much of this code is original and it probably could be much improved. PR's welcome 🚀\n\n\n## Installation\n\nInstall through [npm][]:\n\n```bash\nnpm install retext-assuming\n```\n\n## Usage\n\nSay we have the following file, `example.txt`:\n\n```text\nYou can just import an ES6 module.\nEverything is simply Javascript.\nObviously you would need NodeJS \u003e 8.\nActually, it's quite easy to use.\n```\n\nAnd our script, `example.js`, looks as follows:\n\n```javascript\nvar vfile = require('to-vfile');\nvar report = require('vfile-reporter');\nvar retext = require('retext');\nvar dontAssume = require('retext-assuming');\n\nretext()\n  .use(dontAssume)\n  .process(vfile.readSync('example.txt'), function (err, file) {\n    console.error(report(err || file));\n  });\n```\n\nShould result in:\n\n```text\nexample.txt\n   1:9-1:13  warning  Avoid “just”, it's not helpful       no-just       retext-assuming\n  2:15-2:21  warning  Avoid “simply”, it's not helpful     no-simply     retext-assuming\n   3:1-3:10  warning  Avoid “Obviously”, it's not helpful  no-obviously  retext-assuming\n    4:1-4:9  warning  Avoid “Actually”, it's not helpful   no-actually   retext-assuming\n  4:22-4:26  warning  Avoid “easy”, it's not helpful       no-easy       retext-assuming\n\n⚠ 3 warnings\n```\n\n## API\n\n### `retext().use(dontAssume[, options])`\n\nChecks for unhelpful phrases such as “just”, “simply” or “obviously” in processed text.\n\n**NOTE** `dontAssume` is the assigned name of our `require`d module. You can name it however you like.\n\n###### `options.phrases`\n\n`Array.\u003cstring\u003e` — list of phrases to warn about (defaults to `phrases.json`)\n\n###### `options.ignore`\n\n`Array.\u003cstring\u003e` — phrases _not_ to warn about.\n\n###### `options.verbose`\n\n`Boolean` — If `true` includes matches that are _probably fine_ (“You should **not** *simply* assume”)\n\n## Related\n\n*   [`retext-equality`](https://github.com/wooorm/retext-equality)\n    — Check possible insensitive, inconsiderate language\n*   [`retext-intensify`](https://github.com/wooorm/retext-intensify)\n    — Check for weak and mitigating wording\n*   [`retext-passive`](https://github.com/wooorm/retext-passive)\n    — Check passive voice\n*   [`retext-profanities`](https://github.com/wooorm/retext-profanities)\n    — Check profane and vulgar wording\n\n## License\n\n[MIT][license] © [David Hund][author]\n\n\u003c!-- Definitions --\u003e\n\n[npm]: https://docs.npmjs.com/cli/install\n\n[license]: LICENSE\n\n[author]: https://valuedstandards.com\n\n[retext]: https://github.com/wooorm/retext\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdavidhund%2Fretext-assuming","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdavidhund%2Fretext-assuming","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdavidhund%2Fretext-assuming/lists"}