require-contributors

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

Note

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

Examples

❌ Incorrect

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

✅ Correct

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

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
    }
  ]
}

Examples

❌ Incorrect

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
}

{}

✅ Correct

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 correct code for this rule with the { "ignorePrivate": true } option:

{
  "private": true
}

Related Rules

• require-attribution - Ensures that proper attribution is included in a package, requiring that either author or contributors is defined, and that if contributors is present, it should include at least one contributor.
• valid-contributors - Enforces that the contributors property is valid.

Further Reading

• npm: package.json > people fields: author, contributors