valid-optionalDependencies

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

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

• The value is an object
• Each property’s key is a valid package name
• Each property’s value is a valid version range

Examples

❌ Incorrect

{
  "optionalDependencies": {
    "invalid-version": "catalob:"
  }
}

✅ Correct

{
  "optionalDependencies": {
    "david-bowie": "workspace:^",
    "nin": "catalog:",
    "thee-silver-mt-zion": "^1.2.3"
  }
}

Related Rules

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

Further Reading

• npm: package.json > optionalDependencies