v2: Flat config support, formatter function & ESM [publish]

nabla · Nov 18, 2023 · 4105adb · 4105adb
1 parent d2312d5
commit 4105adb
Show file tree

Hide file tree

Showing 17 changed files with 1,087 additions and 63 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,12 @@
 # Changelog
 
+## 2.0.0
+
+- Support ESLint flat config (fixes [#23](https://github.com/nabla/vite-plugin-eslint/issues/23))
+- Support passing a function to formatter
+- Switch to ESM. This removes the CJS warning when using the plugin with Vite 5. A CJS wrapper is still provided but [migrating](https://vitejs.dev/guide/migration.html#deprecate-cjs-node-api) to running Vite in ESM is encouraged
+- Drop support for Vite 2 & 3 & node<18 (aligns with Vite 5)
+
 ## 1.6.0
 
 - Add vite@5 to peer dependency range

diff --git a/README.md b/README.md
@@ -44,6 +44,7 @@ You can use `DEBUG=eslint node_modules/.bin/vite` to debug this option (availabl
 
 ### formatter
 
-- Type: `string`
+- Type: `string | ((result: ESLint.LintResult) => void)`
+- Default: Custom format with one line per warning/error.
 
-If provided, the value is passed to `eslint.loadFormatter`. Default to a custom format with one line per warning/error. Use `stylish` to get a CRA like output. Async formatters are supported in `1.5.0`.
+If provided, the value is passed to `eslint.loadFormatter`. Use `stylish` to get a CRA like output. Async formatters are supported in `1.5.0`. Function support was added in `1.7.0`.
diff --git a/package.json b/package.json
@@ -1,10 +1,20 @@
 {
   "name": "@nabla/vite-plugin-eslint",
   "description": "Plugs ESLint into Vite dev server",
-  "version": "1.6.0",
+  "version": "2.0.1",
   "license": "MIT",
   "author": "Arnaud Barré (https://github.com/ArnaudBarre)",
-  "main": "src/index.js",
+  "type": "module",
+  "main": "src/index.cjs",
+  "types": "src/index.d.ts",
+  "module": "src/index.mjs",
+  "exports": {
+    ".": {
+      "types": "./src/index.d.ts",
+      "require": "./src/index.cjs",
+      "import": "./src/index.mjs"
+    }
+  },
   "files": [
     "src"
   ],
@@ -22,11 +32,11 @@
     "chalk": "^4"
   },
   "peerDependencies": {
-    "vite": "^2 || ^3 || ^4 || ^5",
-    "eslint": "*"
+    "eslint": "*",
+    "vite": "^4 || ^5"
   },
   "devDependencies": {
-    "eslint": "^8.53.0",
+    "eslint": "^8.54.0",
     "prettier": "3.0.3",
     "vite": "^5.0.0"
   }

diff --git a/playground/.eslintrc.cjs b/playground/.eslintrc.cjs
@@ -0,0 +1,9 @@
+module.exports = {
+  parserOptions: {
+    ecmaVersion: "latest",
+    sourceType: "module",
+  },
+  rules: {
+    "prefer-const": "error",
+  },
+};
diff --git a/playground/eslint.config.js b/playground/eslint.config.js
@@ -0,0 +1,7 @@
+export default [
+  {
+    rules: {
+      "prefer-const": "error",
+    },
+  },
+];
diff --git a/playground/index.html b/playground/index.html
@@ -0,0 +1,13 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" type="image/svg+xml" href="/vite.svg" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Vite App</title>
+  </head>
+  <body>
+    <div id="app"></div>
+    <script type="module" src="/src/main.js"></script>
+  </body>
+</html>
diff --git a/playground/package.json b/playground/package.json
@@ -0,0 +1,13 @@
+{
+  "name": "playground",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "dev": "vite --open",
+    "dev:cjs": "vite --open --config vite.config.cjs"
+  },
+  "devDependencies": {
+    "eslint": "^8.54.0",
+    "vite": "^5.0.0"
+  }
+}
diff --git a/playground/src/main.js b/playground/src/main.js
@@ -0,0 +1,2 @@
+console.log("Hello");
+let a = 4;
diff --git a/playground/vite.config.cjs b/playground/vite.config.cjs
@@ -0,0 +1,5 @@
+const eslint = require("..");
+
+module.exports = {
+  plugins: [eslint()],
+};
diff --git a/playground/vite.config.js b/playground/vite.config.js
@@ -0,0 +1,9 @@
+import eslint from "..";
+
+export default {
+  plugins: [
+    eslint({
+      formatter: console.log,
+    }),
+  ],
+};