131 lines
4.5 KiB
Markdown
131 lines
4.5 KiB
Markdown
# eslint-plugin-pnpm
|
|
|
|
[![npm version][npm-version-src]][npm-version-href]
|
|
[![npm downloads][npm-downloads-src]][npm-downloads-href]
|
|
[![bundle][bundle-src]][bundle-href]
|
|
[![JSDocs][jsdocs-src]][jsdocs-href]
|
|
[![License][license-src]][license-href]
|
|
|
|
ESLint plugin to enforce and auto-fix pnpm catalogs.
|
|
|
|
This plugin consists of two set of rules that applies to `package.json` and `pnpm-workspace.yaml` respectively.
|
|
|
|
- [`json-` rules](./src/rules/json) applies to `package.json` and requires [`jsonc-eslint-parser`](https://github.com/ota-meshi/jsonc-eslint-parser) to be used as parser.
|
|
- [`yaml-` rules](./src/rules/yaml) applies to `pnpm-workspace.yaml` and requires [`yaml-eslint-parser`](https://github.com/ota-meshi/yaml-eslint-parser) to be used as parser.
|
|
- YAML support is still experimental as it might have race conditions with other plugins.
|
|
|
|
## Setup
|
|
|
|
```bash
|
|
pnpm add -D eslint-plugin-pnpm
|
|
```
|
|
|
|
### Basic Usage
|
|
|
|
```js
|
|
// eslint.config.mjs
|
|
import { configs } from 'eslint-plugin-pnpm'
|
|
|
|
export default [
|
|
{
|
|
ignores: ['**/node_modules/**', '**/dist/**'],
|
|
},
|
|
...configs.json,
|
|
...configs.yaml,
|
|
]
|
|
```
|
|
|
|
### Manual Configuration
|
|
|
|
```js
|
|
// eslint.config.mjs
|
|
import pluginPnpm from 'eslint-plugin-pnpm'
|
|
import * as jsoncParser from 'jsonc-eslint-parser'
|
|
import * as yamlParser from 'yaml-eslint-parser'
|
|
|
|
export default [
|
|
{
|
|
ignores: ['**/node_modules/**', '**/dist/**'],
|
|
},
|
|
{
|
|
name: 'pnpm/package.json',
|
|
files: [
|
|
'package.json',
|
|
'**/package.json',
|
|
],
|
|
languageOptions: {
|
|
parser: jsoncParser,
|
|
},
|
|
plugins: {
|
|
pnpm: pluginPnpm,
|
|
},
|
|
rules: {
|
|
'pnpm/json-enforce-catalog': 'error',
|
|
'pnpm/json-valid-catalog': 'error',
|
|
'pnpm/json-prefer-workspace-settings': 'error',
|
|
},
|
|
},
|
|
{
|
|
name: 'pnpm/pnpm-workspace-yaml',
|
|
files: ['pnpm-workspace.yaml'],
|
|
languageOptions: {
|
|
parser: yamlParser,
|
|
},
|
|
plugins: {
|
|
pnpm: pluginPnpm,
|
|
},
|
|
rules: {
|
|
'pnpm/yaml-no-unused-catalog-item': 'error',
|
|
'pnpm/yaml-no-duplicate-catalog-item': 'error',
|
|
'pnpm/yaml-valid-packages': 'error',
|
|
},
|
|
},
|
|
]
|
|
```
|
|
|
|
## Rules
|
|
|
|
### JSON Rules (`package.json`)
|
|
|
|
- [`json-enforce-catalog`](./src/rules/json/json-enforce-catalog.ts) - Enforce catalog usage for dependencies
|
|
- [`json-valid-catalog`](./src/rules/json/json-valid-catalog.ts) - Validate catalog references in dependencies
|
|
- [`json-prefer-workspace-settings`](./src/rules/json/json-prefer-workspace-settings.ts) - Prefer workspace protocol for local dependencies
|
|
|
|
### YAML Rules (`pnpm-workspace.yaml`)
|
|
|
|
- [`yaml-no-unused-catalog-item`](./src/rules/yaml/yaml-no-unused-catalog-item.ts) - Disallow unused catalog items
|
|
- [`yaml-no-duplicate-catalog-item`](./src/rules/yaml/yaml-no-duplicate-catalog-item.ts) - Disallow duplicate catalog items
|
|
- [`yaml-valid-packages`](./src/rules/yaml/yaml-valid-packages.ts) - Ensure package patterns match directories with package.json
|
|
- [`yaml-enforce-settings`](./src/rules/yaml/yaml-enforce-settings.ts) - Enforce settings in `pnpm-workspace.yaml`
|
|
|
|
## Settings
|
|
|
|
| Name | Description | Type | Default |
|
|
| --------------------- | ----------------------------------------------------------- | ------- | ------- |
|
|
| `ensureWorkspaceFile` | Whether to create `pnpm-workspace.yaml` if it doesn't exist | boolean | false |
|
|
|
|
## Sponsors
|
|
|
|
<p align="center">
|
|
<a href="https://cdn.jsdelivr.net/gh/antfu/static/sponsors.svg">
|
|
<img src='https://cdn.jsdelivr.net/gh/antfu/static/sponsors.svg' alt="antfu's sponsors"/>
|
|
</a>
|
|
</p>
|
|
|
|
## License
|
|
|
|
[MIT](./LICENSE) License © [Anthony Fu](https://github.com/antfu)
|
|
|
|
<!-- Badges -->
|
|
|
|
[npm-version-src]: https://img.shields.io/npm/v/eslint-plugin-pnpm?style=flat&colorA=080f12&colorB=1fa669
|
|
[npm-version-href]: https://npmjs.com/package/eslint-plugin-pnpm
|
|
[npm-downloads-src]: https://img.shields.io/npm/dm/eslint-plugin-pnpm?style=flat&colorA=080f12&colorB=1fa669
|
|
[npm-downloads-href]: https://npmjs.com/package/eslint-plugin-pnpm
|
|
[bundle-src]: https://img.shields.io/bundlephobia/minzip/eslint-plugin-pnpm?style=flat&colorA=080f12&colorB=1fa669&label=minzip
|
|
[bundle-href]: https://bundlephobia.com/result?p=eslint-plugin-pnpm
|
|
[license-src]: https://img.shields.io/github/license/antfu/pnpm-workspace-utils.svg?style=flat&colorA=080f12&colorB=1fa669
|
|
[license-href]: https://github.com/antfu/pnpm-workspace-utils/blob/main/LICENSE.md
|
|
[jsdocs-src]: https://img.shields.io/badge/jsdocs-reference-080f12?style=flat&colorA=080f12&colorB=1fa669
|
|
[jsdocs-href]: https://www.jsdocs.io/package/eslint-plugin-pnpm
|