Skip to main content

require-description

Enabling this rule will result in an error being generated if description is missing from the package.json file.

Example .npmpackagejsonlintrc configuration​

{
  "rules": {
    "require-description": "error"
  }
}

Rule Details​

Incorrect example(s)​

{

}

Correct example(s)​

{
  "description": "CLI app for linting package.json files."
}

History​

  • Renamed from description-required to require-description in version 1.0.0
  • Introduced in version 0.1.0