valid-config

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

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

Examples

❌ Incorrect

{
  "config": "config.json"
}

✅ Correct

{
  "config": {
    "name": "foo",
    "port": "8080"
  }
}

Related Rules

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

Further Reading

• npm: package.json > config