repositoryValidity

Enforces that the repository property is valid.

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

This rule checks that the repository property is either an object or a string. If it’s an object, it should have type, url, and optionally directory. If it’s a string, it should be a shorthand repo string from a supported provider.

Examples

❌ Incorre

5<3{d ivclassNa="meec-li">nt< sp ansty="le--0:#7FDBCA;--1:#096E">72"repositor53:< {d ivclassNa="meec-li">nt < sp ansty="le--0:#7FDBCA;--1:#096E">72"ur53<: sp ansty="le--0:#D9F5DD;--1:#1111">1<1"sp ansty="le--0:#C789D6;--1:#7C56">86git+https://github.com/flint-fyi/flint.g1<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"reposit3F<53: spans="tyle--0:#D9F5DD;--1:#11">1<111" spans="tyle--0:#C789D6;--1:#7C">5686github:flint-fyi/f1<111 "divclass="Nameec-">3<}di vdivclass="Nameexpressive-">3de6E72"reposit3F5<3: {divclass="Nameec-">dent< spans="tyle--0:#7FDBCA;--1:#09">6E72"t3F<53: spans="tyle--0:#D9F5DD;--1:#11">1<111" spans="tyle--0:#C789D6;--1:#7C">568<6git 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">5686git+https://github.com/flint-fyi/flint<.git spans="tyle--0:#D9F5DD;--1:#11">1<111 "divclass="Nameec-">3F<53 spans="tyle--0:#D6DEEB;--1:#40">33< }>

When Not To Use It

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

• repositoryPresence - Enforces that the repository property is present.

Further Reading

• npm: package.json > repository

Equivalents in Other Linters

• ESLint: package-json/valid-repository