require-files

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

This rule checks for the existence of the files 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",
  "files": ["lib"]
}

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-files": [
    "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,
  "files": ["lib"]
}

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

{
  "private": true
}

valid-files - Enforces that the files property is valid.
no-redundant-files - Enforces that the files property of a package.json doesn’t contain any redundant or unnecessary file entries.