valid-description

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

The rule checks that, if present, the description property is a non-empty string.

Examples

❌ Incorrect

{
  "description": ""
}

✅ Correct

{
  "description": "The Fragile"
}

Related Rules

• require-description - Enforces that the description property is present.

Further Reading

• npm: package.json > description