feat!: update to eslint flat config

feat: add @IanVS/prettier-plugin-sort-imports

Author: JohnCampionJr

.eslintrc

@@ -12,7 +12,7 @@ jobs:
       issues: write # to be able to comment on released issues
       pull-requests: write # to be able to comment on released pull requests
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: pnpm/action-setup@v2
         with:
           version: 8

.github/workflows/release.yml

@@ -1,6 +1,4 @@
-// prettier.config.js
-// some of these match the current Prettier defaults, but are left in for clarity
-module.exports = {
+export default {
   arrowParens: 'always',
   bracketSameLine: false,
   endOfLine: 'lf',
@@ -9,5 +7,14 @@ module.exports = {
   trailingComma: 'all',
   semi: false,
   singleAttributePerLine: false,
-  plugins: ['prettier-plugin-tailwindcss'],
+  plugins: ['@ianvs/prettier-plugin-sort-imports', 'prettier-plugin-tailwindcss'],
+  tailwindFunctions: ['clsx'],
+  importOrderTypeScriptVersion: '5.0.0',
+  importOrder: [
+    '<BUILT_IN_MODULES>',
+    '<THIRD_PARTY_MODULES>',
+    '^(?!.*[.]css$)[./].*$',
+    '',
+    '.css$',
+  ],
 }

.prettierrc.js

@@ -0,0 +1,3 @@
+{  // Enable the ESlint flat config support
+  "eslint.experimental.useFlatConfig": true,
+}

.vscode/settings.json

@@ -22,22 +22,28 @@ It starts with his vue config and makes these changes:
 pnpm add -D eslint prettier @jcamp/eslint-config
 ```
 
-### Config `.eslintrc`
+### Config `eslint.config.js`
 
-```json
-{
-  "extends": "@jcamp"
-}
+```js
+import config from '@jcamp/eslint-config'
+
+export default config
 ```
 
-> You don't need `.eslintignore` normally as it has been provided by the preset.
+> `.eslintignore` is no longer supported by [eslint flatconfig](https://eslint.org/docs/latest/use/configure/configuration-files-new#globally-ignoring-files-with-ignores).
+
+```js
+config.push({
+  ignores: ['temp.js', '**/vendor/*.js'],
+})
+```
 
 ### Config `.prettierrc.js`
 
 ```js
-const baseConfig = require('@jcamp/eslint-config/.prettierrc.js')
+import baseConfig from '@jcamp/eslint-config/prettier'
 
-module.exports = {
+export default {
   ...baseConfig,
   /* make any changes here */
   singleAttributePerLine: false,
@@ -66,12 +72,15 @@ Create `.vscode/settings.json`
 ```json
 {
   "prettier.enable": true,
+  // Enable the ESlint flat config support
+  "eslint.experimental.useFlatConfig": true,
   "editor.codeActionsOnSave": {
-    "source.fixAll.eslint": true
+    "source.fixAll.eslint": "explicit",
+    "source.organizeImports": "never"
   }
 }
 ```
 
 ## License
 
-[MIT](./LICENSE) License © 2022-PRESENT [John Campion](https://github.com/JohnCampionJr/)
+[MIT](./LICENSE) License © 2023-PRESENT [John Campion](https://github.com/JohnCampionJr/)

README.md

@@ -0,0 +1,3 @@
+import config from './index.js'
+
+export default config

eslint.config.js

@@ -1,6 +1,24 @@
-module.exports = {
-  extends: ['@antfu/eslint-config-vue', 'prettier'],
+import { antfu } from '@antfu/eslint-config'
+import eslintConfigPrettier from 'eslint-config-prettier'
+
+const config = antfu({
+  stylistic: false,
+  vue: true,
+})
+config.push(eslintConfigPrettier)
+
+config.push({
   rules: {
-    'antfu/if-newline': 'off',
+    curly: ['error', 'all'],
+    'vue/html-self-closing': [
+      'error',
+      {
+        html: {
+          void: 'any',
+        },
+      },
+    ],
   },
-}
+})
+
+export default config

index.js

@@ -1,5 +1,6 @@
 {
   "name": "@jcamp/eslint-config",
+  "type": "module",
   "version": "0.8.2",
   "description": "JohnCampionJr's ESLint config",
   "author": "John Campion (https://github.com/JohnCampionJr/)",
@@ -9,10 +10,14 @@
     "eslint-config",
     "prettier"
   ],
+  "exports": {
+    ".": "./index.js",
+    "./prettier": "./.prettierrc.js"
+  },
   "main": "index.js",
   "files": [
-    "index.js",
-    ".prettierrc.js"
+    ".prettierrc.js",
+    "index.js"
   ],
   "scripts": {
     "lint": "eslint .",
@@ -21,16 +26,17 @@
     "clean": "prettier . --write"
   },
   "peerDependencies": {
-    "eslint": ">=8.50.0",
+    "eslint": ">=8.51.0",
     "prettier": ">=3.0.3"
   },
   "dependencies": {
-    "@antfu/eslint-config-vue": "^0.43.1",
-    "eslint-config-prettier": "^8.10.0",
-    "prettier-plugin-tailwindcss": "^0.5.4"
+    "@antfu/eslint-config": "^1.0.0-beta.22",
+    "@ianvs/prettier-plugin-sort-imports": "^4.1.0",
+    "eslint-config-prettier": "^9.0.0",
+    "prettier-plugin-tailwindcss": "^0.5.5"
   },
   "devDependencies": {
-    "eslint": "^8.50.0",
+    "eslint": "^8.51.0",
     "prettier": "^3.0.3"
   }
 }