publishConfigValidity

Enforces that the publishConfig property is valid.

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

This rule checks that the publishConfig property is an object. Each property that maps to an existing package.json property (e.g. exports) must pass the same validations as the top-level property. Properties that don’t map to top-level fields (e.g. access) have their own validations based on the npm spec.

Examples

❌ Incorrect

{
  "publishConfig": {
    "provenance": "true"
  }
}

✅ Correct

{
  "publishConfig": {
    "provenance": true
  }
}

When Not To Use It

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

• publishConfigPresence - Enforces that the publishConfig property is present.

Further Reading

• npm: package.json > publishConfig

Equivalents in Other Linters

• ESLint: package-json/valid-publishConfig