@luxass/eslint-config 4.2.5 → 4.2.6

package/README.md

@@ -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>
@@ -193,9 +193,9 @@ import {
   unicorn,
   vue,
   yaml,
-} from "@luxass/eslint-config/configs"
+} from "@luxass/eslint-config/configs";
 
-import { combine } from "@luxass/eslint-config"
+import { combine } from "@luxass/eslint-config";
 
 export default combine(
   ignores(),
@@ -211,7 +211,7 @@ export default combine(
   jsonc(),
   yaml(),
   markdown(),
-)
+);
 ```
 
 </details>
@@ -247,7 +247,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 +264,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 +284,7 @@ export default luxass({
     yaml: {},
     // ...
   }
-})
+});
 ```
 
 ### Optional Configs
@@ -300,7 +300,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 +326,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 +341,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 +362,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 +381,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 +400,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 +417,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

package/dist/{chunk-AQRBQAKE.mjs → chunk-2IR43M6N.mjs}

@@ -6,7 +6,7 @@ import {
   GLOB_SRC
 } from "./chunk-KOXCJL3C.mjs";
 
-// src/configs/unocss.ts
+// src/configs/css/unocss.ts
 async function unocss(options = {}) {
   const {
     attributify = true,

package/dist/{chunk-UITQW3RA.mjs → chunk-47ISSTHW.mjs}

@@ -7,7 +7,7 @@ import {
   GLOB_TSX
 } from "./chunk-KOXCJL3C.mjs";
 
-// src/configs/react.ts
+// src/configs/frameworks/react.ts
 import { isPackageExists } from "local-pkg";
 async function react(options = {}) {
   const {
@@ -33,9 +33,7 @@ async function react(options = {}) {
     interop(import("eslint-plugin-react-refresh")),
     ...a11y ? [interop(import("eslint-plugin-jsx-a11y"))] : []
   ]);
-  const isAllowConstantExport = ["vite"].some(
-    (i) => isPackageExists(i)
-  );
+  const isAllowConstantExport = isPackageExists("vite");
   return [
     {
       name: "luxass:react:setup",

package/dist/{chunk-WOBGA3K2.mjs → chunk-AJS3TMZE.mjs}

@@ -6,7 +6,7 @@ import {
   GLOB_SRC
 } from "./chunk-KOXCJL3C.mjs";
 
-// src/configs/tailwindcss.ts
+// src/configs/css/tailwindcss.ts
 async function tailwindcss(options = {}) {
   const {
     files = [GLOB_SRC],

package/dist/{chunk-FNOIGW47.mjs → chunk-C6FE5KXJ.mjs}

@@ -7,7 +7,7 @@ import {
   GLOB_MARKDOWN_IN_MARKDOWN
 } from "./chunk-KOXCJL3C.mjs";
 
-// src/configs/markdown.ts
+// src/configs/docs/markdown.ts
 import * as parserPlain from "eslint-parser-plain";
 import { mergeProcessors, processorPassThrough } from "eslint-merge-processors";
 async function markdown(options = {}) {

package/dist/{chunk-MT5P5EKH.mjs → chunk-E4RVBKZB.mjs}

@@ -6,7 +6,7 @@ import {
   GLOB_VUE
 } from "./chunk-KOXCJL3C.mjs";
 
-// src/configs/vue.ts
+// src/configs/frameworks/vue.ts
 import { mergeProcessors } from "eslint-merge-processors";
 async function vue(options = {}) {
   const {

package/dist/{chunk-DVQQVCGF.mjs → chunk-HZNHG5PB.mjs}

@@ -2,7 +2,7 @@ import {
   interop
 } from "./chunk-4YBQZLPS.mjs";
 
-// src/configs/jsdoc.ts
+// src/configs/docs/jsdoc.ts
 async function jsdoc(options = {}) {
   const {
     overrides,

package/dist/{chunk-QDSV5ONX.mjs → chunk-PFCAWBCD.mjs}

@@ -7,7 +7,7 @@ import {
   GLOB_JSONC
 } from "./chunk-KOXCJL3C.mjs";
 
-// src/configs/jsonc.ts
+// src/configs/data/json.ts
 async function jsonc(options = {}) {
   const {
     files = [GLOB_JSON, GLOB_JSON5, GLOB_JSONC],

package/dist/{chunk-O2BXTQHK.mjs → chunk-PFYV2TWZ.mjs}

@@ -5,7 +5,7 @@ import {
   GLOB_ASTRO
 } from "./chunk-KOXCJL3C.mjs";
 
-// src/configs/astro.ts
+// src/configs/frameworks/astro.ts
 async function astro(options) {
   const {
     a11y = false,

package/dist/{chunk-MMSZW2UW.mjs → chunk-QT6FHTFU.mjs}

@@ -8,7 +8,7 @@ import {
   GLOB_SRC
 } from "./chunk-KOXCJL3C.mjs";
 
-// src/configs/nextjs.ts
+// src/configs/frameworks/nextjs.ts
 async function nextjs(options = {}) {
   const {
     files = [GLOB_SRC],

package/dist/{chunk-QMGT2Z63.mjs → chunk-RDZJT36Z.mjs}

@@ -8,7 +8,7 @@ var StylisticConfigDefaults = {
   indent: 2,
   jsx: true,
   quotes: "double",
-  semi: false
+  semi: true
 };
 async function stylistic(options = {}) {
   const {

package/dist/{chunk-7ODEIBF5.mjs → chunk-TWAETZPX.mjs}

@@ -1,6 +1,3 @@
-import {
-  createRule
-} from "./chunk-WDSV2EFG.mjs";
 import {
   interop
 } from "./chunk-4YBQZLPS.mjs";
@@ -8,7 +5,12 @@ import {
   GLOB_TESTS
 } from "./chunk-KOXCJL3C.mjs";
 
+// src/custom-rules/utils.ts
+import { ESLintUtils } from "@typescript-eslint/utils";
+var createRule = ESLintUtils.RuleCreator((ruleName) => `https://github.com/luxass/eslint-config/blob/main/src/custom-rules/${ruleName}/README.md`);
+
 // src/custom-rules/no-only-tests/index.ts
+var RULE_NAME = "no-only-tests";
 var DEFAULT_OPTIONS = {
   blocks: ["describe", "it", "test"],
   focus: ["only"]
@@ -17,10 +19,10 @@ function getPath(node, path = []) {
   if (node) {
     const nodeName = node.name || node.property && node.property.name;
     if (node.object) {
-      return getPath(node.object, [
-        nodeName,
-        ...path
-      ]);
+      return getPath(
+        node.object,
+        [nodeName, ...path]
+      );
     }
     if (node.callee)
       return getPath(node.callee, path);
@@ -29,13 +31,13 @@ function getPath(node, path = []) {
   return path;
 }
 var noOnlyTests = createRule({
-  name: "no-only-tests",
+  name: RULE_NAME,
   create: (context, [options]) => {
     const {
       blocks = DEFAULT_OPTIONS.blocks,
       focus = DEFAULT_OPTIONS.focus
     } = options;
-    const handler = {
+    return {
       Identifier(node) {
         const parent = node.parent?.object;
         if (!parent)
@@ -44,56 +46,59 @@ var noOnlyTests = createRule({
           return;
         const callPath = getPath(node.parent).join(".");
         const found = blocks.find((block) => {
-          if (block.endsWith("*"))
+          if (block.endsWith("*")) {
             return callPath.startsWith(block.replace(/\*$/, ""));
+          }
           return callPath.startsWith(`${block}.`);
         });
         if (found) {
           context.report({
             data: { block: callPath.split(".")[0], focus: node.name },
-            messageId: "notPermitted",
+            messageId: "not-permitted",
             node
           });
         }
       }
     };
-    return handler;
   },
-  defaultOptions: [{
-    blocks: ["describe", "it", "test"],
-    focus: ["only"]
-  }],
+  defaultOptions: [
+    {
+      blocks: ["describe", "it", "test"],
+      focus: ["only"]
+    }
+  ],
   meta: {
     docs: {
       description: "disallow .only blocks in tests",
       recommended: "recommended"
     },
     messages: {
-      notPermitted: "{{ block }}.{{ focus }} not permitted"
+      "not-permitted": "{{ block }}.{{ focus }} not permitted"
     },
-    schema: [{
-      additionalProperties: false,
-      properties: {
-        blocks: {
-          items: {
-            type: "string"
+    schema: [
+      {
+        additionalProperties: false,
+        properties: {
+          blocks: {
+            items: {
+              type: "string"
+            },
+            type: "array",
+            uniqueItems: true
           },
-          type: "array",
-          uniqueItems: true
+          focus: {
+            items: {
+              type: "string"
+            },
+            type: "array",
+            uniqueItems: true
+          }
         },
-        focus: {
-          items: {
-            type: "string"
-          },
-          type: "array",
-          uniqueItems: true
-        }
-      },
-      type: "object"
-    }],
+        type: "object"
+      }
+    ],
     type: "layout"
   }
-  // i need to have this here, otherwise typechecking fails.
 });
 
 // src/configs/test.ts

package/dist/{chunk-SPD4DGYN.mjs → chunk-XD3UVRU7.mjs}

@@ -7,7 +7,7 @@ import {
   GLOB_TSX
 } from "./chunk-KOXCJL3C.mjs";
 
-// src/configs/solid.ts
+// src/configs/frameworks/solid.ts
 async function solid(options = {}) {
   const {
     a11y = false,

package/dist/{chunk-V57HXOSW.mjs → chunk-XGI647GZ.mjs}

@@ -5,7 +5,7 @@ import {
   GLOB_YAML
 } from "./chunk-KOXCJL3C.mjs";
 
-// src/configs/yaml.ts
+// src/configs/data/yaml.ts
 async function yaml(options = {}) {
   const {
     files = [GLOB_YAML],

package/dist/{chunk-XPKGXA67.mjs → chunk-XMXYE5WC.mjs}

@@ -1,6 +1,6 @@
 import {
   StylisticConfigDefaults
-} from "./chunk-QMGT2Z63.mjs";
+} from "./chunk-RDZJT36Z.mjs";
 import {
   ensure,
   interop

package/dist/{chunk-EHWA727G.mjs → chunk-YNMFVYL6.mjs}

@@ -5,7 +5,7 @@ import {
   GLOB_TOML
 } from "./chunk-KOXCJL3C.mjs";
 
-// src/configs/toml.ts
+// src/configs/data/toml.ts
 async function toml(options = {}) {
   const {
     files = [GLOB_TOML],

package/dist/configs/{tailwindcss.cjs → css/tailwindcss.cjs}

@@ -27,7 +27,7 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 ));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
-// src/configs/tailwindcss.ts
+// src/configs/css/tailwindcss.ts
 var tailwindcss_exports = {};
 __export(tailwindcss_exports, {
   tailwindcss: () => tailwindcss
@@ -91,7 +91,7 @@ async function ensure(packages) {
   ;
 }
 
-// src/configs/tailwindcss.ts
+// src/configs/css/tailwindcss.ts
 async function tailwindcss(options = {}) {
   const {
     files = [GLOB_SRC],

package/dist/configs/{tailwindcss.d.cts → css/tailwindcss.d.cts}

@@ -1,4 +1,4 @@
-export { h as TailwindCSSOptions, g as tailwindcss } from '../types-HqEzZfQU.cjs';
+export { h as TailwindCSSOptions, g as tailwindcss } from '../../types-HqEzZfQU.cjs';
 import 'eslint-config-flat-gitignore';
 import '@antfu/eslint-define-config';
 import '@eslint-types/jsdoc/types';

package/dist/configs/{tailwindcss.d.ts → css/tailwindcss.d.ts}

@@ -1,4 +1,4 @@
-export { h as TailwindCSSOptions, g as tailwindcss } from '../types-HqEzZfQU.js';
+export { h as TailwindCSSOptions, g as tailwindcss } from '../../types-HqEzZfQU.js';
 import 'eslint-config-flat-gitignore';
 import '@antfu/eslint-define-config';
 import '@eslint-types/jsdoc/types';

package/dist/configs/css/tailwindcss.mjs

@@ -0,0 +1,8 @@
+import {
+  tailwindcss
+} from "../../chunk-AJS3TMZE.mjs";
+import "../../chunk-4YBQZLPS.mjs";
+import "../../chunk-KOXCJL3C.mjs";
+export {
+  tailwindcss
+};

package/dist/configs/{unocss.cjs → css/unocss.cjs}

@@ -27,7 +27,7 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 ));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
-// src/configs/unocss.ts
+// src/configs/css/unocss.ts
 var unocss_exports = {};
 __export(unocss_exports, {
   unocss: () => unocss
@@ -91,7 +91,7 @@ async function ensure(packages) {
   ;
 }
 
-// src/configs/unocss.ts
+// src/configs/css/unocss.ts
 async function unocss(options = {}) {
   const {
     attributify = true,

package/dist/configs/{unocss.d.cts → css/unocss.d.cts}

@@ -1,4 +1,4 @@
-export { U as UnoCSSOptions, u as unocss } from '../types-HqEzZfQU.cjs';
+export { U as UnoCSSOptions, u as unocss } from '../../types-HqEzZfQU.cjs';
 import 'eslint-config-flat-gitignore';
 import '@antfu/eslint-define-config';
 import '@eslint-types/jsdoc/types';

package/dist/configs/{unocss.d.ts → css/unocss.d.ts}

@@ -1,4 +1,4 @@
-export { U as UnoCSSOptions, u as unocss } from '../types-HqEzZfQU.js';
+export { U as UnoCSSOptions, u as unocss } from '../../types-HqEzZfQU.js';
 import 'eslint-config-flat-gitignore';
 import '@antfu/eslint-define-config';
 import '@eslint-types/jsdoc/types';

package/dist/configs/css/unocss.mjs

@@ -0,0 +1,8 @@
+import {
+  unocss
+} from "../../chunk-2IR43M6N.mjs";
+import "../../chunk-4YBQZLPS.mjs";
+import "../../chunk-KOXCJL3C.mjs";
+export {
+  unocss
+};

package/dist/configs/{jsonc.cjs → data/json.cjs}

@@ -27,12 +27,12 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 ));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
-// src/configs/jsonc.ts
-var jsonc_exports = {};
-__export(jsonc_exports, {
+// src/configs/data/json.ts
+var json_exports = {};
+__export(json_exports, {
   jsonc: () => jsonc
 });
-module.exports = __toCommonJS(jsonc_exports);
+module.exports = __toCommonJS(json_exports);
 
 // src/globs.ts
 var GLOB_SRC_EXT = "?([cm])[jt]s?(x)";
@@ -69,7 +69,7 @@ async function interop(m) {
   return resolved.default || resolved;
 }
 
-// src/configs/jsonc.ts
+// src/configs/data/json.ts
 async function jsonc(options = {}) {
   const {
     files = [GLOB_JSON, GLOB_JSON5, GLOB_JSONC],

package/dist/configs/{nextjs.d.cts → data/json.d.cts}

@@ -1,4 +1,4 @@
-export { N as NextJSOptions, n as nextjs } from '../types-HqEzZfQU.cjs';
+export { b as JSONOptions, a as jsonc } from '../../types-HqEzZfQU.cjs';
 import 'eslint-config-flat-gitignore';
 import '@antfu/eslint-define-config';
 import '@eslint-types/jsdoc/types';

package/dist/configs/{nextjs.d.ts → data/json.d.ts}

@@ -1,4 +1,4 @@
-export { N as NextJSOptions, n as nextjs } from '../types-HqEzZfQU.js';
+export { b as JSONOptions, a as jsonc } from '../../types-HqEzZfQU.js';
 import 'eslint-config-flat-gitignore';
 import '@antfu/eslint-define-config';
 import '@eslint-types/jsdoc/types';