Skip to content

valid-os

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

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

It must be an Array
All items in the Array should be one of the following: “aix”, “android”, “darwin”, “freebsd”, “linux”, “openbsd”, “sunos”, and “win32”

Examples

❌ Incorrect
✅ Correct

{
  "os": ["x64"]
}

{
  "os": ["linux", "win32"]
}

require-os - Enforces that the os property is present.

Further Reading