eslint-plugin-file-progress

4.0.0-beta.1 verified Sat Apr 25 auth: no javascript

An ESLint plugin that displays a file-by-file progress indicator during linting. Current stable version is v3.0.2 (latest release), with v4.0.0-beta.1 targeting ESLint v10. Released under MIT. Key differentiators: minimal dependencies (nanospinner, picocolors), provides recommended config presets, supports hiding progress in CI via settings or the 'recommended-ci' config. Requires Node.js ^20.19.0 || ^22.13.0 || >=24.0.0 and ESLint >=9 (v3) or >=10 (v4 beta).

Common errors

error Error: Cannot find module 'eslint-plugin-file-progress' ↓

cause Plugin not installed as a dev dependency.

fix

Run 'npm install -D eslint-plugin-file-progress' or 'yarn add --dev eslint-plugin-file-progress'.

error TypeError: progress is not a function ↓

cause Using default import in a CommonJS file with require.

fix

Use 'const progress = (await import('eslint-plugin-file-progress')).default;' or switch to ESM.

error ESLint couldn't find the config 'progress/recommended'. ↓

cause Using an incorrect config name (e.g., 'progress/recommended' instead of the correct property access).

fix

Use 'progress.configs.recommended' in flat config.

Warnings

breaking ESLint v10 support requires plugin v4.x (currently beta). v3.x does not work with ESLint v10. ↓

fix Use eslint-plugin-file-progress@^4.0.0-beta.1 with ESLint v10, or stick with ESLint v9.

breaking Plugin v2 and later are ESM-only and require ESLint v9 or higher. Node.js require() will fail. ↓

fix Use dynamic import() in CommonJS files or migrate to ESM. ESLint v9+ supports flat config.

breaking In v3.0.0, the 'noCI' config preset was renamed to 'recommended-ci'. The old 'noCI' is no longer available. ↓

fix Use progress.configs['recommended-ci'] instead of progress.configs.noCI.

gotcha The 'progress/activate' rule must be set to severity 1 (warn) or 2 (error) to enable the progress output. Setting it to 0 disables the plugin entirely. ↓

fix Use 'progress/activate': 1 in your config.

gotcha The 'recommended-ci' config automatically hides progress when the CI environment variable is set to 'true'. In environments where CI is not set, you must manually set settings.progress.hide: true. ↓

fix Set settings.progress.hide: true in your config for non-standard CI environments.

Install

npm install eslint-plugin-file-progress

yarn add eslint-plugin-file-progress

pnpm add eslint-plugin-file-progress

Imports

default

wrong

const progress = require('eslint-plugin-file-progress')

correct

import progress from 'eslint-plugin-file-progress'

ESM-only since v2. CommonJS require does not work; use dynamic import if needed.

configs

wrong

import { configs } from 'eslint-plugin-file-progress'

correct

import progress from 'eslint-plugin-file-progress';
export default [progress.configs.recommended]

configs is a property of the default export, not a named export.

rules

wrong

import { rules } from 'eslint-plugin-file-progress'

correct

import progress from 'eslint-plugin-file-progress';
// then use progress.rules['progress/activate']

rules is a property of the default export. Named import of rules is incorrect.

Quickstart

ESLint flat config (eslint.config.js/ts) using the recommended config preset and custom settings.

import progress from 'eslint-plugin-file-progress';

export default [
  progress.configs.recommended,
  {
    name: 'custom-progress',
    rules: {
      'progress/activate': 1,
    },
    settings: {
      progress: {
        hide: false,
        hideFileName: false,
        successMessage: 'Lint done...',
      },
    },
  },
];