{"_id":"are-docs-informative","_rev":"4249708","name":"are-docs-informative","description":"Checks whether a documentation description introduces any new information. ℹ️","dist-tags":{"latest":"0.1.1"},"maintainers":[{"name":"joshuakgoldberg","email":"joshuakgoldberg@outlook.com"}],"time":{"modified":"2026-03-29T21:54:13.000Z","created":"2023-04-11T15:28:35.478Z","0.1.1":"2025-06-12T12:00:48.684Z","0.1.0":"2025-04-18T14:58:04.647Z","0.0.2":"2023-04-11T18:41:29.586Z","0.0.1":"2023-04-11T15:46:16.629Z","0.0.0":"2023-04-11T15:28:35.478Z"},"users":{},"author":{"name":"JoshuaKGoldberg","email":"npm@joshuakgoldberg.com"},"repository":{"type":"git","url":"git+https://github.com/JoshuaKGoldberg/are-docs-informative.git"},"versions":{"0.1.1":{"name":"are-docs-informative","version":"0.1.1","description":"Checks whether a documentation description introduces any new information. ℹ️","repository":{"type":"git","url":"git+https://github.com/JoshuaKGoldberg/are-docs-informative.git"},"license":"MIT","author":{"name":"JoshuaKGoldberg","email":"npm@joshuakgoldberg.com"},"type":"module","main":"lib/index.js","scripts":{"build":"tsup","format":"prettier .","lint":"eslint . --max-warnings 0","lint:knip":"knip","lint:md":"markdownlint \"**/*.md\" \".github/**/*.md\" --rules sentences-per-line","lint:packages":"pnpm dedupe --check","lint:spelling":"cspell \"**\" \".github/**/*\"","prepare":"husky","test":"vitest","tsc":"tsc"},"lint-staged":{"*":"prettier --ignore-unknown --write"},"devDependencies":{"@eslint-community/eslint-plugin-eslint-comments":"4.5.0","@eslint/js":"9.28.0","@release-it/conventional-changelog":"10.0.0","@types/eslint-plugin-markdown":"2.0.2","@types/node":"22.15.0","@vitest/coverage-v8":"3.2.0","@vitest/eslint-plugin":"1.2.0","console-fail-test":"0.5.0","create-typescript-app":"2.34.0","cspell":"9.0.0","eslint":"9.28.0","eslint-plugin-jsdoc":"50.7.0","eslint-plugin-jsonc":"2.20.0","eslint-plugin-markdown":"5.1.0","eslint-plugin-n":"17.16.2","eslint-plugin-package-json":"0.33.0","eslint-plugin-perfectionist":"4.14.0","eslint-plugin-regexp":"2.8.0","eslint-plugin-yml":"1.18.0","husky":"9.1.7","knip":"5.60.0","lint-staged":"16.1.0","markdownlint":"0.38.0","markdownlint-cli":"0.45.0","prettier":"3.5.3","prettier-plugin-curly":"0.3.1","prettier-plugin-packagejson":"2.5.10","prettier-plugin-sh":"0.17.0","release-it":"19.0.1","sentences-per-line":"0.3.0","tsup":"8.5.0","typescript":"5.8.2","typescript-eslint":"8.33.0","vitest":"3.2.0"},"packageManager":"pnpm@10.11.0","engines":{"node":">=18"},"publishConfig":{"provenance":true},"_id":"are-docs-informative@0.1.1","gitHead":"59a5accb222659650158b067d74bbc809cefb8c3","types":"./lib/index.d.ts","bugs":{"url":"https://github.com/JoshuaKGoldberg/are-docs-informative/issues"},"homepage":"https://github.com/JoshuaKGoldberg/are-docs-informative#readme","_nodeVersion":"20.19.1","_npmVersion":"10.8.2","dist":{"shasum":"34fa1d621e6b8ab2bd33e219333c135b6655a2d0","size":4122,"noattachment":false,"key":"/are-docs-informative/-/are-docs-informative-0.1.1.tgz","tarball":"http://registry.cnpm.dingdandao.com/are-docs-informative/download/are-docs-informative-0.1.1.tgz"},"_npmUser":{"name":"joshuakgoldberg","email":"npm@joshuakgoldberg.com"},"directories":{},"maintainers":[{"name":"joshuakgoldberg","email":"joshuakgoldberg@outlook.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/are-docs-informative_0.1.1_1749729648526_0.10313508359626677"},"_hasShrinkwrap":false,"_cnpmcore_publish_time":"2025-06-12T12:00:48.684Z","publish_time":1749729648684,"_source_registry_name":"default","_cnpm_publish_time":1749729648684},"0.1.0":{"name":"are-docs-informative","version":"0.1.0","description":"Checks whether a documentation description introduces any new information. ℹ️","repository":{"type":"git","url":"git+https://github.com/JoshuaKGoldberg/are-docs-informative.git"},"license":"MIT","author":{"name":"JoshuaKGoldberg","email":"npm@joshuakgoldberg.com"},"type":"module","main":"lib/index.js","scripts":{"build":"tsup","format":"prettier .","lint":"eslint . --max-warnings 0","lint:knip":"knip","lint:md":"markdownlint \"**/*.md\" \".github/**/*.md\" --rules sentences-per-line","lint:packages":"pnpm dedupe --check","lint:spelling":"cspell \"**\" \".github/**/*\"","prepare":"husky","test":"vitest","tsc":"tsc"},"lint-staged":{"*":"prettier --ignore-unknown --write"},"devDependencies":{"@eslint-community/eslint-plugin-eslint-comments":"4.4.1","@eslint/js":"9.24.0","@release-it/conventional-changelog":"10.0.0","@types/eslint-plugin-markdown":"2.0.2","@types/node":"22.14.0","@vitest/coverage-v8":"3.1.1","@vitest/eslint-plugin":"1.1.38","console-fail-test":"0.5.0","create-typescript-app":"2.34.0","cspell":"8.18.0","eslint":"9.24.0","eslint-plugin-jsdoc":"50.6.8","eslint-plugin-jsonc":"2.20.0","eslint-plugin-markdown":"5.1.0","eslint-plugin-n":"17.16.2","eslint-plugin-package-json":"0.29.0","eslint-plugin-perfectionist":"4.11.0","eslint-plugin-regexp":"2.7.0","eslint-plugin-yml":"1.17.0","husky":"9.1.7","knip":"5.50.1","lint-staged":"15.5.0","markdownlint":"0.37.4","markdownlint-cli":"0.44.0","prettier":"3.5.3","prettier-plugin-curly":"0.3.1","prettier-plugin-packagejson":"2.5.10","prettier-plugin-sh":"0.17.0","release-it":"18.1.2","sentences-per-line":"0.3.0","tsup":"8.4.0","typescript":"5.8.2","typescript-eslint":"8.29.0","vitest":"3.1.1"},"packageManager":"pnpm@10.8.0","engines":{"node":">=18"},"publishConfig":{"provenance":true},"_id":"are-docs-informative@0.1.0","gitHead":"d6bd6fe131fa754f64a090c36191db97cc50fc57","types":"./lib/index.d.ts","bugs":{"url":"https://github.com/JoshuaKGoldberg/are-docs-informative/issues"},"homepage":"https://github.com/JoshuaKGoldberg/are-docs-informative#readme","_nodeVersion":"20.19.0","_npmVersion":"10.8.2","dist":{"shasum":"c1f0255229fb785e25c33cdcb098cebad50ad23e","size":4129,"noattachment":false,"key":"/are-docs-informative/-/are-docs-informative-0.1.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/are-docs-informative/download/are-docs-informative-0.1.0.tgz"},"_npmUser":{"name":"joshuakgoldberg","email":"npm@joshuakgoldberg.com"},"directories":{},"maintainers":[{"name":"joshuakgoldberg","email":"joshuakgoldberg@outlook.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/are-docs-informative_0.1.0_1744988284473_0.27653709200693966"},"_hasShrinkwrap":false,"_cnpmcore_publish_time":"2025-04-18T14:58:04.647Z","publish_time":1744988284647,"_source_registry_name":"default","_cnpm_publish_time":1744988284647},"0.0.2":{"name":"are-docs-informative","version":"0.0.2","description":"Checks whether a documentation description introduces any new information.","repository":{"type":"git","url":"git+https://github.com/JoshuaKGoldberg/are-docs-informative.git"},"license":"MIT","author":{"name":"Josh Goldberg","email":"npm@joshuakgoldberg.com"},"type":"module","exports":{".":{"types":{"import":"./lib/index.d.ts","require":"./lib/index.d.cts"},"import":"./lib/index.js","require":"./lib/index.cjs"}},"main":"./lib/index.js","scripts":{"build":"tsc","build:full":"tsup src/index.ts --clean --format cjs,esm --outDir lib --dts && cp lib/index.d.ts lib/index.d.cts","format":"prettier \"**/*\" --ignore-unknown","format:write":"pnpm format --write","lint":"eslint . --max-warnings 0 --report-unused-disable-directives","lint:knip":"knip","lint:md":"markdownlint \"**/*.md\" \".github/**/*.md\" --rules sentences-per-line","lint:package":"npmPkgJsonLint .","lint:packages":"pnpm-deduplicate --list","lint:spelling":"cspell \"**\" \".github/**/*\"","prepare":"husky install","should-semantic-release":"should-semantic-release --verbose","test":"vitest"},"lint-staged":{"*":"prettier --ignore-unknown --write"},"devDependencies":{"@types/eslint":"^8.21.1","@typescript-eslint/eslint-plugin":"^5.48.2","@typescript-eslint/parser":"^5.48.2","@vitest/coverage-istanbul":"^0.29.0","cspell":"^6.19.2","eslint":"^8.32.0","eslint-config-prettier":"^8.6.0","eslint-plugin-deprecation":"^1.3.3","eslint-plugin-eslint-comments":"^3.2.0","eslint-plugin-import":"^2.27.5","eslint-plugin-jsonc":"^2.6.0","eslint-plugin-markdown":"^3.0.0","eslint-plugin-no-only-tests":"^3.1.0","eslint-plugin-regexp":"^1.12.0","eslint-plugin-simple-import-sort":"^10.0.0","eslint-plugin-typescript-sort-keys":"^2.1.0","eslint-plugin-vitest":"^0.1.0","eslint-plugin-yml":"^1.5.0","husky":"^8.0.3","jsonc-eslint-parser":"^2.1.0","knip":"2.8.2","lint-staged":"^13.1.0","markdownlint":"^0.27.0","markdownlint-cli":"^0.33.0","npm-package-json-lint":"^6.4.0","npm-package-json-lint-config-default":"^5.0.0","pnpm-deduplicate":"^0.4.1","prettier":"^2.8.3","prettier-plugin-packagejson":"^2.4.2","release-it":"^15.6.0","sentences-per-line":"^0.2.1","should-semantic-release":"^0.1.0","tsup":"^6.7.0","typescript":"^5.0.0","vitest":"^0.29.0","yaml-eslint-parser":"^1.2.0"},"packageManager":"pnpm@7.31.0","engines":{"node":">=14"},"types":"./lib/index.d.ts","gitHead":"f56c13541ffe7e00373273d6189ee1d5e66d3c94","bugs":{"url":"https://github.com/JoshuaKGoldberg/are-docs-informative/issues"},"homepage":"https://github.com/JoshuaKGoldberg/are-docs-informative#readme","_id":"are-docs-informative@0.0.2","_nodeVersion":"18.7.0","_npmVersion":"8.15.0","dist":{"shasum":"387f0e93f5d45280373d387a59d34c96db321963","size":4408,"noattachment":false,"key":"/are-docs-informative/-/are-docs-informative-0.0.2.tgz","tarball":"http://registry.cnpm.dingdandao.com/are-docs-informative/download/are-docs-informative-0.0.2.tgz"},"_npmUser":{"name":"joshuakgoldberg","email":"npm@joshuakgoldberg.com"},"directories":{},"maintainers":[{"name":"joshuakgoldberg","email":"joshuakgoldberg@outlook.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/are-docs-informative_0.0.2_1681238489410_0.5106775961220542"},"_hasShrinkwrap":false,"_cnpmcore_publish_time":"2023-04-11T18:41:29.586Z","publish_time":1681238489586,"_cnpm_publish_time":1681238489586},"0.0.1":{"name":"are-docs-informative","version":"0.0.1","description":"Checks whether a documentation description introduces any new information.","repository":{"type":"git","url":"git+https://github.com/JoshuaKGoldberg/are-docs-informative.git"},"license":"MIT","author":{"name":"Josh Goldberg","email":"npm@joshuakgoldberg.com"},"type":"module","exports":{".":{"types":{"import":"./lib/index.d.ts","require":"./lib/index.d.cts"},"import":"./lib/index.js","require":"./lib/index.cjs"}},"main":"./lib/index.js","scripts":{"build":"tsc","build:full":"tsup src/index.ts --clean --format cjs,esm --outDir lib --dts && cp lib/index.d.ts lib/index.d.cts","format":"prettier \"**/*\" --ignore-unknown","format:write":"pnpm format --write","lint":"eslint . --max-warnings 0 --report-unused-disable-directives","lint:knip":"knip","lint:md":"markdownlint \"**/*.md\" \".github/**/*.md\" --rules sentences-per-line","lint:package":"npmPkgJsonLint .","lint:packages":"pnpm-deduplicate --list","lint:spelling":"cspell \"**\" \".github/**/*\"","prepare":"husky install","should-semantic-release":"should-semantic-release --verbose","test":"vitest"},"lint-staged":{"*":"prettier --ignore-unknown --write"},"devDependencies":{"@types/eslint":"^8.21.1","@typescript-eslint/eslint-plugin":"^5.48.2","@typescript-eslint/parser":"^5.48.2","@vitest/coverage-istanbul":"^0.29.0","cspell":"^6.19.2","eslint":"^8.32.0","eslint-config-prettier":"^8.6.0","eslint-plugin-deprecation":"^1.3.3","eslint-plugin-eslint-comments":"^3.2.0","eslint-plugin-import":"^2.27.5","eslint-plugin-jsonc":"^2.6.0","eslint-plugin-markdown":"^3.0.0","eslint-plugin-no-only-tests":"^3.1.0","eslint-plugin-regexp":"^1.12.0","eslint-plugin-simple-import-sort":"^10.0.0","eslint-plugin-typescript-sort-keys":"^2.1.0","eslint-plugin-vitest":"^0.1.0","eslint-plugin-yml":"^1.5.0","husky":"^8.0.3","jsonc-eslint-parser":"^2.1.0","knip":"2.8.2","lint-staged":"^13.1.0","markdownlint":"^0.27.0","markdownlint-cli":"^0.33.0","npm-package-json-lint":"^6.4.0","npm-package-json-lint-config-default":"^5.0.0","pnpm-deduplicate":"^0.4.1","prettier":"^2.8.3","prettier-plugin-packagejson":"^2.4.2","release-it":"^15.6.0","sentences-per-line":"^0.2.1","should-semantic-release":"^0.1.0","tsup":"^6.7.0","typescript":"^5.0.0","vitest":"^0.29.0","yaml-eslint-parser":"^1.2.0"},"packageManager":"pnpm@7.31.0","engines":{"node":">=18"},"types":"./lib/index.d.ts","gitHead":"9c1fd52a302a5ad10962727fcbb27e1540c581f6","bugs":{"url":"https://github.com/JoshuaKGoldberg/are-docs-informative/issues"},"homepage":"https://github.com/JoshuaKGoldberg/are-docs-informative#readme","_id":"are-docs-informative@0.0.1","_nodeVersion":"18.7.0","_npmVersion":"8.15.0","dist":{"shasum":"1102b35026f73e0564b4e291bfeaa8b7a304cefe","size":4134,"noattachment":false,"key":"/are-docs-informative/-/are-docs-informative-0.0.1.tgz","tarball":"http://registry.cnpm.dingdandao.com/are-docs-informative/download/are-docs-informative-0.0.1.tgz"},"_npmUser":{"name":"joshuakgoldberg","email":"npm@joshuakgoldberg.com"},"directories":{},"maintainers":[{"name":"joshuakgoldberg","email":"joshuakgoldberg@outlook.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/are-docs-informative_0.0.1_1681227976502_0.8799494809572856"},"_hasShrinkwrap":false,"_cnpmcore_publish_time":"2023-04-11T15:46:16.629Z","publish_time":1681227976629,"_cnpm_publish_time":1681227976629},"0.0.0":{"name":"are-docs-informative","version":"0.0.0","description":"Checks whether a documentation description introduces any new information.","repository":{"type":"git","url":"git+https://github.com/JoshuaKGoldberg/are-docs-informative.git"},"license":"MIT","author":{"name":"Josh Goldberg","email":"npm@joshuakgoldberg.com"},"type":"module","main":"./lib/index.js","scripts":{"build":"tsc","format":"prettier \"**/*\" --ignore-unknown","format:write":"pnpm format --write","lint":"eslint . --max-warnings 0 --report-unused-disable-directives","lint:knip":"knip","lint:md":"markdownlint \"**/*.md\" \".github/**/*.md\" --rules sentences-per-line","lint:package":"npmPkgJsonLint .","lint:packages":"pnpm-deduplicate --list","lint:spelling":"cspell \"**\" \".github/**/*\"","prepare":"husky install","should-semantic-release":"should-semantic-release --verbose","test":"vitest"},"lint-staged":{"*":"prettier --ignore-unknown --write"},"devDependencies":{"@types/eslint":"^8.21.1","@typescript-eslint/eslint-plugin":"^5.48.2","@typescript-eslint/parser":"^5.48.2","@vitest/coverage-istanbul":"^0.29.0","cspell":"^6.19.2","eslint":"^8.32.0","eslint-config-prettier":"^8.6.0","eslint-plugin-deprecation":"^1.3.3","eslint-plugin-eslint-comments":"^3.2.0","eslint-plugin-import":"^2.27.5","eslint-plugin-jsonc":"^2.6.0","eslint-plugin-markdown":"^3.0.0","eslint-plugin-no-only-tests":"^3.1.0","eslint-plugin-regexp":"^1.12.0","eslint-plugin-simple-import-sort":"^10.0.0","eslint-plugin-typescript-sort-keys":"^2.1.0","eslint-plugin-vitest":"^0.1.0","eslint-plugin-yml":"^1.5.0","husky":"^8.0.3","jsonc-eslint-parser":"^2.1.0","knip":"2.8.2","lint-staged":"^13.1.0","markdownlint":"^0.27.0","markdownlint-cli":"^0.33.0","npm-package-json-lint":"^6.4.0","npm-package-json-lint-config-default":"^5.0.0","pnpm-deduplicate":"^0.4.1","prettier":"^2.8.3","prettier-plugin-packagejson":"^2.4.2","release-it":"^15.6.0","sentences-per-line":"^0.2.1","should-semantic-release":"^0.1.0","typescript":"^5.0.0","vitest":"^0.29.0","yaml-eslint-parser":"^1.2.0"},"packageManager":"pnpm@7.31.0","engines":{"node":">=18"},"types":"./lib/index.d.ts","gitHead":"f8301c23a073ffe6097d27255cf5376e454890a6","bugs":{"url":"https://github.com/JoshuaKGoldberg/are-docs-informative/issues"},"homepage":"https://github.com/JoshuaKGoldberg/are-docs-informative#readme","_id":"are-docs-informative@0.0.0","_nodeVersion":"18.7.0","_npmVersion":"8.15.0","dist":{"shasum":"1bbb079c4896f0114b98e1196bcb656aafba94c2","size":5121,"noattachment":false,"key":"/are-docs-informative/-/are-docs-informative-0.0.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/are-docs-informative/download/are-docs-informative-0.0.0.tgz"},"_npmUser":{"name":"joshuakgoldberg","email":"npm@joshuakgoldberg.com"},"directories":{},"maintainers":[{"name":"joshuakgoldberg","email":"joshuakgoldberg@outlook.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/are-docs-informative_0.0.0_1681226915287_0.7737075167595451"},"_hasShrinkwrap":false,"_cnpmcore_publish_time":"2023-04-11T15:28:35.478Z","publish_time":1681226915478,"_cnpm_publish_time":1681226915478}},"readme":"

Are Docs Informative

\n\n

\n\tChecks whether a documentation description introduces any new information.\n\tℹ️\n

\n\n

\n\t\n\t\n\t\"????\n\n\t\n\t\"????\n\t\"????\n\t\"????\n\t\"????\n\t\"????\n

\n\n## Usage\n\n> See this in action in [`jsdoc/informative-docs`](https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/informative-docs.md)!\n\n```shell\nnpm i are-docs-informative\n```\n\n```ts\nimport { areDocsInformative } from \"are-docs-informative\";\n\nareDocsInformative(\"The user id.\", \"userId\"); // false\nareDocsInformative(\"Retrieved user id.\", \"userId\"); // true\n```\n\n### Options\n\nThe `areDocsInformative` function can receive a third, optional object parameter.\nIt can contain any of the following properties.\n\n#### `aliases`\n\nThe `aliases` option allows indicating words as synonyms (aliases) of each other.\n\nFor example, with `{ aliases: { emoji: [\"smiley\", \"winkey\"] } }`, the following comment would be considered uninformative:\n\n```ts\n/** Default smiley/winkey. */\nexport const defaultSmiley = \"????\";\n```\n\nThe default `aliases` option is:\n\n```json\n{\n\t\"a\": [\"an\", \"our\"]\n}\n```\n\n#### `uselessWords`\n\nWords that are ignored when searching for one that adds meaning.\n\nFor example, with `{ uselessWords: [\"our\"] }`, the following comment would be considered uninformative:\n\n```ts\n/** Our text. */\nexport const text = \":)\";\n```\n\nThe default `uselessWords` option is:\n\n```json\n[\"a\", \"an\", \"i\", \"in\", \"of\", \"s\", \"the\"]\n```\n\n## Development\n\nSee [`.github/CONTRIBUTING.md`](./.github/CONTRIBUTING.md), then [`.github/DEVELOPMENT.md`](./.github/DEVELOPMENT.md).\nThanks! ℹ\n\n## Contributors\n\n\n\n\n\n\n \n \n \n \n \n
\"Josh
Josh Goldberg
???? ???? ???? ???? ???? ???? ???? ????
\n\n\n\n\n\n\n\n> ???? This package was templated with [`create-typescript-app`](https://github.com/JoshuaKGoldberg/create-typescript-app) using the [Bingo engine](https://create.bingo).\n","_attachments":{},"homepage":"https://github.com/JoshuaKGoldberg/are-docs-informative#readme","bugs":{"url":"https://github.com/JoshuaKGoldberg/are-docs-informative/issues"},"license":"MIT"}