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.

Current Tags

• 0.0.2                                ...           latest (2 years ago)

3 Versions

• 0.0.2                                ...           2 years ago
• 0.0.1                                ...           2 years ago
• 0.0.0                                ...           2 years ago