useRequiredScripts (JSON)

Language JSON (and super languages)

Summary

Rule available since: v2.3.9
Diagnostic Category: lint/suspicious/useRequiredScripts
This rule isn’t recommended, so you need to enable it.
This rule doesn’t have a fix.
The default severity of this rule is warning.

How to configure

1
{
2
  "linter": {
3
    "rules": {
4
      "suspicious": {
5
        "useRequiredScripts": "error"
6
      }
7
    }
8
  }
9
}

Description

Require configured scripts in package.json.

A repository can contain several packages that share commands such as test or build. Tools run from the repository’s top-level directory may expect every package to provide the same script names. The rule does nothing when requiredScripts is empty.

Examples

Invalid

1
{
2
  "linter": {
3
    "rules": {
4
      "suspicious": {
5
        "useRequiredScripts": {
6
          "level": "on",
7
          "options": {
8
            "requiredScripts": [
9
              "test",
10
              "build"
11
            ]
12
          }
13
        }
14
      }
15
    }
16
  }
17
}

1
{
2
    "scripts": {
3
        "test": "vitest"
4
    }
5
}

/package.json:2:5 lint/suspicious/useRequiredScripts ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ⚠ The required script build is missing from package.json.
  
    1 │ {
  > 2 │     "scripts": {
      │     ^^^^^^^^^^^^
  > 3 │         "test": "vitest"
  > 4 │     }
      │     ^
    5 │ }
    6 │ 
  
  ℹ Consistent scripts across packages ensure that each can be run reliably from the root of our project. Add the missing script to your package.json.

Valid

1
{
2
    "scripts": {
3
        "test": "vitest",
4
        "build": "tsc"
5
    }
6
}

Options

`requiredScripts`

Lists script names that must appear in the scripts object. Defaults to an empty list, which disables the rule.