require-description

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

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

Example of incorrect code for this rule:

{
  "version": "13.0.0",
  "author": "Jessica Moss"
}

Example of correct code for this rule:

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

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-description": [
    "error",
    {
      "ignorePrivate": false
    }
  ]
}

Example of incorrect code for this rule with the { "ignorePrivate": false } option:

{
  "private": true
}

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

{
  "private": true,
  "description": "Thee Silver Mt. Zion."
}

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

{
  "private": false
}

{}

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

{
  "private": true
}