Skip to content

require-devEngines

This rule checks for the existence of the devEngines property and reports a violation if it doesn’t exist.

Examples

❌ Incorrect
✅ Correct

{
  "name": "thee-silver-mt-zion",
  "version": "13.0.0"
}

{
  "name": "thee-silver-mt-zion",
  "version": "13.0.0",
  "devEngines": {
    "runtime": {
      "name": "node",
      "version": "^20.19.0 || >=22.12.0",
      "onFail": "download"
    },
    "packageManager": {
      "name": "pnpm",
      "version": "^10.0.0",
      "onFail": "error"
    }
  }
}

Options

Name	Description	Type	Default
`ignorePrivate`	Determines if this rule should be enforced when the package’s `private` property is `true`.	Boolean	`false`

{
  "package-json/require-devEngines": [
    "error",
    {
      "ignorePrivate": false
    }
  ]
}

Examples

❌ Incorrect
✅ Correct

Example of incorrect code for this rule with the { "ignorePrivate": false } option:

{
  "private": true
}

Examples of incorrect code for this rule with the { "ignorePrivate": true } option:

{
  "private": false
}

{}

Example of correct code for this rule with the { "ignorePrivate": false } option:

{
  "private": true,
  "devEngines": {
    "runtime": {
      "name": "node",
      "version": "^20.19.0 || >=22.12.0",
      "onFail": "download"
    },
    "packageManager": {
      "name": "pnpm",
      "version": "^10.0.0",
      "onFail": "error"
    }
  }
}

Example of correct code for this rule with the { "ignorePrivate": true } option:

{
  "private": true
}

valid-devEngines - Enforces that the devEngines property is valid.

Further Reading