valid-contributors

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

This rule uses package-json-validator to validate the contributors property, if present, against the following criteria:

• It must be an array of objects.
• Each object should have at least a name, and optionally email and url.
• email, if present, should be valid email address.
• url, if present, should be a valid URL.

Examples

❌ Incorrect

{
  "contributors": "Trent Reznor"
}

✅ Correct

{
  "contributors": [
    {
      "name": "Trent Reznor",
      "email": "treznor@nin.com",
      "url": "https://nin.com"
    }
  ]
}

Related Rules

• require-contributors - Enforces that the contributors property is present.

Further Reading

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