Skip to content

valid-publishConfig

💼 This rule is enabled in the following configs: ✅ recommended, 📦 recommended-publishable.

This rule uses package-json-validator to validate the publishConfig property, if present, against the following criteria:

It must be an object
Each property in the object that maps to an existing package.json property (e.g. exports) must pass the same validations that would be applied to the top-level property
For properties that don’t map to other top-level package.json properties (e.g. access), they have their own set of validations that are applied, based on a combination of the npm and pnpm specifications

Examples

❌ Incorrect
✅ Correct

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

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

require-publishConfig - Enforces that the publishConfig property is present.

Further Reading