valid-name

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

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

• It must be a string
• It should pass validate-npm-package-name validation

Examples

❌ Incorrect

{
  "name": "Exciting! Package! Name!"
}

✅ Correct

{
  "name": "exciting-package-name"
}

Related Rules

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

Further Reading

• npm: package.json > name