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: about 2 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/es-tooling/eslint-plugin-depend
• Owner: es-tooling
• License: mit
• Created: 2024-03-09T14:12:52.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-07-18T15:10:05.000Z (6 months ago)
• Last Synced: 2024-08-01T10:58:22.579Z (5 months ago)
• Language: TypeScript
• Size: 75.2 KB
• Stars: 193
• Watchers: 3
• Forks: 4
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-eslint - depend - Helps detect dependency tree bloat and redundant polyfills. (Plugins / Code Quality)

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 * as depend from 'eslint-plugin-depend';

export default [

  depend.configs['flat/recommended'],

  // or if you want to specify `files`, or other options

  {

    ...depend.configs['flat/recommended'],

    files: ['test/**/*.js']

  }

];

```

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