eslint-plugin-file-progress-2 3.1.0

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2026 Nick2bad4u
+Copyright (c) 2020 Sibiraj
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,110 @@
+# eslint-plugin-file-progress-2
+
+[![Version](https://badgen.net/npm/v/eslint-plugin-file-progress-2)](https://www.npmjs.com/package/eslint-plugin-file-progress-2)
+[![License](https://badgen.net/npm/license/eslint-plugin-file-progress-2?color=red)](https://github.com/Nick2bad4u/eslint-plugin-file-progress-2/blob/master/LICENSE)
+[![Tests](https://github.com/Nick2bad4u/eslint-plugin-file-progress-2/workflows/Tests/badge.svg)](https://github.com/Nick2bad4u/eslint-plugin-file-progress-2/actions)
+
+> ESLint plugin to print file progress
+
+> Fork note: Originally created by [@sibiraj-s](https://github.com/sibiraj-s) in [`eslint-plugin-file-progress`](https://github.com/sibiraj-s/eslint-plugin-file-progress). Huge thanks for the original plugin.
+
+## Getting Started
+
+### Installation
+
+```bash
+npm i -D eslint-plugin-file-progress-2
+# or
+yarn add --dev eslint-plugin-file-progress-2
+```
+
+### Usage
+
+```js
+// eslint.config.js
+import progress from "eslint-plugin-file-progress-2";
+
+export default [
+    {
+        name: "progress",
+        plugins: {
+            "file-progress": progress,
+        },
+        rules: {
+            "file-progress/activate": "warn",
+        },
+        settings: {
+            progress: {
+                hide: false, // hide progress output (useful in CI)
+                hideFileName: false, // show generic "Linting..." instead of file names
+                successMessage: "Lint done...",
+            },
+        },
+    },
+];
+```
+
+Or use the recommended config
+
+```js
+// eslint.config.js
+import progress from "eslint-plugin-file-progress-2";
+
+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-2";
+
+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: warn'
+```
+
+Or, in your package.json's command:
+
+```diff
+{
+  "scripts": {
+-    "lint": "eslint .",
++    "lint": "eslint . --plugin file-progress --rule \"file-progress/activate: warn\""
+  }
+}
+```
+
+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
+
+## Development
+
+This project is authored in TypeScript (`src/**`) and publishes compiled artifacts from `dist/**`.
+Linting uses `@typescript-eslint/eslint-plugin` with the flat `recommended-type-checked` config.
+
+```bash
+npm run lint
+npm run typecheck
+npm run test
+npm run build
+npm run format
+npm run check
+npm run publint
+npm run release:verify
+```

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+import type { FileProgressPlugin } from "./types.js";
+declare const plugin: FileProgressPlugin;
+export type { FileProgressPlugin, ProgressSettings } from "./types.js";
+export default plugin;

package/dist/index.js

@@ -0,0 +1,39 @@
+import progressRule from "./rules/progress.js";
+const env = process.env;
+const plugin = {
+    meta: {
+        name: "eslint-plugin-file-progress-2",
+        version: "3.0.2",
+    },
+    configs: {},
+    rules: {
+        activate: progressRule,
+    },
+};
+const configs = {
+    recommended: {
+        name: "file-progress/recommended",
+        plugins: {
+            "file-progress": plugin,
+        },
+        rules: {
+            "file-progress/activate": "warn",
+        },
+    },
+    "recommended-ci": {
+        name: "file-progress/recommended-ci",
+        plugins: {
+            "file-progress": plugin,
+        },
+        rules: {
+            "file-progress/activate": "warn",
+        },
+        settings: {
+            progress: {
+                hide: env.CI === "true",
+            },
+        },
+    },
+};
+Object.assign(plugin.configs, configs);
+export default plugin;

package/dist/rules/progress.d.ts

@@ -0,0 +1,17 @@
+import type { Rule } from "eslint";
+export interface NormalizedProgressSettings {
+    hide: boolean;
+    hideFileName: boolean;
+    successMessage: string;
+}
+export interface ProgressInternals {
+    defaultSettings: Readonly<NormalizedProgressSettings>;
+    normalizeSettings: (raw: unknown) => NormalizedProgressSettings;
+    toRelativeFilePath: (filename: string, cwd: string) => string;
+    formatFileProgress: (relativeFilePath: string) => string;
+    formatGenericProgress: () => string;
+    formatSuccessMessage: (settings: NormalizedProgressSettings) => string;
+}
+declare const progressRule: Rule.RuleModule;
+export declare const internals: ProgressInternals;
+export default progressRule;

package/dist/rules/progress.js

@@ -0,0 +1,109 @@
+import path from "node:path";
+import { createSpinner } from "nanospinner";
+import pc from "picocolors";
+const spinner = createSpinner("", {
+    frames: ["|", "/", "-", "\\"],
+    color: "cyan",
+});
+const defaultSettings = Object.freeze({
+    hide: false,
+    hideFileName: false,
+    successMessage: "Lint complete.",
+});
+const pluginPrefix = `${pc.bold(pc.cyan("eslint-file-progress"))} ${pc.dim("•")}`;
+let isExitHandlerBound = false;
+let initialReportDone = false;
+let lastVisibleSettings = { ...defaultSettings };
+const isRecord = (value) => typeof value === "object" && value !== null;
+const normalizeSettings = (raw) => {
+    if (!isRecord(raw)) {
+        return { ...defaultSettings };
+    }
+    const typedRaw = raw;
+    const hide = typedRaw.hide === true;
+    const hideFileName = typedRaw.hideFileName === true;
+    const successMessage = typeof typedRaw.successMessage === "string" && typedRaw.successMessage.trim().length > 0
+        ? typedRaw.successMessage.trim()
+        : defaultSettings.successMessage;
+    return {
+        hide,
+        hideFileName,
+        successMessage,
+    };
+};
+const toRelativeFilePath = (filename, cwd) => {
+    if (!filename || filename === "<input>") {
+        return filename || "<input>";
+    }
+    const isWindowsAbsolutePath = path.win32.isAbsolute(filename);
+    const isNativeAbsolutePath = path.isAbsolute(filename);
+    if (!isNativeAbsolutePath && !isWindowsAbsolutePath) {
+        return filename;
+    }
+    const effectiveCwd = cwd || process.cwd();
+    const relativePath = isWindowsAbsolutePath
+        ? path.win32.relative(effectiveCwd, filename)
+        : path.relative(effectiveCwd, filename);
+    if (relativePath.length === 0) {
+        return isWindowsAbsolutePath ? path.win32.basename(filename) : path.basename(filename);
+    }
+    return relativePath;
+};
+const formatFileProgress = (relativeFilePath) => `${pluginPrefix} ${pc.dim("linting")} ${pc.green(relativeFilePath)}`;
+const formatGenericProgress = () => `${pluginPrefix} ${pc.dim("linting project files...")}`;
+const formatSuccessMessage = (settings) => `${pluginPrefix} ${pc.bold(pc.green("✔"))} ${pc.green(settings.successMessage)}`;
+const bindExitHandler = () => {
+    if (isExitHandlerBound) {
+        return;
+    }
+    process.once("exit", (exitCode) => {
+        if (exitCode === 0 && lastVisibleSettings.hide !== true) {
+            spinner.success({ text: formatSuccessMessage(lastVisibleSettings) });
+        }
+    });
+    isExitHandlerBound = true;
+};
+const create = (context) => {
+    const settings = normalizeSettings(context.settings?.progress);
+    bindExitHandler();
+    if (settings.hide) {
+        return {};
+    }
+    lastVisibleSettings = settings;
+    if (settings.hideFileName) {
+        if (!initialReportDone) {
+            spinner.update({ text: formatGenericProgress() });
+            initialReportDone = true;
+        }
+    }
+    else {
+        const relativeFilePath = toRelativeFilePath(context.filename, context.cwd);
+        spinner.update({ text: formatFileProgress(relativeFilePath) });
+    }
+    spinner.spin();
+    return {};
+};
+const progressRule = {
+    meta: {
+        type: "suggestion",
+        docs: {
+            description: "enforce displaying lint progress in CLI output.",
+            recommended: true,
+            url: "https://github.com/Nick2bad4u/eslint-plugin-file-progress-2#readme",
+        },
+        schema: [],
+        messages: {
+            status: "Display lint progress in CLI output.",
+        },
+    },
+    create,
+};
+export const internals = {
+    defaultSettings,
+    normalizeSettings,
+    toRelativeFilePath,
+    formatFileProgress,
+    formatGenericProgress,
+    formatSuccessMessage,
+};
+export default progressRule;

package/dist/types.d.ts

@@ -0,0 +1,19 @@
+import type { Linter, Rule } from "eslint";
+export interface ProgressSettings {
+    hide?: boolean;
+    hideFileName?: boolean;
+    successMessage?: string;
+}
+export interface FileProgressPlugin {
+    meta: {
+        name: "eslint-plugin-file-progress-2";
+        version: string;
+    };
+    configs: {
+        recommended: Linter.Config;
+        "recommended-ci": Linter.Config;
+    };
+    rules: {
+        activate: Rule.RuleModule;
+    };
+}

package/dist/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,95 @@
+{
+    "name": "eslint-plugin-file-progress-2",
+    "description": "ESLint plugin to print file progress",
+    "version": "3.1.0",
+    "license": "MIT",
+    "author": "Nick2bad4u",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/Nick2bad4u/eslint-plugin-file-progress-2.git"
+    },
+    "bugs": "https://github.com/Nick2bad4u/eslint-plugin-file-progress-2/issues",
+    "homepage": "https://github.com/Nick2bad4u/eslint-plugin-file-progress-2#readme",
+    "type": "module",
+    "main": "./dist/index.js",
+    "exports": {
+        ".": {
+            "types": "./dist/index.d.ts",
+            "import": "./dist/index.js",
+            "default": "./dist/index.js"
+        }
+    },
+    "types": "./dist/index.d.ts",
+    "keywords": [
+        "eslint",
+        "eslintplugin",
+        "eslint-plugin",
+        "eslint-plugin-file-progress",
+        "eslint-plugin-file-progress-2",
+        "eslint-progress",
+        "progress"
+    ],
+    "publishConfig": {
+        "provenance": true,
+        "access": "public"
+    },
+    "files": [
+        "dist/"
+    ],
+    "contributors": [
+        {
+            "name": "sibiraj-s",
+            "url": "https://github.com/sibiraj-s"
+        },
+        {
+            "name": "Nick2bad4u",
+            "url": "https://github.com/Nick2bad4u"
+        }
+    ],
+    "readme": "README.md",
+    "prettier": "./.prettierrc.json",
+    "displayName": "eslint-plugin-file-progress-2",
+    "scripts": {
+        "clean": "rimraf dist .cache/tsbuildinfo/tsconfig.build.tsbuildinfo",
+        "build": "npm run clean && tsc -p tsconfig.build.json",
+        "prelint": "npm run build",
+        "typecheck": "tsc -p tsconfig.json",
+        "lint": "eslint .",
+        "test": "tsx --test test/progress.test.ts",
+        "publint": "publint",
+        "format": "prettier --write .",
+        "format:check": "prettier --check .",
+        "check": "npm run lint && npm run typecheck && npm run test && npm run format:check",
+        "release:verify": "npm run check && npm run publint",
+        "release:publish": "npm run build && changeset publish",
+        "prepack": "npm run build"
+    },
+    "engines": {
+        "node": ">=22.0.0"
+    },
+    "peerDependencies": {
+        "eslint": "^9.0.0 || ^10.0.2"
+    },
+    "dependencies": {
+        "nanospinner": "^1.2.2",
+        "picocolors": "^1.1.1"
+    },
+    "devDependencies": {
+        "@changesets/cli": "^2.29.8",
+        "@commitlint/cli": "^20.4.2",
+        "@commitlint/config-conventional": "^20.4.2",
+        "@types/node": "^25.3.0",
+        "@typescript-eslint/eslint-plugin": "^8.56.1",
+        "@typescript-eslint/parser": "^8.56.1",
+        "eslint": "^10.0.2",
+        "eslint-config-pegasus": "^6.0.2",
+        "eslint-plugin-eslint-plugin": "^7.3.1",
+        "husky": "^9.1.7",
+        "is-ci": "^4.1.0",
+        "prettier": "^3.8.1",
+        "publint": "^0.3.17",
+        "rimraf": "^6.1.3",
+        "tsx": "^4.21.0",
+        "typescript": "^5.9.3"
+    }
+}