# eslint-plugin-file-progress

> Eslint plugin to print file progress

Latest version **4.0.0-beta.1** (published 2026-03-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install eslint-plugin-file-progress
pnpm add eslint-plugin-file-progress
yarn add eslint-plugin-file-progress
bun add eslint-plugin-file-progress
```

## Health

**Score 65/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; has provenance; high quality score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 4.0.0-beta.1 |
| Published | 2026-03-30 |
| First published | 2020-08-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | ^20.19.0 \|\| ^22.13.0 \|\| >=24.0.0 |
| Dependencies | 2 |
| Unpacked size | 9.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 39 |
| Author | sibiraj-s |
| Maintainers | sibiraj-s |
| Keywords | eslint, eslint-plugin, eslint-plugin-file-progress, eslint-progress, eslintplugin, progress |

## Links

- npm: https://www.npmjs.com/package/eslint-plugin-file-progress
- Repository: https://github.com/sibiraj-s/eslint-plugin-file-progress
- Homepage: https://github.com/sibiraj-s/eslint-plugin-file-progress#readme
- Issues: https://github.com/sibiraj-s/eslint-plugin-file-progress/issues
- npm.io page: https://npm.io/package/eslint-plugin-file-progress

## Dependencies (2)

- [picocolors](https://npm.io/package/picocolors.md) ^1.1.1
- [nanospinner](https://npm.io/package/nanospinner.md) ^1.2.2

## Alternatives

- [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads
- [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads
- [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads
- [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads
- [@inrupt/eslint-config-base](https://npm.io/package/@inrupt/eslint-config-base.md) — 4.5K weekly downloads

## Recent versions

- 4.0.0-beta.1 (latest) — 2026-03-30
- 4.0.0 — 2026-03-29
- 3.0.2 — 2025-03-17
- 3.0.1 — 2024-11-09
- 3.0.0 — 2024-11-04
- 2.1.2 — 2024-11-04
- 2.1.1 — 2024-11-04
- 2.1.0 — 2024-11-04
- 2.0.1 — 2024-11-04
- 2.0.0 — 2024-11-04
- 1.5.0 — 2024-08-12
- 1.4.0 — 2024-05-11
- 1.3.0 — 2022-06-27
- 1.2.1 — 2022-06-01
- 1.2.0 — 2021-10-18
- … 3 more at https://npm.io/package/eslint-plugin-file-progress/versions

## README

# eslint-plugin-file-progress

[![Version](https://badgen.net/npm/v/eslint-plugin-file-progress)](https://www.npmjs.com/package/eslint-plugin-file-progress)
[![Version](https://badgen.net/npm/license/eslint-plugin-file-progress?color=red)](https://github.com/sibiraj-s/eslint-plugin-file-progress/blob/master/LICENSE)
[![Tests](https://github.com/sibiraj-s/eslint-plugin-file-progress/workflows/Tests/badge.svg)](https://github.com/sibiraj-s/eslint-plugin-file-progress/actions)

> Eslint plugin to print file progress

## Getting Started

### Installation

```bash
npm i -D eslint-plugin-file-progress
# or
yarn add --dev eslint-plugin-file-progress
```

### Usage

```js
// eslint.config.js

{
  name: 'progress',
  plugins: {
    progress
  },
  rules: {
    "progress/activate": 1
  },
  settings: {
    progress: {
      hide: false, // use this to hide the progress message, can be useful in CI
      hideFileName: false, // use this to hide the file name, would simply show "Linting..."
      successMessage: "Lint done..."
    }
  }
}
```

Or use the recommended config

```js
// eslint.config.js
import progress from 'eslint-plugin-file-progress';

export default [progress.configs.recommended];
```

or if you want to hide the progress message in CI

```js
// eslint.config.js
import progress from 'eslint-plugin-file-progress';

export default [progress.configs['recommended-ci']];
```

This configuration is similar to the recommended one, but it automatically detects CI environments by checking if the `CI` environment variable is set to `true`, and hides the progress message accordingly.

For CI's where CI is not set to `true`, you can use the `settings.progress.hide` option to hide the progress message.

### Demo

Who likes a silent console ¯\\\_(ツ)\_/¯

![Progress](assets/progress.gif)

### Only on CLI

Some eslint plugins for code editors may conflict with this plugin rule (or, in that context, a file progress is not relevant)

```bash
npx eslint . --plugin file-progress --rule 'file-progress/activate: 1'
```

Or, in your package.json's command:

```diff
{
  "scripts: [
-    "lint": "eslint ."
+    "lint": "eslint . --plugin file-progress --rule \"file-progress/activate: 1\""
  ]
}
```

Use `file-progress/activate: 0` to disable the plugin. See https://eslint.org/docs/latest/user-guide/command-line-interface#specifying-rules-and-plugins for more details on how to use CLI

---
_Source: https://npm.io/package/eslint-plugin-file-progress · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._