require-name
💼 This rule is enabled in the following configs: ✅ recommended, 📦 recommended-publishable.
This rule checks for the existence of the name property and reports a violation if it doesn’t exist.
Examples
Section titled “Examples”{ "version": "13.0.0", "author": "Jessica Moss"}{ "name": "thee-silver-mt-zion", "version": "13.0.0", "author": "Jessica Moss"}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 | true |
{ "package-json/require-name": [ "error", { "ignorePrivate": true } ]}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, "name": "thee-silver-mt-zion"}Example of correct code for this rule with the { "ignorePrivate": true } option:
{ "private": true}Related Rules
Section titled “Related Rules”valid-name- Enforces that thenameproperty is valid.