Skip to content

valid-peerDependenciesMeta

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

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

The value is an object
Each property’s key is a valid package name
Each property’s value is an object
The metadata object for each package should only have the optional property
The value of the optional property should be a boolean

Examples

❌ Incorrect
✅ Correct

{
  "peerDependenciesMeta": {
    "typescript": true
  }
}

{
  "peerDependenciesMeta": {
    "typescript": {
      "optional": true
    }
  }
}

require-peerDependenciesMeta - Enforces that the peerDependenciesMeta property is present.
valid-peerDependenciesMeta-relationship - Enforces that every dependency declared inside peerDependenciesMeta is also declared in peerDependencies.

Further Reading