configValidity

Enforces that the config property is valid.

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

The rule checks that, if present, the config property is an object.

Examples

❌ Incorrect

{
  "config": true
}

✅ Correct

{
  "config": {
    "port": "8080"
  }
}

When Not To Use It

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

• configPresence - Enforces that the config property is present.

Further Reading

• npm: package.json > config

Equivalents in Other Linters

• ESLint: package-json/valid-config