# no-orphan-script-hooks

📝 Disallow `pre`/`post` script hooks without a corresponding script.

💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/sindresorhus/eslint-package-json#configs).

<!-- end auto-generated rule header -->
<!-- Do not manually modify this header. Run: `npm run fix:eslint-docs` -->

npm runs `pre<name>` and `post<name>` scripts before and after `name`, respectively. Without the matching script, the hook cannot run as part of that command and is usually a stale script or a typo.

npm lifecycle scripts such as `prepare`, `prepack`, and `preversion` are exempt because npm runs them independently. `preenv`, `postenv`, `prerestart`, and `postrestart` are also exempt because npm supplies implicit `env` and `restart` scripts. The rule does not inspect the filesystem, so a `prestart` hook that relies on npm's implicit `server.js` start script must be exempted with `ignore`.

Common standalone tool names such as `postcss`, `posthtml`, `prettier`, and `preview`, including namespaced variants, are ignored by default. Namespaced `prepare:*` scripts and Git hook scripts named `precommit`, `pre-commit`, `prepush`, or `pre-push` are also treated as standalone commands rather than `pre` hooks.

`preuninstall`, `uninstall`, and `postuninstall` get their own message. npm removed the uninstall lifecycle in v7, since it cannot tell whether a package is going away because the user removed it, removed something that depended on it, or removed one of several dependents, so these scripts [never run](https://docs.npmjs.com/cli/using-npm/scripts). Adding the missing `uninstall` script would not help; the script has to go.

No fix is provided because a hook-like name may be an intentionally standalone command, and only the package author can decide whether to remove it, add its target script, or ignore it.

## Options

### `ignore`

Type: `Array<string | RegExp>`\
Default: `[]`

Regular expressions matching standalone script names to ignore. Strings are interpreted as regular expression source.

```js
'package-json/no-orphan-script-hooks': [
	'error',
	{
		ignore: [
			'^preflight$',
		],
	},
]
```

## Examples

```json
// ❌
{
	"scripts": {
		"prebuild": "npm run clean"
	}
}
```

```json
// ✅
{
	"scripts": {
		"prebuild": "npm run clean",
		"build": "tsc",
		"postbuild": "npm run check"
	}
}
```

```json
// ❌ — npm never runs the uninstall lifecycle, so adding `uninstall` would not help.
{
	"scripts": {
		"preuninstall": "my-cleanup"
	}
}
```

```json
// ✅ — the cleanup has to move somewhere npm actually runs it.
{
	"scripts": {
		"clean": "my-cleanup"
	}
}
```

With `{ignore: ['^preflight$']}`:

```json
// ✅
{
	"scripts": {
		"preflight": "npm run check"
	}
}
```