Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/origin-1/eslint-p
A drop-in replacement for ESLint 9 featuring multithreaded parallel linting.
https://github.com/origin-1/eslint-p
concurrency eslint multithreading parallel
Last synced: about 9 hours ago
JSON representation
A drop-in replacement for ESLint 9 featuring multithreaded parallel linting.
- Host: GitHub
- URL: https://github.com/origin-1/eslint-p
- Owner: origin-1
- License: other
- Created: 2023-12-01T14:59:12.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-24T08:06:39.000Z (2 months ago)
- Last Synced: 2024-12-24T11:56:01.496Z (about 1 month ago)
- Topics: concurrency, eslint, multithreading, parallel
- Language: JavaScript
- Homepage:
- Size: 202 KB
- Stars: 23
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# eslint-p · [![npm version][npm badge]][npm URL]
A drop-in replacement for ESLint 9 featuring multithreaded parallel linting.
> **IMPORTANT:** Legacy `.eslintrc` configuration is not supported.
## Installation
```shell
npm i --save-dev eslint-p
```
```shell
yarn add --dev eslint-p
```
```shell
pnpm add --save-dev eslint-p
```
## Usage
All [ESLint CLI options](https://eslint.org/docs/latest/use/command-line-interface#options) are supported, plus `--concurrency` to specify the number of linting threads explicitly.
Example:
```shell
npx eslint-p --fix --concurrency=4
```
Valid values for the `--concurrency` option are:
* **positive integers (e.g. `4`)**:
Maximum number of linting threads. The effective number of threads can be lower when linting only a few files.
* **`auto`**:
Choose number of linting threads automatically (default).
* **`off`**:
No multithreading, run like ESLint. This is not the same as `--concurrency=1`.
> Normally, a performance improvement **will be only noticeable on systems with 4 or more CPUs**.
> Some plugins like `typescript-eslint` with type-aware linting can increase the time required to initialize a linting thread resulting in performance degradation when multithreading is used.
## ESLint is installed as a dependency
This package has ESLint set as a dependency, so if you already have `eslint` installed, but with a different version than the one specified in the `package.json` of this package you might get inconsistent results between the CLI and the editor.
To check the version of ESLint used by this package you can use:
```shell
npx eslint-p -v
```
To avoid inconsistencies, install the same `eslint` version used by this package or remove the `eslint` dependency from your `package.json`.
[You can find more information on this PR](https://github.com/origin-1/eslint-p/pull/1).
[npm badge]: https://img.shields.io/npm/v/eslint-p?logo=npm
[npm URL]: https://www.npmjs.com/package/eslint-p