are-docs-informative

v0.0.2

Checks whether a documentation description introduces any new information. For more information about how to use this package see README

Latest version published 2 years ago

License: MIT

NPM

GitHub

Package Health Score

78 / 100

security
No known security issues
popularity
Influential project
maintenance
Sustainable
community
Sustainable

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
0.0.2	\|	04/2023	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Yes

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Influential project

Weekly Downloads (1,679,164)

GitHub Stars: 8
Forks: 1
Contributors: 3

Direct Usage Popularity

The npm package are-docs-informative receives a total of 1,679,164 downloads a week. As such, we scored are-docs-informative popularity level to be Influential project.

Based on project statistics from the GitHub repository for the npm package are-docs-informative, we found that it has been starred 8 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 3
Funding: Yes

This project has seen only 10 or less contributors.

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

Open Issues: 0
Open PR: 10
Last Release: 2 years ago
Last Commit: 8 days ago

Further analysis of the maintenance status of are-docs-informative based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

An important project maintenance signal to consider for are-docs-informative is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >=14

Age: 2 years
Dependencies: 0 Direct
Versions: 4
Install Size: 13.6 kB
Dist-tags: 1
# of Files: 7
Maintainers: 1
TS Typings: No

are-docs-informative has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

Are Docs Informative

Checks whether a documentation description introduces any new information.

</a>
<a href="https://codecov.io/gh/JoshuaKGoldberg/are-docs-informative">
	<img src="https://codecov.io/gh/JoshuaKGoldberg/are-docs-informative/branch/main/graph/badge.svg?token=eVIFY4MhfQ" alt="Codecov Test Coverage">
</a>
<a href="https://github.com/JoshuaKGoldberg/are-docs-informative/blob/main/.github/CODE_OF_CONDUCT.md">
	<img src="https://img.shields.io/badge/code_of_conduct-enforced-21bb42" alt="Contributor Covenant">
</a>
<a href="https://github.com/JoshuaKGoldberg/are-docs-informative/blob/main/LICENSE.md">
    <img src="https://img.shields.io/github/license/JoshuaKGoldberg/are-docs-informative?color=21bb42" alt="License: MIT">
</a>
<a href="https://github.com/sponsors/JoshuaKGoldberg">
	<img src="https://img.shields.io/badge/sponsor-on_github-21bb42.svg" alt="Sponsor: On GitHub">
</a>
<img src="https://img.shields.io/badge/style-prettier-21bb42.svg" alt="Style: Prettier">
<img src="https://img.shields.io/badge/typescript-strict-21bb42.svg" alt="TypeScript: Strict">

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.

FAQs

What is are-docs-informative?

Checks whether a documentation description introduces any new information. Visit Snyk Advisor to see a full health score report for are-docs-informative, including popularity, security, maintenance & community analysis.

Is are-docs-informative popular?

The npm package are-docs-informative receives a total of 1,679,164 weekly downloads. As such, are-docs-informative popularity was classified as an influential project. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is are-docs-informative well maintained?

We found indications that are-docs-informative maintenance is sustainable demonstrating some project activity. We saw a total of 3 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is are-docs-informative safe to use?

The npm package are-docs-informative was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 21 December-2024, at 12:46 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP