@bitfactory/eslint-config 2.0.0 → 3.1.0

package/README.md

@@ -1,17 +1,19 @@
 # @bitfactory/eslint-config
 
-[![NPM package version](https://badgen.net/npm/v/@bitfactory/eslint-config)](https://npmjs.com/package/@bitfactory/eslint-config)
-[![Npm package yearly downloads](https://badgen.net/npm/dy/@bitfactory/eslint-config)](https://npmjs.com/package/@bitfactory/eslint-config)
+[![Release](https://img.shields.io/badge/Release-3.x.x-F0ec73)](https://github.com/bitfactory-nl/shared-npm-eslint-config-bitfactory)
 [![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://lbesson.mit-license.org/)
-[![Minimum Node.js version](https://badgen.net/npm/node/@bitfactory/eslint-config)](https://npmjs.com/package/@bitfactory/eslint-config)
-
-[![Release](https://img.shields.io/badge/Release-2.x.x-F0ec73)](https://github.com/bitfactory-nl/shared-npm-eslint-config-bitfactory)
-![ESLint](https://img.shields.io/badge/ESLint-8.x.x-4B3263?logo=eslint&logoColor=white)
+![ESLint](https://img.shields.io/badge/ESLint-^8.56|^9.0-4B3263?logo=eslint&logoColor=white)
 [![NodeJS](https://img.shields.io/badge/Node.js-^18.18|^20.9-6da55f?logo=node.js)](https://nodejs.org/)
-![PNPM](https://img.shields.io/badge/pnpm-8.x.x-%234a4a4a.svg?logo=pnpm&logoColor=f69220)
 
 This is a shareable config for [ESLint](https://eslint.org). All the rules and configurations are already set. Rules can be overridden if needed.
 
+> [!IMPORTANT]  
+> From ESLint v9 the Flat Config file is the default. Because of this change update the `package.json` npm run scripts!
+>
+> See also the Release Roadmap <https://github.com/bitfactory-nl/shared-npm-eslint-config-bitfactory/issues/83>
+>
+> For now the `eslint` scripts can only be run with the `ESLINT_USE_FLAT_CONFIG=false` environment variable set like this. For examples how to add this to the `package.json`, please check out the [CLI usage documentation](#rocket-cli-usage).
+
 - [@bitfactory/eslint-config](#bitfactoryeslint-config)
   - [:technologist: Development](#technologist-development)
   - [:package: Installing](#package-installing)
@@ -26,11 +28,14 @@ This is a shareable config for [ESLint](https://eslint.org). All the rules and c
 
 ## :technologist: Development
 
-### Publishing a new version
+### Publishing
+
+Before publishing a new version:
 
-1. 💡 Before publishing a new version, make sure to update the version number in the `package.json` file.
-2. Make sure to run `pnpm i` to update the `pnpm-lock.yaml` file afterwards.
-3. In case of a minor/major update, make sure to also update the badge in the `README.md` file.
+1. Update the version number in the `package.json` file.
+2. And also update the badges in the `README.md` file, even for patches.
+3. Create a new release, after merging the PR. This will trigger a workflow.
+4. The GitHub action workflow will then automatically create a new NPM package.
 
 ## :package: Installing
 
@@ -51,7 +56,7 @@ make npx "install-peerdeps --dev --extra-args="-E" @bitfactory/eslint-config"
 ```
 
 ```shell
-make pnpx "install-peerdeps --dev --extra-args="-E" @bitfactory/eslint-config"
+make pnpm dlx "install-peerdeps --dev --extra-args="-E" @bitfactory/eslint-config"
 ```
 
 In your project, create an `.eslintrc.js` file with the following contents:
@@ -154,46 +159,65 @@ module.exports = {
 
 To use ESLint in the command-line, add the following scripts to your projects `package.json`:
 
-> For PNPM use `"eslint:fix": "pnpm run eslint --fix"`
-
 ```json
 "scripts": {
-  "eslint": "eslint 'path/to/your/assets/**/*.{cjs,js,mjs}'",
+  "eslint": "ESLINT_USE_FLAT_CONFIG=false eslint 'path/to/your/assets/**/*.{cjs,js,mjs}'",
   "eslint:fix": "npm run eslint -- --fix"
 }
 ```
 
+```json
+"scripts": {
+  "eslint": "ESLINT_USE_FLAT_CONFIG=false eslint 'path/to/your/assets/**/*.{cjs,js,mjs}'",
+  "eslint:fix": "pnpm run eslint --fix"
+}
+```
+
 To also check Vue.js files:
 
 ```json
 "scripts": {
-  "eslint": "eslint 'path/to/your/assets/**/*.{cjs,js,mjs,vue}'",
+  "eslint": "ESLINT_USE_FLAT_CONFIG=false eslint 'path/to/your/assets/**/*.{cjs,js,mjs,vue}'",
   "eslint:fix": "npm run eslint -- --fix"
 }
 ```
 
+```json
+"scripts": {
+  "eslint": "ESLINT_USE_FLAT_CONFIG=false eslint 'path/to/your/assets/**/*.{cjs,js,mjs,vue}'",
+  "eslint:fix": "pnpm run eslint --fix"
+}
+```
+
 Or TypeScript files:
 
 ```json
 "scripts": {
-  "eslint": "eslint 'path/to/your/assets/**/*.{cjs,js,mjs,ts,tsx}'",
+  "eslint": "ESLINT_USE_FLAT_CONFIG=false eslint 'path/to/your/assets/**/*.{cjs,js,mjs,ts,tsx}'",
   "eslint:fix": "npm run eslint -- --fix"
 }
 ```
 
+```json
+"scripts": {
+  "eslint": "ESLINT_USE_FLAT_CONFIG=false eslint 'path/to/your/assets/**/*.{cjs,js,mjs,ts,tsx}'",
+  "eslint:fix": "pnpm run eslint --fix"
+}
+```
+
 You can run the commands with:
 
 ```shell
-npm run eslint
-npm run eslint:fix
+make npm run eslint
+make npm run eslint:fix
 ```
 
 ```shell
-pnpm run eslint
-pnpm run eslint:fix
+make pnpm run eslint
+make pnpm run eslint:fix
 ```
 
-> With PNPM you can also run script without run like `pnpm eslint`.
+> With PNPM you can also run scripts without 'run' like `make pnpm eslint`.
 
 ## :pencil2: Editor / IDE integration
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bitfactory/eslint-config",
-  "version": "2.0.0",
+  "version": "3.1.0",
   "description": "ESLint sharable config for Bitfactory projects",
   "keywords": [
     "eslint",
@@ -18,29 +18,24 @@
     "vue.js"
   ],
   "devDependencies": {
-    "@babel/core": "7.25.7",
-    "@babel/eslint-parser": "7.25.7",
-    "eslint": "8.57.1",
-    "eslint-plugin-import": "2.31.0",
-    "eslint-plugin-jsdoc": "50.3.1",
-    "eslint-plugin-unicorn": "56.0.0",
+    "eslint": "9.12.0",
     "lint-staged": "15.2.10",
     "npm-check-updates": "17.1.3",
     "simple-git-hooks": "2.11.1"
   },
   "peerDependencies": {
-    "@babel/core": "^7.11.0",
-    "@babel/eslint-parser": "^7.11.0",
-    "eslint": "^8.56.0",
-    "eslint-plugin-import": "^2.25.0",
-    "eslint-plugin-jsdoc": ">=39.0.0",
-    "eslint-plugin-unicorn": ">=50.0.0"
+    "@babel/core": "^7.24.5",
+    "@babel/eslint-parser": "^7.24.5",
+    "eslint": "^8.56.0 || ^9.0.0",
+    "eslint-plugin-import": ">=2.31.0",
+    "eslint-plugin-jsdoc": ">=47.0.0",
+    "eslint-plugin-unicorn": ">=56.0.0"
   },
   "engines": {
     "node": "^18.18.0 || ^20.9.0"
   },
   "scripts": {
-    "eslint": "eslint '**/*.{cjs,js,mjs}'",
+    "eslint": "ESLINT_USE_FLAT_CONFIG=false eslint '**/*.{cjs,js,mjs}'",
     "eslint:fix": "pnpm run eslint --fix",
     "update:interactive": "pnpm exec npm-check-updates -i",
     "update:minor": "pnpm exec npm-check-updates -i -t minor",