Simon Zünd
aebbf4f106
This silences a warning because our Node engine is newer then the package expects. There are newer versions of the plugin by now, but the transitive dependencies are younger than 1 week so the audit mirror blocks them. 46.10.1 seems like it was stable for a couple months so we use that. R=alexrudenko@chromium.org Bug: None Change-Id: Icf1c1276852e55dcad97d2ea2eeb6a8d7a9d82ae Reviewed-on: https://chromium-review.googlesource.com/c/devtools/devtools-frontend/+/5660063 Commit-Queue: Simon Zünd <szuend@chromium.org> Auto-Submit: Simon Zünd <szuend@chromium.org> Commit-Queue: Alex Rudenko <alexrudenko@chromium.org> Reviewed-by: Alex Rudenko <alexrudenko@chromium.org>
3.6 KiB
Are Docs Informative
Checks whether a documentation description introduces any new information.
Usage
npm i are-docs-informative
import { areDocsInformative } from "are-docs-informative";
areDocsInformative("The user id.", "userId"); // false
areDocsInformative("Retrieved user id.", "userId"); // true
Options
The areDocsInformative function can receive a third, optional parameter
aliases
The aliases option allows indicating words as synonyms (aliases) of each other.
For example, with { aliases: { emoji: ["smiley", "winkey"] } }, the following comment would be considered uninformative:
/** Default smiley/winkey. */
export const defaultSmiley = "🙂";
The default aliases option is:
{
"a": ["an", "our"]
}
uselessWords
Words that are ignored when searching for one that adds meaning.
For example, with { uselessWords: ["our"] }, the following comment would be considered uninformative:
/** Our text. */
export const text = ":)";
The default uselessWords option is:
["a", "an", "i", "in", "of", "s", "the"]
Development
See .github/CONTRIBUTING.md, then .github/DEVELOPMENT.md.
Thanks! 💖
Contributors
 Josh Goldberg 🔧 |
💙 This package is based on @JoshuaKGoldberg's template-typescript-node-package.