valid-bugs

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

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

• It must be either a string or an object
• If it’s a string, it should be a valid URL
• If it’s an object, it should have either email or url (or both)
• email should be a valid email address
• url should be a valid URL

Examples

❌ Incorrect

{
  "bugs": "some@email.com"
}

✅ Correct

{
  "bugs": {
    "email": "support@nin.com",
    "url": "https://nin.com/support"
  }
}

Related Rules

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

Further Reading

• npm: package.json > bugs