scripts-name-casing

💼 This rule is enabled in the 🎨 stylistic config.

💡 This rule is manually fixable by editor suggestions.

This rule enforces that the keys of the scripts object (representing the commands for each script) should be in kebab case (e.g. "my-script"). It also permits kebab case segments separated by colons (e.g. "test:my-script").

Examples

❌ Incorrect

{
  "scripts": {
    "invalidName": "node ./scripts/build.js",
    "another:invalidCommand": "node ./scripts/another.js"
  }
}

✅ Correct

{
  "scripts": {
    "valid-command": "node ./scripts/build.js",
    "another:valid-command": "node ./scripts/another.js"
  }
}

Related Rules

• require-scripts - Enforces that the scripts property is present.
• valid-scripts - Enforces that the scripts property is valid.
• bin-name-casing - Enforces that keys of bin are in kebab case.

Further Reading

• npm: package.json > scripts