require-config

This rule checks for the existence of the config property in a package.json, 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",
  "config": { "port": "8080" }
}

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-config": [
    "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,
  "config": { "port": "8080" }
}

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

{
  "private": true
}