@frabbit/eslint-config 1.5.15 → 7.4.6

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright © 2021-PRESENT 三咲智子 (https://github.com/sxzz)
+Copyright © 2021-PRESENT Kevin Deng (https://github.com/sxzz)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -3,16 +3,19 @@
 Flat ESLint config for JavaScript, TypeScript, Vue 2, Vue 3, Prettier.
 based on https://github.com/sxzz/eslint-config
 
-[Legacy Version](https://github.com/sxzz/eslint-config-legacy)
+A opinionated ESLint config preset for JavaScript, TypeScript, Vue,
+and Prettier.
 
 ## Features
 
 - Format with Prettier.
-- Designed to work with TypeScript, Vue 2 and 3 out-of-box.
+- Designed to work with TypeScript, Vue out-of-box.
 - Support JSON(5), YAML, Markdown...
 - Sort imports, `package.json`, `tsconfig.json`...
 - [ESLint Flat config](https://eslint.org/docs/latest/use/configure/configuration-files-new), compose easily!
+- Ignores common files like `dist`, `node_modules`, `coverage`, and files in `.gitignore`.
 - Reasonable defaults, best practices, only one-line of config
+- Reasonable strict, but with better code quality.
 
 ## Install
 
@@ -20,54 +23,55 @@ based on https://github.com/sxzz/eslint-config
 npm i -D @frabbit/eslint-config
 ```
 
-Require Node.js >= 16.14.
+Require Node.js >= 20.0.0, and ESLint >= 9.5.0.
 
 ## Usage
 
-```js
-// eslint.config.js
-import { all } from '@frabbit/eslint-config'
-
-export default all
-```
-
-### Custom Config
-
 ```js
 import { frabbit } from '@frabbit/eslint-config'
+
 export default frabbit(
+  // Features: it'll detect installed dependency and enable necessary features automatically
+  {
+    prettier: true,
+    markdown: true,
+    vue: true, // auto detection
+    unocss: false, // auto detection
+  },
   [
     /* your custom config */
-  ],
-  { vue: true, prettier: true, markdown: true, unocss: false }
-)
+  ]
+).removeRules('foo/bar') // see more in https://github.com/antfu/eslint-flat-config-utils
 ```
 
-### VSCode
+### Presets
 
-```jsonc
-{
-  "eslint.experimental.useFlatConfig": true
-}
+```js
+// eslint.config.js
+import {
+  presetJavaScript, // Ignore common files and include javascript support
+  presetJsonc, // Includes basic json(c) file support and sorting json keys
+  presetLangsExtensions, // Includes markdown, yaml + `presetJsonc` support
+  presetBasic, // Includes `presetJavaScript` and typescript support
+
+  // Includes
+  // - `presetBasic` (JS+TS) support
+  // - `presetLangsExtensions` (markdown, yaml, jsonc) support
+  // - Vue support
+  // - UnoCSS support (`uno.config.ts` is required)
+  // - Prettier support
+  presetAll,
+} from '@frabbit/eslint-config'
+
+export default presetAll
 ```
 
+See [preset.ts](./src/presets.ts) for more details.
+
 ## Comparing to [`@antfu/eslint-config`](https://github.com/antfu/eslint-config)
 
 Most of the rules are the same, but there are some differences:
 
-- Use Prettier instead of [ESLint Stylistic](https://github.com/eslint-stylistic/eslint-stylistic).
-- Support both Vue 2 and Vue 3.
-- Support Vue Reactivity Transform.
-- More stricter rules.
-
-## Sponsors
-
-<p align="center">
-  <a href="https://cdn.jsdelivr.net/gh/frabbit/sponsors/sponsors.svg">
-    <img src='https://cdn.jsdelivr.net/gh/frabbit/sponsors/sponsors.svg'/>
-  </a>
-</p>
-
-## License
-
-[MIT](./LICENSE) License © 2021-PRESENT [三咲智子](https://github.com/frenchrabbit)
+- Use [Prettier](https://prettier.io/) instead of [ESLint Stylistic](https://github.com/eslint-stylistic/eslint-stylistic).
+- React and Svelte are not supported.
+- Maybe stricter and simpler.