contributorsValidity

Enforces that the contributors property is valid.

✅ This rule is included in the package-json logical presets.

This rule checks that the contributors property is an array of objects. Each object should have at least a name, and optionally email and url. If present, email and url should be valid formats.

Examples

❌ Incorrect

{
  "contributors": "Example Contributor"
}

✅ Correct

{
  "contributors": [
    {
      "name": "Example Contributor",
      "email": "example@flint.fyi",
      "url": "https://flint.fyi"
    }
  ]
}

When Not To Use It

If you don’t need compliance with npm’s contributors field specification, you can disable this rule. For example, if you use a different package manager that treats the field differently, this rule may not be correct for you.

Related Rules

• contributorsPresence - Enforces that the contributors property is present.

Further Reading

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

Equivalents in Other Linters

• ESLint: package-json/valid-contributors