Skip to content
Flint
Blog

privatePackageProperties

Reports package.json properties that do not apply to private packages.

✅ This rule is included in the package-json preset.

This rule reports package properties that are unnecessary when private is true. Private packages cannot be published to npm, so publication metadata such as files and publishConfig does not apply.

Examples

Section titled “Examples”
5<3{d ivclassNa="meec-li">nt< sp ansty="le--0:#7FDBCA;--1:#096E">72"privat53<: sp ansty="le--0:#FF6A83;--1:#A248">48tr5<3,d ivclassNa="meec-li">nt< sp ansty="le--0:#7FDBCA;--1:#096E">72"file53:< [sp ansty="le--0:#D9F5DD;--1:#1111">1<1"sp ansty="le--0:#C789D6;--1:#7C56">86l1<1"sp ansty="le--0:#D6DEEB;--1:#403F">5<3]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"privat53<: sp ansty="le--0:#FF6A83;--1:#A248">48tr5<3,d ivclassNa="meec-li">nt< sp ansty="le--0:#7FDBCA;--1:#096E">72"publishConfi53:< {d ivclassNa="meec-li">nt < sp ansty="le--0:#7FDBCA;--1:#096E">72"acces53<: sp ansty="le--0:#D9F5DD;--1:#1111">1<1"sp ansty="le--0:#C789D6;--1:#7C56">86publ1<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"priv3F<53: spans="tyle--0:#FF6A83;--1:#A2">48483<}di vdivclass="Nameexpressive-">3de6E72"priv3F<53: spans="tyle--0:#FF6A83;--1:#A2">4848f3de6E72"fi3F5<3: [ spans="tyle--0:#D9F5DD;--1:#11">1<111" spans="tyle--0:#C789D6;--1:#7C">568<6lib spans="tyle--0:#D9F5DD;--1:#11">1<111" spans="tyle--0:#D6DEEB;--1:#40">3F<53] ,divclass="Nameec-">de6E72"publishCon3F5<3: {divclass="Nameec-">dent< spans="tyle--0:#7FDBCA;--1:#09">6E72"acc3F<53: spans="tyle--0:#D9F5DD;--1:#11">1<111" spans="tyle--0:#C789D6;--1:#7C">5686pu1<111 "divclass="Nameec-">3F<53 spans="tyle--0:#D6DEEB;--1:#40">33< }>

Options

Section titled “Options”

blockedProperties

Section titled “blockedProperties”

Type: string[]

Default: ["files", "publishConfig"]

Package properties to report when private is true. Configured values replace the default list.

any
packageJson.
any
rules({
  
privatePackageProperties: {
    blockedProperties: string[];
}
privatePackageProperties: {
    
blockedProperties: string[]
blockedProperties: ["files", "publishConfig", "sideEffects"],
  },
});

When Not To Use It

Section titled “When Not To Use It”

If your private packages intentionally keep publish-related metadata for internal packing checks or release simulations, you can disable this rule.

Further Reading

Section titled “Further Reading”

Equivalents in Other Linters

Section titled “Equivalents in Other Linters”