Skip to content
Flint
Blog

bugsValidity

Enforces that the bugs property is valid.

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

This rule checks that the bugs property is either a URL string or an object with email and / or url properties. If url is present, it should be a valid URL. If email is present, it should be a string.

Examples

Section titled “Examples”
5<3{d ivclassNa="meec-li">nt< sp ansty="le--0:#7FDBCA;--1:#096E">72"bug53<: sp ansty="le--0:#D9F5DD;--1:#1111">1<1"sp ansty="le--0:#C789D6;--1:#7C56">86not-a-u1<1"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"bug53:< {d ivclassNa="meec-li">nt < sp ansty="le--0:#7FDBCA;--1:#096E">72"extr53<: sp ansty="le--0:#FF6A83;--1:#A248">48tr5<3,d ivclassNa="meec-li">nt < sp ansty="le--0:#7FDBCA;--1:#096E">72"emai53<: sp ansty="le--0:#D9F5DD;--1:#1111">1<1"sp ansty="le--0:#C789D6;--1:#7C56">86name@example.c1<1"d ivclassNa="meec-li">53< sp ansty="le--0:#D6DEEB;--1:#403F">5<3}d ivclassNa="meec-li">5<3}d ivclassNa="meco"><}d>
3de6E72"b3F<53: spans="tyle--0:#D9F5DD;--1:#11">1<111" spans="tyle--0:#C789D6;--1:#7C">5686https://example.com/is1<111 "divclass="Nameec-">3<}di vdivclass="Nameexpressive-">3de6E72"b3F5<3: {divclass="Nameec-">dent< spans="tyle--0:#7FDBCA;--1:#09">6E72"em3F<53: spans="tyle--0:#D9F5DD;--1:#11">1<111" spans="tyle--0:#C789D6;--1:#7C">5686name@example<.com spans="tyle--0:#D9F5DD;--1:#11">1<111" spans="tyle--0:#D6DEEB;--1:#40">3dent< spans="tyle--0:#7FDBCA;--1:#09">6E72"3F<53: spans="tyle--0:#D9F5DD;--1:#11">1<111" spans="tyle--0:#C789D6;--1:#7C">5686https://example.com/is1<111 "divclass="Nameec-">3F<53 spans="tyle--0:#D6DEEB;--1:#40">33< }>

When Not To Use It

Section titled “When Not To Use It”

If you don’t need compliance with npm’s bugs field specification, you can disable this rule. For example, if you use a package registry that accepts additional bug metadata properties, this rule may not be correct for you.

Section titled “Related Rules”
  • bugsPresence - Enforces that the bugs property is present.

Further Reading

Section titled “Further Reading”

Equivalents in Other Linters

Section titled “Equivalents in Other Linters”