descriptionValidity
Enforces that the
descriptionproperty is valid.
✅ This rule is included in the package-json logical presets.
This rule ensures that the description field is a non-empty string.
Examples
Section titled “Examples”{ "description": ""}{ "description": null}{ "description": {}}{ "description": "The Fragile"}When Not To Use It
Section titled “When Not To Use It”If you don’t need compliance with npm’s description field specification, you can disable this rule.
For example, if you use a different package manager that treats the field differently, this rule may not be correct for you.
Related Rules
Section titled “Related Rules”- descriptionPresence - Enforces that the
descriptionproperty is present.
Further Reading
Section titled “Further Reading”Equivalents in Other Linters
Section titled “Equivalents in Other Linters”- ESLint:
package-json/valid-description
Made with ❤️🔥 around the world by
the Flint team and contributors.