An open API service indexing awesome lists of open source software.

https://github.com/es-tooling/eslint-plugin-depend

An ESLint plugin for suggesting optimisations in choice of dependency, native equivalents, etc.
https://github.com/es-tooling/eslint-plugin-depend

Last synced: 20 days ago
JSON representation

An ESLint plugin for suggesting optimisations in choice of dependency, native equivalents, etc.

Awesome Lists containing this project

README

        

# eslint-plugin-depend

This is an ESLint plugin to help suggest alternatives to various dependencies.

Primarily, it will help detect dependency tree bloat and redundant
polyfills.

## Install

```sh
npm i -D eslint-plugin-depend
```

## Usage

If you're using the new flat config files, add to your `eslint.config.js`:

```ts
import depend from 'eslint-plugin-depend';
import {defineConfig} from 'eslint/config';

export default defineConfig([
{
files: ['**/*.js'],
plugins: {
depend
},
extends: ['depend/flat/recommended'],
}
]);
```

For older legacy projects, add to your `.eslintrc.json`:

```json
{
"extends": [
"plugin:depend/recommended"
]
}
```

### With `package.json`

Some rules (e.g. `ban-dependencies`) can be used against your `package.json`.

You can achieve this by using `jsonc-eslint-parser`.

For example, in your `.eslintrc.json`:

```json
{
"overrides": [
{
"files": ["package.json"],
"parser": "jsonc-eslint-parser",
"plugins": ["depend"],
"rules": {
"depend/ban-dependencies": "error"
}
}
]
}
```

Read more at the
[`jsonc-eslint-parser` docs](https://github.com/ota-meshi/jsonc-eslint-parser).

## Rules

- [`depend/ban-dependencies`](./docs/rules/ban-dependencies.md)

## License

MIT