Skip to content

valid-peerDependenciesMeta-relationship

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

💡 This rule is manually fixable by editor suggestions.

This rule enforces that every dependency declared inside peerDependenciesMeta is also declared in peerDependencies.

peerDependenciesMeta is meant to provide metadata about peer dependencies. So entries that do not correspond to an existing peerDependencies entry are redundant.

Examples

❌ Incorrect
✅ Correct

{
  "peerDependenciesMeta": {
    "some-package": {
      "optional": true
    }
  }
}

{
  "peerDependencies": {
    "some-package": "^1.0.0"
  },
  "peerDependenciesMeta": {
    "some-package": {
      "optional": true
    }
  }
}

{
  "peerDependencies": {
    "some-package": "^1.0.0"
  }
}

valid-peerDependencies - Enforces that the peerDependencies property is valid.
valid-peerDependenciesMeta - Enforces that the peerDependenciesMeta property is valid.

Further Reading