@thedanbob/esbuild-plugin-eslint 0.3.13

package/dist/index.cjs

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const eslint_1 = require("eslint");
+exports.default = ({ filter = /\.(?:jsx?|tsx?|mts|cts|mjs|cjs|vue|svelte)$/, throwOnWarning = false, throwOnError = false, ...eslintOptions } = {}) => ({
+    name: "eslint",
+    setup: async ({ onStart, onLoad, onEnd }) => {
+        const eslint = new eslint_1.ESLint(eslintOptions);
+        const formatter = await eslint.loadFormatter();
+        const filesToLint = [];
+        onStart(() => {
+            // Clear list of files from previous run in watch mode
+            filesToLint.splice(0);
+        });
+        onLoad({ filter }, ({ path }) => {
+            if (!path.includes("node_modules")) {
+                filesToLint.push(path);
+            }
+        });
+        onEnd(async () => {
+            const results = await eslint.lintFiles(filesToLint);
+            const output = await formatter.format(results);
+            const warnings = results.reduce((count, result) => count + result.warningCount, 0);
+            const errors = results.reduce((count, result) => count + result.errorCount, 0);
+            if (eslintOptions.fix) {
+                await eslint_1.ESLint.outputFixes(results);
+            }
+            if (output.length > 0) {
+                console.log(output);
+            }
+            const errorsList = [];
+            throwOnWarning && warnings > 0 && errorsList.push({ text: `${warnings} warnings were found by eslint!` });
+            throwOnError && errors > 0 && errorsList.push({ text: `${errors} errors were found by eslint!` });
+            return {
+                ...errorsList.length > 0 && {
+                    errors: errorsList
+                }
+            };
+        });
+    }
+});

package/dist/index.d.ts

@@ -0,0 +1,18 @@
+import type { Plugin } from "esbuild";
+import { ESLint } from "eslint";
+interface Options extends ESLint.Options {
+    /**
+     * tells esbuild what files to look at; only matches will be processed
+     */
+    filter?: RegExp;
+    /**
+     * controls whether or not to forward an error to esbuild when eslint reports any warnings
+     */
+    throwOnWarning?: boolean;
+    /**
+     * controls whether or not to forward an error to esbuild when eslint reports any errors
+     */
+    throwOnError?: boolean;
+}
+declare const _default: ({ filter, throwOnWarning, throwOnError, ...eslintOptions }?: Options) => Plugin;
+export default _default;

package/dist/index.mjs

@@ -0,0 +1,38 @@
+import { ESLint } from "eslint";
+export default ({ filter = /\.(?:jsx?|tsx?|mts|cts|mjs|cjs|vue|svelte)$/, throwOnWarning = false, throwOnError = false, ...eslintOptions } = {}) => ({
+    name: "eslint",
+    setup: async ({ onStart, onLoad, onEnd }) => {
+        const eslint = new ESLint(eslintOptions);
+        const formatter = await eslint.loadFormatter();
+        const filesToLint = [];
+        onStart(() => {
+            // Clear list of files from previous run in watch mode
+            filesToLint.splice(0);
+        });
+        onLoad({ filter }, ({ path }) => {
+            if (!path.includes("node_modules")) {
+                filesToLint.push(path);
+            }
+        });
+        onEnd(async () => {
+            const results = await eslint.lintFiles(filesToLint);
+            const output = await formatter.format(results);
+            const warnings = results.reduce((count, result) => count + result.warningCount, 0);
+            const errors = results.reduce((count, result) => count + result.errorCount, 0);
+            if (eslintOptions.fix) {
+                await ESLint.outputFixes(results);
+            }
+            if (output.length > 0) {
+                console.log(output);
+            }
+            const errorsList = [];
+            throwOnWarning && warnings > 0 && errorsList.push({ text: `${warnings} warnings were found by eslint!` });
+            throwOnError && errors > 0 && errorsList.push({ text: `${errors} errors were found by eslint!` });
+            return {
+                ...errorsList.length > 0 && {
+                    errors: errorsList
+                }
+            };
+        });
+    }
+});

package/license

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Robin Löffel
+
+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/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "@thedanbob/esbuild-plugin-eslint",
+  "version": "0.3.13",
+  "description": "Lint your esbuild bundles with ESLint. 🧐",
+  "keywords": [
+    "esbuild",
+    "plugin",
+    "esbuild-plugin",
+    "eslint",
+    "lint"
+  ],
+  "homepage": "https://github.com/thedanbob/esbuild-plugin-eslint",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/thedanbob/esbuild-plugin-eslint.git"
+  },
+  "license": "MIT",
+  "author": "Dan Arnfield <npm@thedanbob.com>",
+  "type": "module",
+  "exports": {
+    "types": "./dist/index.d.ts",
+    "import": "./dist/index.mjs",
+    "require": "./dist/index.cjs"
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "src",
+    "dist"
+  ],
+  "scripts": {
+    "build": "concurrently npm:build:* -m 1",
+    "build:cjs": "tsc --project tsconfig.cjs.json && mv dist/index.js dist/index.cjs",
+    "build:mjs": "tsc --project tsconfig.mjs.json && mv dist/index.js dist/index.mjs",
+    "build:types": "tsc --project tsconfig.types.json",
+    "clean": "rm -rf dist",
+    "prepack": "npm run clean && npm run build",
+    "start": "npm run clean && npm run build && npm run watch",
+    "watch": "concurrently npm:watch:*",
+    "watch:build": "chokidar 'source/**/*' -c 'npm run build' --initial",
+    "watch:test": "chokidar 'test/**/*' -c 'node test/esbuild.js' --initial"
+  },
+  "devDependencies": {
+    "@tsconfig/strictest": "^2.0.3",
+    "@types/eslint": "^8.56.5",
+    "chokidar-cli": "^3.0.0",
+    "concurrently": "^8.2.2",
+    "esbuild": ">=0.20",
+    "eslint": "^8 || ^9",
+    "eslint-config-sweet": "^19.0.2",
+    "eslint-define-config": "^2.1.0",
+    "typescript": "^5.4.2"
+  },
+  "peerDependencies": {
+    "esbuild": ">=0.20",
+    "eslint": "^8 || ^9"
+  },
+  "engines": {
+    "node": ">=18"
+  }
+}

package/readme.md

@@ -0,0 +1,85 @@
+# `esbuild-plugin-eslint`
+
+[![latest version on npm](https://img.shields.io/npm/v/esbuild-plugin-eslint)](https://www.npmjs.com/package/esbuild-plugin-eslint)
+[![npm downloads a week](https://img.shields.io/npm/dw/esbuild-plugin-eslint)](https://www.npmjs.com/package/esbuild-plugin-eslint)
+[![required node version](https://img.shields.io/node/v/esbuild-plugin-eslint)](https://github.com/nodejs/Release)
+[![esbuild peer dep](https://img.shields.io/npm/dependency-version/esbuild-plugin-eslint/peer/esbuild?label=esbuild%20peer%20dep)](https://github.com/evanw/esbuild)
+[![eslint peer dep](https://img.shields.io/npm/dependency-version/esbuild-plugin-eslint/peer/eslint?label=eslint%20peer%20dep)](https://github.com/eslint/eslint)
+[![package license](https://img.shields.io/npm/l/esbuild-plugin-eslint)](license)
+
+> Lint your [`esbuild`](https://github.com/evanw/esbuild) bundles with [`eslint`](https://github.com/eslint/eslint). 🧐
+
+Nicely integrates the most recent version of [`eslint`](https://github.com/eslint/eslint) into an [`esbuild`](https://github.com/evanw/esbuild) plugin.
+
+## How
+
+```bash
+npm i esbuild-plugin-eslint eslint --save-dev
+```
+
+```js
+import { build } from 'esbuild';
+import eslint from 'esbuild-plugin-eslint';
+
+await build({
+  // ...
+  plugins: [
+    eslint({ /* config */ })
+  ]
+});
+```
+
+```bash
+node esbuild.config.js
+```
+
+## Config
+
+This plugin respects your [ESLint configuration](https://eslint.org/docs/user-guide/configuring) as per default. It also takes a configuration object intended for the [ESLint constructor](https://eslint.org/docs/latest/developer-guide/nodejs-api#parameters) with the addition of a `filter`, `throwOnError`, and `throwOnWarning` property. The most important options are:
+
+### `filter`
+
+Type: `RegExp`<br>
+Default: `/\.(?:jsx?|tsx?|mts|cts|mjs|cjs|vue|svelte)$/`<br>
+Used by: [`esbuild`](https://github.com/evanw/esbuild)<br>
+Reference: [esbuild.github.io](https://esbuild.github.io/plugins/#on-load-options)
+
+Tells esbuild what files to look at. Only files matching this pattern will be handled by the plugin.
+
+### `throwOnError`
+
+Type: `boolean`<br>
+Default: `false`<br>
+Used by: [The plugin itself](https://github.com/robinloeffel/esbuild-plugin-eslint)<br>
+
+Instructs the plugin to forward errors found by ESLint to esbuild and throw an error.
+
+### `throwOnWarning`
+
+Type: `boolean`<br>
+Default: `false`<br>
+Used by: [The plugin itself](https://github.com/robinloeffel/esbuild-plugin-eslint)<br>
+
+Instructs the plugin to forward warnings found by ESLint to esbuild and throw an error.
+
+### `fix`
+
+Type: `boolean`<br>
+Default: `false`<br>
+Used by: [`eslint`](https://github.com/eslint/eslint)<br>
+Reference: [eslint.org (`options.fix`)](https://eslint.org/docs/latest/developer-guide/nodejs-api#parameters)<br>
+
+Controls whether to enable or disable the autofix feature of ESLint.
+
+### `useEslintrc`
+
+Type: `boolean`<br>
+Default: `true`<br>
+Used by: [`eslint`](https://github.com/eslint/eslint)<br>
+Reference: [eslint.org (`options.useEslintrc`)](https://eslint.org/docs/latest/developer-guide/nodejs-api#parameters)<br>
+
+If set to `false`, ESLint will not respect any configuration files it finds.
+
+## License
+
+MIT

package/src/index.ts

@@ -0,0 +1,70 @@
+import type { OnLoadArgs, Plugin } from "esbuild";
+import { ESLint } from "eslint";
+
+interface Options extends ESLint.Options {
+  /**
+   * tells esbuild what files to look at; only matches will be processed
+   */
+  filter?: RegExp;
+
+  /**
+   * controls whether or not to forward an error to esbuild when eslint reports any warnings
+   */
+  throwOnWarning?: boolean;
+
+  /**
+   * controls whether or not to forward an error to esbuild when eslint reports any errors
+   */
+  throwOnError?: boolean;
+}
+
+export default ({
+  filter = /\.(?:jsx?|tsx?|mts|cts|mjs|cjs|vue|svelte)$/,
+  throwOnWarning = false,
+  throwOnError = false,
+  ...eslintOptions
+}: Options = {}): Plugin => ({
+  name: "eslint",
+  setup: async ({ onStart, onLoad, onEnd }) => {
+    const eslint = new ESLint(eslintOptions);
+    const formatter = await eslint.loadFormatter();
+    const filesToLint: OnLoadArgs["path"][] = [];
+
+    onStart(() => {
+      // Clear list of files from previous run in watch mode
+      filesToLint.splice(0);
+    });
+
+    onLoad({ filter }, ({ path }): undefined => {
+      if (!path.includes("node_modules")) {
+        filesToLint.push(path);
+      }
+    });
+
+    onEnd(async() => {
+      const results = await eslint.lintFiles(filesToLint);
+      const output = await formatter.format(results);
+
+      const warnings = results.reduce((count, result) => count + result.warningCount, 0);
+      const errors = results.reduce((count, result) => count + result.errorCount, 0);
+
+      if (eslintOptions.fix) {
+        await ESLint.outputFixes(results);
+      }
+
+      if (output.length > 0) {
+        console.log(output);
+      }
+
+      const errorsList = [];
+      throwOnWarning && warnings > 0 && errorsList.push({ text: `${warnings} warnings were found by eslint!` });
+      throwOnError && errors > 0 && errorsList.push({ text: `${errors} errors were found by eslint!` });
+
+      return {
+        ...errorsList.length > 0 && {
+          errors: errorsList
+        }
+      };
+    });
+  }
+});