require-contributors

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

Example of incorrect code for this rule:

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

Example of correct code for this rule:

{
  "name": "thee-silver-mt-zion",
  "version": "13.0.0",
  "contributors": [
    {
      "name": "Trent Reznor",
      "email": "treznor@nin.com",
      "url": "https://nin.com"
    }
  ]
}

Note

For publishable packages, consider using the require-attribution rule instead, which requires that either author or contributors is present.

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-contributors": [
    "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,
  "contributors": [
    {
      "name": "Trent Reznor",
      "email": "treznor@nin.com",
      "url": "https://nin.com"
    }
  ]
}

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
}