Skip to content

valid-description

💼 This rule is enabled in the following configs: ✔️ legacy-recommended, ✅ recommended, 📦 recommended-publishable.

This rule aims to ensure that the description field complies with the npm specification.

The should be a non-empty string.

Examples of incorrect code for this rule:

{
"description": ""
}
{
"description": null
}
{
"description": {}
}

Examples of correct code for this rule:

{
"description": "The Fragile"
}