feat!: flat config (#1)

.gitignore

@@ -1 +1,2 @@
 node_modules
+dist

.vim/coc-settings.json

@@ -1,4 +1,5 @@
 {
+  "eslint.experimental.useFlatConfig": true,
   "eslint.autoFixOnSave": true,
   "eslint.validate": [
     "javascript",
@@ -11,5 +12,8 @@
     "json",
     "jsonc",
     "yaml"
+  ],
+  "eslint.rules.customizations": [
+    { "rule": "auvred/prettier", "severity": "off" }
   ]
 }

.vscode/settings.json

@@ -1,10 +1,10 @@
 {
+  "eslint.experimental.useFlatConfig": true,
   "prettier.enable": false,
   "editor.formatOnSave": false,
   "editor.codeActionsOnSave": {
-    "source.addMissingImports": true,
-    "source.fixAll.eslint": true,
-    "source.organizeImports": false
+    "source.fixAll.eslint": "explicit",
+    "source.organizeImports": "never"
   },
   "eslint.validate": [
     "javascript",
@@ -17,5 +17,8 @@
     "json",
     "jsonc",
     "yaml"
+  ],
+  "eslint.rules.customizations": [
+    { "rule": "auvred/prettier", "severity": "off" }
   ]
 }

README.md

@@ -1,14 +1,13 @@
 # @auvred/eslint-config
 
-> Some code snippets were taken from these awesome repos: [`@so1ve/eslint-config`](https://github.com/so1ve/eslint-config), [`@antfu/eslint-config`](https://github.com/antfu/eslint-config)
+> Partially based on these awesome configs: [`@so1ve/eslint-config`](https://github.com/so1ve/eslint-prettier-config), [`@antfu/eslint-config`](https://github.com/antfu/eslint-config)
 
 ## Features
 
 - Single quotes, no semi, trailing commas
 - Formatting with [Prettier](https://github.com/prettier/prettier)
 - Typescript and Vue support out-of-box
 - Sortable imports
-- Lint also for html, json, yaml, markdown
 
 ## Usage
 
@@ -18,44 +17,41 @@
 pnpm add -D @auvred/eslint-config eslint prettier
 ```
 
-### Config `.eslintrc`
+### Config `eslint.config.js`
 
-```jsonc
-{
-  // don't forget to mark the root config as root
-  "root": true,
-  "extends": "@auvred"
-}
-```
-
-> You don't need .eslintignore normally as it has been provided by the preset.
+In ESM projects:
 
-## Extra configs
+```js
+import { auvred } from '@auvred/eslint-config'
 
-### `@auvred/eslint-config/pnpm-workspace`
-
-This config is intended to be used in monorepositories based on [`pnpm`](https://github.com/pnpm/pnpm)
+export default auvred()
+```
 
-It finds `pnpm-workspace.yaml` in the root of the project, resolves the packages listed there and puts:
+In CJS projects:
 
-- found tsconfigs to the [typescript imports resolver](https://github.com/import-js/eslint-import-resolver-typescript) in the [`import/resolver`](https://github.com/import-js/eslint-plugin-import#importresolver)
-- project package names scope to the [`import/internal-regex`](https://github.com/import-js/eslint-plugin-import#importinternal-regex)
+```js
+module.exports = (async () => {
+  const { auvred } = await import('@auvred/eslint-config')
 
-```jsonc
-{
-  "extends": ["@auvred", "@auvred/eslint-config/pnpm-workspace"]
-}
+  return auvred()
+})()
 ```
 
 ## Configure your editor
 
-### coc.nvim
+### VS Code
 
-Install [`coc-eslint`](https://github.com/neoclide/coc-eslint) extension
+Install [`dbaeumer.vscode-eslint`](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) extension
 
-```jsonc
+```json
 {
-  "eslint.autoFixOnSave": true,
+  "eslint.experimental.useFlatConfig": true,
+  "prettier.enable": false,
+  "editor.formatOnSave": false,
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": "explicit",
+    "source.organizeImports": "never"
+  },
   "eslint.validate": [
     "javascript",
     "javascriptreact",
@@ -67,25 +63,23 @@ Install [`coc-eslint`](https://github.com/neoclide/coc-eslint) extension
     "json",
     "jsonc",
     "yaml"
+  ],
+  "eslint.rules.customizations": [
+    { "rule": "auvred/prettier", "severity": "off" }
   ]
 }
 ```
 
-> It's better to put these settings to workspace settings (`.vim/coc-settings.json`)
+> It's better to put these settings to workspace settings (`.vscode/settings.json`)
 
-### VS Code
+### coc.nvim
 
-Install [`dbaeumer.vscode-eslint`](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) extension
+Install [`coc-eslint`](https://github.com/neoclide/coc-eslint) extension
 
 ```jsonc
 {
-  "prettier.enable": false,
-  "editor.formatOnSave": false,
-  "editor.codeActionsOnSave": {
-    "source.addMissingImports": true,
-    "source.fixAll.eslint": true,
-    "source.organizeImports": false
-  },
+  "eslint.experimental.useFlatConfig": true,
+  "eslint.autoFixOnSave": true,
   "eslint.validate": [
     "javascript",
     "javascriptreact",
@@ -97,11 +91,14 @@ Install [`dbaeumer.vscode-eslint`](https://marketplace.visualstudio.com/items?it
     "json",
     "jsonc",
     "yaml"
+  ],
+  "eslint.rules.customizations": [
+    { "rule": "auvred/prettier", "severity": "off" }
   ]
 }
 ```
 
-> It's better to put these settings to workspace settings (`.vscode/settings.json`)
+> It's better to put these settings to workspace settings (`.vim/coc-settings.json`)
 
 ### JetBrains IDEs
 

eslint.config.js

@@ -0,0 +1,17 @@
+// eslint-disable-next-line import/no-useless-path-segments
+import { auvred } from './dist/index.js'
+
+export default auvred({
+  typescript: {
+    overrides: {
+      'ts/no-restricted-imports': [
+        'error',
+        {
+          name: 'eslint-define-config',
+          importNames: ['FlatESLintConfig'],
+          message: 'Use FlatConfigItem from types.ts instead',
+        },
+      ],
+    },
+  },
+})