@luxass/eslint-config 4.2.5 → 4.2.7

package/README.md

@@ -19,7 +19,7 @@
 
 ## 📦 Install
 
-```bash
+```bash copy
 npm install -D eslint @luxass/eslint-config
 ```
 
@@ -29,28 +29,28 @@ With [`"type": "module"`](https://nodejs.org/api/packages.html#type) in `package
 
 ```js
 // eslint.config.js
-import luxass from "@luxass/eslint-config"
+import luxass from "@luxass/eslint-config";
 
-export default luxass()
+export default luxass();
 ```
 
 With CJS:
 
 ```js
 // eslint.config.js
-const luxass = require("@luxass/eslint-config").default
+const luxass = require("@luxass/eslint-config").default;
 
-module.exports = luxass()
+module.exports = luxass();
 ```
 
 Combined with legacy config:
 
 ```js
 // eslint.config.js
-const luxass = require("@luxass/eslint-config").default
-const { FlatCompat } = require("@eslint/eslintrc")
+const luxass = require("@luxass/eslint-config").default;
+const { FlatCompat } = require("@eslint/eslintrc");
 
-const compat = new FlatCompat()
+const compat = new FlatCompat();
 
 module.exports = luxass(
   {
@@ -66,7 +66,7 @@ module.exports = luxass(
   })
 
   // Other flat configs...
-)
+);
 ```
 
 > Note that `.eslintignore` no longer works in Flat config, see [customization](#customization) for more details.
@@ -129,16 +129,16 @@ Normally you would only need to import the `luxass` preset:
 
 ```js
 // eslint.config.js
-import luxass from "@luxass/eslint-config"
+import luxass from "@luxass/eslint-config";
 
-export default luxass()
+export default luxass();
 ```
 
 you can also configure each `config` individually:
 
 ```js
 // eslint.config.js
-import luxass from "@luxass/eslint-config"
+import luxass from "@luxass/eslint-config";
 
 export default luxass({
   stylistic: true,
@@ -152,14 +152,14 @@ export default luxass({
   ignores: [
     "**/fixtures"
   ]
-})
+});
 ```
 
 The `luxass` function accepts an arbitrary number of `flat configs` overrides:
 
 ```js
 // eslint.config.js
-import luxass from "@luxass/eslint-config"
+import luxass from "@luxass/eslint-config";
 
 export default luxass({
   // configuration points for my config
@@ -167,7 +167,7 @@ export default luxass({
   rules: {}
 }, {
   rules: {}
-})
+});
 ```
 
 <details>
@@ -178,6 +178,7 @@ We don't recommend using this style in general usages, as there are shared optio
 ```js
 // eslint.config.js
 import {
+  combine,
   comments,
   ignores,
   imports,
@@ -192,10 +193,8 @@ import {
   typescript,
   unicorn,
   vue,
-  yaml,
-} from "@luxass/eslint-config/configs"
-
-import { combine } from "@luxass/eslint-config"
+  yaml
+} from "@luxass/eslint-config";
 
 export default combine(
   ignores(),
@@ -211,7 +210,7 @@ export default combine(
   jsonc(),
   yaml(),
   markdown(),
-)
+);
 ```
 
 </details>
@@ -247,7 +246,7 @@ Certain rules would only be enabled in specific files, for example, `ts/*` rules
 
 ```js
 // eslint.config.js
-import luxass from "@luxass/eslint-config"
+import luxass from "@luxass/eslint-config";
 
 export default luxass(
   { vue: true, typescript: true },
@@ -264,14 +263,14 @@ export default luxass(
       "style/semi": ["error", "never"],
     },
   }
-)
+);
 ```
 
 We also provided a `overrides` options to make it easier:
 
 ```js
 // eslint.config.js
-import luxass from "@luxass/eslint-config"
+import luxass from "@luxass/eslint-config";
 
 export default luxass({
   overrides: {
@@ -284,7 +283,7 @@ export default luxass({
     yaml: {},
     // ...
   }
-})
+});
 ```
 
 ### Optional Configs
@@ -300,7 +299,7 @@ Use external formatters to format files that ESLint cannot handle yet (`.css`, `
 
 ```js
 // eslint.config.js
-import luxass from "@luxass/eslint-config"
+import luxass from "@luxass/eslint-config";
 
 export default luxass({
   formatters: {
@@ -326,7 +325,7 @@ export default luxass({
      */
     markdown: "prettier"
   }
-})
+});
 ```
 
 Running `npx eslint` should prompt you to install the required dependencies, otherwise, you can install them manually:
@@ -341,11 +340,11 @@ To enable React support, need to explicitly turn it on:
 
 ```js
 // eslint.config.js
-import luxass from "@luxass/eslint-config"
+import luxass from "@luxass/eslint-config";
 
 export default luxass({
   react: true,
-})
+});
 ```
 
 Running `npx eslint` should prompt you to install the required dependencies, otherwise, you can install them manually:
@@ -362,11 +361,11 @@ Next.JS also enables React support.
 
 ```js
 // eslint.config.js
-import luxass from "@luxass/eslint-config"
+import luxass from "@luxass/eslint-config";
 
 export default luxass({
   nextjs: true,
-})
+});
 ```
 
 Running `npx eslint` should prompt you to install the required dependencies, otherwise, you can install them manually:
@@ -381,11 +380,11 @@ To enable UnoCSS support, need to explicitly turn it on:
 
 ```js
 // eslint.config.js
-import luxass from "@luxass/eslint-config"
+import luxass from "@luxass/eslint-config";
 
 export default luxass({
   unocss: true,
-})
+});
 ```
 
 Running `npx eslint` should prompt you to install the required dependencies, otherwise, you can install them manually:
@@ -400,11 +399,11 @@ To enable TailwindCSS support, need to explicitly turn it on:
 
 ```js
 // eslint.config.js
-import luxass from "@luxass/eslint-config"
+import luxass from "@luxass/eslint-config";
 
 export default luxass({
   tailwindcss: true,
-})
+});
 ```
 
 Running `npx eslint` should prompt you to install the required dependencies, otherwise, you can install them manually:
@@ -417,37 +416,19 @@ npm i -D eslint-plugin-tailwindcss
 
 This config also provides some optional plugins/rules for extended usages.
 
-#### `perfectionist` (sorting)
-
-This plugin [`eslint-plugin-perfectionist`](https://github.com/azat-io/eslint-plugin-perfectionist) allows you to sorted object keys, imports, etc, with auto-fix.
-
-The plugin is installed but no rules are enabled by default.
-
-It's recommended to opt-in on each file individually using [configuration comments](https://eslint.org/docs/latest/use/configure/rules#using-configuration-comments-1).
-
-```js
-/* eslint perfectionist/sort-objects: "error" */
-const objectWantedToSort = {
-  a: 2,
-  b: 1,
-  c: 3,
-}
-/* eslint perfectionist/sort-objects: "off" */
-```
-
 ### Type Aware Rules
 
 You can optionally enable the [type aware rules](https://typescript-eslint.io/linting/typed-linting/) by passing the options object to the `typescript` config:
 
 ```js
 // eslint.config.js
-import luxass from "@luxass/eslint-config"
+import luxass from "@luxass/eslint-config";
 
 export default luxass({
   typescript: {
     tsconfigPath: "tsconfig.json",
   },
-})
+});
 ```
 
 ## Versioning Policy