require-peerDependencies
This rule checks for the existence of the peerDependencies property and reports a violation if it doesn’t exist.
Examples
Section titled “Examples”{ "name": "thee-silver-mt-zion", "version": "13.0.0"}{ "name": "thee-silver-mt-zion", "version": "13.0.0", "peerDependencies": { "gybe": "^1.2.3" }}Options
Section titled “Options”| 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-peerDependencies": [ "error", { "ignorePrivate": false } ]}Examples
Section titled “Examples”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, "peerDependencies": { "gybe": "^1.2.3" }}Example of correct code for this rule with the { "ignorePrivate": true } option:
{ "private": true}Related Rules
Section titled “Related Rules”valid-peerDependencies- Enforces that thepeerDependenciesproperty is valid.valid-peerDependenciesMeta-relationship- Enforces that every dependency declared insidepeerDependenciesMetais also declared inpeerDependencies.