binValidity

Enforces that the bin property is valid.

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

This rule checks that the bin property is either a non-empty string or an object. If the value is an object, it should only consist of non-empty string values.

Examples

❌ Incorrect

{
  "bin": {
    "invalid-bin": 123
  }
}

✅ Correct

{
  "bin": "./bin/cli.js"
}

{
  "bin": {
    "my-cli": "./bin/cli.js"
  }
}

When Not To Use It

If you don’t need compliance with npm’s bin 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

• binPresence - Enforces that the bin property is present.

Further Reading

• npm: package.json > bin

Equivalents in Other Linters

• ESLint: package-json/valid-bin