Are Docs Informative

Checks whether a documentation description introduces any new information.

## Usage ```shell npm i are-docs-informative ``` ```ts 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: ```js /** Default smiley/winkey. */ export const defaultSmiley = "🙂"; ``` The default `aliases` option is: ```json { "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: ```js /** Our text. */ export const text = ":)"; ``` The default `uselessWords` option is: ```json ["a", "an", "i", "in", "of", "s", "the"] ``` ## Development See [`.github/CONTRIBUTING.md`](./.github/CONTRIBUTING.md), then [`.github/DEVELOPMENT.md`](./.github/DEVELOPMENT.md). Thanks! 💖 ## Contributors

_{Josh Goldberg}
🔧

> 💙 This package is based on [@JoshuaKGoldberg](https://github.com/JoshuaKGoldberg)'s [template-typescript-node-package](https://github.com/JoshuaKGoldberg/template-typescript-node-package).