require-peerDependenciesMeta

This rule checks for the existence of the peerDependenciesMeta property and reports a violation if it doesn’t exist.

Examples

{
  "name": "thee-silver-mt-zion",
  "version": "13.0.0"
}

{
  "name": "thee-silver-mt-zion",
  "version": "13.0.0",
  "peerDependenciesMeta": {
    "silver-mt-zion": {
      "optional": true
    }
  }
}

Name	Description	Type	Default
`ignorePrivate`	Determines if this rule should be enforced when the package’s `private` property is `true`.	Boolean	`false`

{
  "package-json/require-peerDependenciesMeta": [
    "error",
    {
      "ignorePrivate": false
    }
  ]
}

Example of incorrect code for this rule with the { "ignorePrivate": false } option:

{
  "private": true
}

Examples of incorrect code for this rule with the { "ignorePrivate": true } option:

{
  "private": false
}

{}

Example of correct code for this rule with the { "ignorePrivate": false } option:

{
  "private": true,
  "peerDependenciesMeta": {
    "silver-mt-zion": {
      "optional": true
    }
  }
}

Example of correct code for this rule with the { "ignorePrivate": true } option:

{
  "private": true
}

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