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

❌ Incorrect

{
  "private": true,
  "files": ["lib"]
}

{
  "private": true,
  "publishConfig": {
    "access": "public"
  }
}

✅ Correct

{
  "private": true
}

{
  "private": false,
  "files": ["lib"],
  "publishConfig": {
    "access": "public"
  }
}

Options

blockedProperties

Type: string[]

Default: ["files", "publishConfig"]

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

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

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

• npm: package.json > private
• npm: package.json > files
• npm: package.json > publishConfig

Equivalents in Other Linters

• ESLint: package-json/restrict-private-properties