Skip to content
Flint
Blog

descriptionValidity

Enforces that the description property 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”
5<3{d ivclassNa="meec-li">nt< sp ansty="le--0:#7FDBCA;--1:#096E">72"descriptio53<: sp ansty="le--0:#D9F5DD;--1:#1111">11<""d ivclassNa="meec-li">5<3}d ivclassNa="meco"><}d>5<3{d ivclassNa="meec-li">nt< sp ansty="le--0:#7FDBCA;--1:#096E">72"descriptio53<: sp ansty="le--0:#FF6A83;--1:#A248">48nu5<3}d ivclassNa="meco"><}d>5<3{d ivclassNa="meec-li">nt< sp ansty="le--0:#7FDBCA;--1:#096E">72"descriptio53: <{}d ivclassNa="meec-li">5<3}d ivclassNa="meco"><}d>
3de6E72"descript3F<53: spans="tyle--0:#D9F5DD;--1:#11">1<111" spans="tyle--0:#C789D6;--1:#7C">5686The Fra1<111 "divclass="Nameec-">3

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.

Section titled “Related Rules”

Further Reading

Section titled “Further Reading”

Equivalents in Other Linters

Section titled “Equivalents in Other Linters”