ESLint Plugin Progress

0.0.1 verified Sat Apr 25 auth: no javascript

eslint-plugin-progress v0.0.1 provides real-time progress updates and summary statistics when running ESLint on large projects. It displays a timestamped count of processed files during execution and a final report including total files, processing time, and the 20 slowest files. The plugin is useful for monorepos or codebases with thousands of files where ESLint can take minutes. It is a simple ESLint rule plugin with no dependencies. However, it is in early development (v0.0.1) and has known issues such as missing stats for the last processed file.

Common errors

error Error: Failed to load plugin 'progress' declared in '.eslintrc': Cannot find module 'eslint-plugin-progress' ↓

cause Plugin not installed or not in node_modules.

fix

Run npm install eslint-plugin-progress --save-dev or yarn add eslint-plugin-progress --dev.

error ESLint configuration error: Cannot find plugin progress. Referenced from: /path/to/.eslintrc ↓

cause Plugin name mismatch: .eslintrc uses `plugins: "progress"` but package might not be interpreted correctly.

fix

Ensure the package name exactly matches: plugins: ["progress"] and the package is installed in the same directory as .eslintrc.

error Warning: Rule 'progress/activate' is not found in configuration. ↓

cause The rule name is correctly placed, but ESLint version may not support progress/activate notation.

fix

Use the rule format: "progress/activate": 1. Ensure ESLint version >= 4. For older versions, use "progress/activate": 1 as string key.

Warnings

gotcha The plugin does not keep stats of the last file processed. ↓

fix None yet; the issue is acknowledged. Consider contributing a fix or using a different tool if accurate per-file stats are critical.

deprecated The package is version 0.0.1 and may not be actively maintained. No updates since initial release. ↓

fix Check GitHub for any updates or forks. Consider alternatives like eslint-plugin-only-warn or custom reporter if needed.

gotcha Configuration uses plugins key as a string array, but some versions of ESLint (< 4) require different syntax. ↓

fix Ensure ESLint version >= 4. For older versions, use `plugins: { "progress": true }` format.

Install

npm install eslint-plugin-progress

yarn add eslint-plugin-progress

pnpm add eslint-plugin-progress

Imports

activate

wrong

// Common mistake: importing as a Node module
const progress = require('eslint-plugin-progress');
// This is not how ESLint plugins are used; they must be declared in .eslintrc.

correct

// .eslintrc
plugins: ["progress"]
rules: {
  "progress/activate": 1
}

ESLint plugins are not imported via require/import; they are installed as npm packages and loaded via the 'plugins' config field. This plugin exposes the rule 'progress/activate'.

Quickstart

Shows installation and configuration of the plugin to display progress when running ESLint.

// Install the plugin
// npm install eslint-plugin-progress --save-dev

// .eslintrc configuration:
{
  "plugins": ["progress"],
  "rules": {
    "progress/activate": 1
  }
}

// Run ESLint
// npx eslint . // Progress will be displayed in the console.