
Product
A Fresh Look for the Socket Dashboard
We’ve redesigned the Socket dashboard with simpler navigation, less visual clutter, and a cleaner UI that highlights what really matters.
are-docs-informative
Advanced tools
Checks whether a documentation description introduces any new information. ℹ️
Checks whether a documentation description introduces any new information. ℹ️
See this in action in
jsdoc/informative-docs
!
npm i are-docs-informative
import { areDocsInformative } from "are-docs-informative";
areDocsInformative("The user id.", "userId"); // false
areDocsInformative("Retrieved user id.", "userId"); // true
The areDocsInformative
function can receive a third, optional object parameter.
It can contain any of the following properties.
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"]
See .github/CONTRIBUTING.md
, then .github/DEVELOPMENT.md
.
Thanks! ℹ
Josh Goldberg 🔧 📖 🚇 💻 🖋 🤔 🚧 📆 |
💝 This package was templated with
create-typescript-app
using the Bingo engine.
FAQs
Checks whether a documentation description introduces any new information. ℹ️
The npm package are-docs-informative receives a total of 2,666,212 weekly downloads. As such, are-docs-informative popularity was classified as popular.
We found that are-docs-informative demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
We’ve redesigned the Socket dashboard with simpler navigation, less visual clutter, and a cleaner UI that highlights what really matters.
Industry Insights
Terry O’Daniel, Head of Security at Amplitude, shares insights on building high-impact security teams, aligning with engineering, and why AI gives defenders a fighting chance.
Security News
MCP spec updated with structured tool output, stronger OAuth 2.1 security, resource indicators, and protocol cleanups for safer, more reliable AI workflows.