require-description

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

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

Examples

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

{
  "version": "13.0.0",
  "author": "Jessica Moss",
  "description": "Thee Silver Mt. Zion."
}

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-description": [
    "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,
  "description": "Thee Silver Mt. Zion."
}

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

{
  "private": true
}