esprint

3.6.0 verified Sat Apr 25 auth: no javascript maintenance

esprint (v3.6.0) is a parallelized ESLint runner that speeds up linting by running the linting engine across multiple threads. It sets up a server daemon to cache lint results in memory and uses a file watcher to only lint changed files. It also offers a CI mode that runs linting in parallel without a daemon. Maintenance is sporadic; the last release was in 2021. Key differentiators include automatic CPU core utilization, a background server for caching, and a dedicated CI mode. Requires Node >=12 and ESLint >=7.

Common errors

error Error: No .esprintrc file found ↓

cause Missing configuration file in project root.

fix

Create a .esprintrc file with paths and ignored fields.

error Error: Cannot find module 'eslint' ↓

cause ESLint peer dependency not installed.

fix

Run npm install eslint@>=7

error Error: Port 5004 is already in use ↓

cause Another process is using the default or configured port.

fix

Specify an unused port in .esprintrc or kill the offending process.

Warnings

breaking The option to specify number of workers has been removed from .esprintrc in v0.4.0-beta.10. ↓

fix Use --workers CLI argument instead of .esprintrc configuration.

deprecated esprint is no longer actively maintained; no releases since 2021. ↓

fix Consider alternatives like eslint-plugin-only-warn or lint-staged with parallel.

gotcha esprint requires .esprintrc file in project root; absence causes error. ↓

fix Create a .esprintrc file in your project root with paths and ignored lists.

gotcha Running esprint from a subfolder may not work correctly if .esprintrc is not at project root. ↓

fix Ensure .esprintrc is in the root directory.

gotcha esprint uses a background server on a port; conflicts with other services possible. ↓

fix Specify a different port in .esprintrc or use esprint check to avoid daemon.

Install

npm install esprint

yarn add esprint

pnpm add esprint

Imports

esprint (CLI)
wrong
```
npx eslint
```
correct
```
npx esprint
```
esprint is primarily a CLI tool; there is no JavaScript API export.
esprint check
wrong
```
npx eslint .
```
correct
```
npx esprint check
```
Use 'esprint check' for CI mode (no daemon).
esprint stop
wrong
```
kill <pid>
```
correct
```
npx esprint stop
```
Stops the background server and clears cache.

Quickstart

Configure paths in .esprintrc, then run esprint in default or CI mode.

// .esprintrc
{
  "paths": ["src/**/*.js"],
  "ignored": ["**/node_modules/**"],
  "port": 5004
}

// Terminal
esprint --workers=4
esprint check --fix