descriptionPresence

Enforces that the description property is present.

✅ This rule is included in the package-json logical presets.

npm requires that the description field in package.json is present.

Examples

❌ Incorre

53<{}d ivclassNa="meco"><{}d>5<3{d ivclassNa="meec-li">nt< sp ansty="le--0:#7FDBCA;--1:#096E">72"nam53<: sp ansty="le--0:#D9F5DD;--1:#1111">1<1"sp ansty="le--0:#C789D6;--1:#7C56">86my-reposito1<1"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">5686Hello, worl1<111 11"divcla="ssNamee">4<03F 53}divcla="ssNa">< ✨" }divdivc="lassNameexpress"><-contentfi gcaptionc="lassNa">:<#40 3F53{divc="lassNam">me:#096E72"desc:#<403F 53: s="panstyle--0:#D9F5DD;--1">:<#111 111"s="panstyle--0:#C789D6;--1">:#7C5686Hello, -<1:#1 11111=""spanstyle--0:#D6DEEB;-">-<1:# 403F53,di="vclassN">Na-1:#09<6E72 "name=""spanstyle--0:#D6DEEB;-">-1<:#40 3F53:=" spanstyle--0:#D9F5DD;-">-<1:#1 11111=""spanstyle--0:#C789D6;-">-1:#7C5686my--<1:# 111111"di="vclassN">-<1:# 403F53}di="vcla">

Options

ignorePrivate

Whether the property should still be required when the package’s private property is true. Defaults to false.

This option can be useful if the rule is enabled on many package.json files and some files differ in privacy.

When Not To Use It

If your package doesn’t need to specify a description, you can disable this rule. For example, if your package is local-only and is never published online or made open source, adding a description may not be relevant for you.

Related Rules

• descriptionValidity - Enforces that the description property is valid.

Further Reading

• npm: package.json > description

Equivalents in Other Linters

• ESLint: package-json/require-description