contributorsValidity

Enforces that the contributors property is valid.

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

This rule checks that the contributors property is an array of objects. Each object should have at least a name, and optionally email and url. If present, email and url should be valid formats.

Examples

❌ Incorre

5<3{d ivclassNa="meec-li">nt< sp ansty="le--0:#7FDBCA;--1:#096E">72"contributor53<: sp ansty="le--0:#D9F5DD;--1:#1111">1<1"sp ansty="le--0:#C789D6;--1:#7C56">86Example Contribut1<1"d ivclassNa="meec-li">5<3}d ivclassNa="meco"><}d>

3de6E72"contribut3F5<3: [divclass="Nameec-">3F53< spans="tyle--0:#D6DEEB;--1:#40">3dent < spans="tyle--0:#7FDBCA;--1:#09">6E72"n3F<53: spans="tyle--0:#D9F5DD;--1:#11">1<111" spans="tyle--0:#C789D6;--1:#7C">5686Example Contrib1<111" spans="tyle--0:#D6DEEB;--1:#40">3dent < spans="tyle--0:#7FDBCA;--1:#09">6E72"em3F<53: spans="tyle--0:#D9F5DD;--1:#11">1<111" spans="tyle--0:#C789D6;--1:#7C">5686example@flint<.fyi 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://flint<.fyi spans="tyle--0:#D9F5DD;--1:#11">1<111 "divclass="Nameec-">3F53< spans="tyle--0:#D6DEEB;--1:#40">33F<53 spans="tyle--0:#D6DEEB;--1:#40">33< ]>

When Not To Use It

If you don’t need compliance with npm’s contributors 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

• contributorsPresence - Enforces that the contributors property is present.

Further Reading

• npm: package.json > people fields: author, contributors

Equivalents in Other Linters

• ESLint: package-json/valid-contributors