@zayne-labs/eslint-config 0.4.2 → 0.5.0

package/dist/index.js

@@ -1,11 +1,12 @@
-import './chunk-VUNV25KB.js';
 import { fileURLToPath } from 'node:url';
 import { isPackageExists } from 'local-pkg';
 import globals from 'globals';
 import { fixupPluginRules } from '@eslint/compat';
 import { mergeProcessors } from 'eslint-merge-processors';
+import { assert } from '@zayne-labs/toolkit-type-helpers';
 import { FlatConfigComposer } from 'eslint-flat-config-utils';
 
+// src/utils.ts
 var isObject = (value) => {
   return typeof value === "object" && value !== null && !Array.isArray(value);
 };
@@ -64,6 +65,7 @@ var ensurePackages = async (packages) => {
     await antfuPkg.installPackage(nonExistingPackages, { dev: true });
   }
 };
+var resolveOptions = (option) => isObject(option) ? option : {};
 
 // src/globs.ts
 var GLOB_SRC_EXT = "?([cm])[jt]s?(x)";
@@ -177,9 +179,6 @@ var javascript = async (options = {}) => {
           window: "readonly"
         },
         parserOptions: {
-          ecmaFeatures: {
-            jsx: true
-          },
           ecmaVersion: "latest",
           sourceType: "module"
         },
@@ -516,7 +515,7 @@ var typescript = async (options = {}) => {
     allowDefaultProjects,
     componentExts = [],
     files = [GLOB_TS, GLOB_TSX, ...componentExts.map((ext) => `**/*.${ext}`)],
-    filesTypeAware = [GLOB_TS, GLOB_TSX],
+    filesTypeAware = [GLOB_TS, GLOB_TSX, ...componentExts.map((ext) => `**/*.${ext}`)],
     ignoresTypeAware = [`${GLOB_MARKDOWN}/**`, GLOB_ASTRO_TS],
     overrides,
     parserOptions,
@@ -653,11 +652,11 @@ var imports = async (options = {}) => {
   const eslintPluginImportX = await interopDefault(import('eslint-plugin-import-x'));
   return [
     {
+      name: "zayne/import/setup",
       plugins: {
         import: eslintPluginImportX
       },
-      ...typescript2 && { settings: eslintPluginImportX.flatConfigs.typescript.settings },
-      name: "zayne/import/setup"
+      ...typescript2 && { settings: eslintPluginImportX.flatConfigs.typescript.settings }
     },
     {
       name: "zayne/import/recommended",
@@ -866,16 +865,10 @@ var stylistic = async (options = {}) => {
           }
         ],
         ...jsx2 && {
-          "stylistic/jsx-self-closing-comp": "error"
+          "stylistic/jsx-self-closing-comp": "warn"
         },
         ...overrides
       }
-    },
-    {
-      files: [GLOB_YAML],
-      rules: {
-        "stylistic/spaced-comment": "off"
-      }
     }
   ];
 };
@@ -1006,19 +999,28 @@ var isAllowConstantExport = ReactRefreshAllowConstantExportPackages.some((i) =>
 var isUsingRemix = RemixPackages.some((i) => isPackageExists(i));
 var isUsingNext = NextJsPackages.some((i) => isPackageExists(i));
 var react = async (options = {}) => {
-  const { files = [GLOB_SRC], nextjs = isUsingNext, overrides, typescript: typescript2 = true } = options;
+  const {
+    compiler = false,
+    files = [GLOB_SRC],
+    nextjs = isUsingNext,
+    overrides,
+    refresh = true,
+    typescript: typescript2 = true
+  } = options;
   await ensurePackages([
     "@eslint-react/eslint-plugin",
     "eslint-plugin-react-hooks",
-    "eslint-plugin-react-refresh",
+    ...refresh ? ["eslint-plugin-react-refresh"] : [],
+    ...compiler ? ["eslint-plugin-react-compiler"] : [],
     ...nextjs ? ["@next/eslint-plugin-next"] : []
   ]);
-  const [eslintPluginReact, eslintReactHooks, eslintPluginReactRefresh, eslintPluginNextjs] = await Promise.all([
+  const [eslintPluginReact, eslintReactHooks, eslintPluginReactRefresh] = await Promise.all([
     interopDefault(import('@eslint-react/eslint-plugin')),
     interopDefault(import('eslint-plugin-react-hooks')),
-    interopDefault(import('eslint-plugin-react-refresh')),
-    ...nextjs ? [interopDefault(import('@next/eslint-plugin-next'))] : []
+    ...refresh ? [interopDefault(import('eslint-plugin-react-refresh'))] : []
   ]);
+  const eslintPluginReactCompiler = compiler && await interopDefault(import('eslint-plugin-react-compiler'));
+  const eslintPluginNextjs = nextjs && await interopDefault(import('@next/eslint-plugin-next'));
   const recommendedReactConfig = eslintPluginReact.configs[typescript2 ? "recommended-type-checked" : "recommended"];
   const config = [
     {
@@ -1039,11 +1041,12 @@ var react = async (options = {}) => {
       files,
       name: "zayne/react/rules",
       rules: {
-        // Hook rules
+        // Hook Extra rules
         "react-hooks-extra/ensure-custom-hooks-using-other-hooks": "error",
         "react-hooks-extra/no-unnecessary-use-callback": "warn",
         "react-hooks-extra/no-unnecessary-use-memo": "warn",
         "react-hooks-extra/prefer-use-state-lazy-initialization": "error",
+        // Hook rules
         "react-hooks/exhaustive-deps": "warn",
         "react-hooks/rules-of-hooks": "error",
         // Naming convention rules
@@ -1092,10 +1095,22 @@ var react = async (options = {}) => {
       }
     }
   ];
+  if (compiler && eslintPluginReactCompiler) {
+    config.push({
+      files,
+      name: "zayne/react/compiler",
+      plugins: {
+        "react-compiler": eslintPluginReactCompiler
+      },
+      rules: {
+        "react-compiler/react-compiler": "error"
+      }
+    });
+  }
   if (nextjs && eslintPluginNextjs) {
     config.push({
       files,
-      name: "zayne/react/next",
+      name: "zayne/react/nextjs",
       plugins: {
         "nextjs-next": fixupPluginRules(eslintPluginNextjs)
       },
@@ -1506,7 +1521,7 @@ var yaml = async (options = {}) => {
         "yaml/no-irregular-whitespace": "error",
         "yaml/plain-scalar": "error",
         "yaml/vue-custom-block/no-parsing-error": "error",
-        ...stylistic2 ? {
+        ...stylistic2 && {
           "yaml/block-mapping-question-indicator-newline": "error",
           "yaml/block-sequence-hyphen-indicator-newline": "error",
           "yaml/flow-mapping-curly-newline": "error",
@@ -1521,7 +1536,8 @@ var yaml = async (options = {}) => {
           // 	{ avoidEscape: true, prefer: quotes === "backtick" ? "double" : quotes },
           // ],
           "yaml/spaced-comment": "error"
-        } : {},
+        },
+        "stylistic/spaced-comment": "off",
         ...overrides
       }
     }
@@ -1530,13 +1546,12 @@ var yaml = async (options = {}) => {
 async function vue(options = {}) {
   const {
     files = [GLOB_VUE],
-    indent = 3,
     overrides,
+    sfcBlocks = true,
     stylistic: stylistic2 = true,
     typescript: typescript2 = true,
     vueVersion = 3
   } = options;
-  const sfcBlocks = options.sfcBlocks === true ? {} : options.sfcBlocks ?? {};
   await ensurePackages([
     "eslint-plugin-vue",
     "vue-eslint-parser",
@@ -1545,7 +1560,7 @@ async function vue(options = {}) {
   const [pluginVue, parserVue, processorVueBlocks] = await Promise.all([
     interopDefault(import('eslint-plugin-vue')),
     interopDefault(import('vue-eslint-parser')),
-    interopDefault(import('eslint-processor-vue-blocks'))
+    ...sfcBlocks ? [interopDefault(import('eslint-processor-vue-blocks'))] : []
   ]);
   return [
     {
@@ -1583,21 +1598,20 @@ async function vue(options = {}) {
             jsx: true
           },
           extraFileExtensions: [".vue"],
-          // eslint-disable-next-line import/no-extraneous-dependencies -- allow this for now, might change later
-          parser: typescript2 ? await interopDefault(import('./dist-RQW5ZYTC.js')) : void 0,
-          sourceType: "module"
+          sourceType: "module",
+          ...typescript2 && { parser: await interopDefault(import('@typescript-eslint/parser')) }
         }
       },
       name: "zayne/vue/rules",
       processor: sfcBlocks === false ? pluginVue.processors[".vue"] : mergeProcessors([
         pluginVue.processors[".vue"],
-        processorVueBlocks({
-          ...sfcBlocks,
+        processorVueBlocks?.({
+          ...resolveOptions(sfcBlocks),
           blocks: {
             styles: true,
-            ...sfcBlocks.blocks
+            ...resolveOptions(sfcBlocks).blocks
           }
-        })
+        }) ?? pluginVue.processors[".vue"]
       ]),
       rules: {
         ...pluginVue.configs.base.rules,
@@ -1631,7 +1645,7 @@ async function vue(options = {}) {
         "vue/dot-location": ["error", "property"],
         "vue/dot-notation": ["error", { allowKeywords: true }],
         "vue/eqeqeq": ["error", "smart"],
-        "vue/html-indent": ["error", indent],
+        "vue/html-indent": "off",
         "vue/html-quotes": ["error", "double"],
         "vue/max-attributes-per-line": "off",
         "vue/multi-word-component-names": "off",
@@ -1664,6 +1678,7 @@ async function vue(options = {}) {
         "vue/prop-name-casing": ["error", "camelCase"],
         "vue/require-default-prop": "off",
         "vue/require-prop-types": "off",
+        "vue/singleline-html-element-content-newline": "off",
         "vue/space-infix-ops": "error",
         "vue/space-unary-ops": ["error", { nonwords: false, words: true }],
         ...stylistic2 && {
@@ -1699,12 +1714,42 @@ async function vue(options = {}) {
           "vue/space-in-parens": ["error", "never"],
           "vue/template-curly-spacing": "error"
         },
+        "ts-eslint/no-unused-vars": "off",
         ...overrides
       }
     }
   ];
 }
 
+// src/configs/solid.ts
+var solid = async (options = {}) => {
+  const { files = [GLOB_SRC], overrides, typescript: typescript2 = true } = options;
+  await ensurePackages(["eslint-plugin-solid"]);
+  const eslintPluginSolid = await interopDefault(import('eslint-plugin-solid'));
+  const recommendedSolidConfig = eslintPluginSolid.configs[typescript2 ? "flat/typescript" : "flat/recommended"];
+  return [
+    {
+      name: "zayne/solid/setup",
+      plugins: {
+        solid: eslintPluginSolid
+      }
+    },
+    {
+      files,
+      name: "zayne/solid/recommended",
+      rules: recommendedSolidConfig.rules
+    },
+    {
+      name: "zayne/solid/rules",
+      rules: {
+        "solid/no-innerhtml": ["error", { allowStatic: true }],
+        "solid/style-prop": ["error", { styleProps: ["style", "css"] }],
+        ...overrides
+      }
+    }
+  ];
+};
+
 // src/configs/jsx.ts
 var jsx = () => {
   return [
@@ -1724,8 +1769,6 @@ var jsx = () => {
 
 // src/factory.ts
 var ReactPackages = ["react", "react-dom"];
-var VuePackages = ["vue", "nuxt", "vitepress", "@slidev/cli"];
-var resolveOptions = (option) => isObject(option) ? option : {};
 var zayne = (options = {}, userConfigs = []) => {
   const {
     type = "app",
@@ -1734,6 +1777,7 @@ var zayne = (options = {}, userConfigs = []) => {
     /* eslint-enable perfectionist/sort-objects -- I just want to put `type` at the beginning */
     comments: enableComments = true,
     componentExts = [],
+    componentExtsTypeAware = [],
     gitignore: enableGitignore = true,
     imports: enableImports = true,
     jsdoc: enableJsdoc = true,
@@ -1746,7 +1790,6 @@ var zayne = (options = {}, userConfigs = []) => {
     toml: enableToml = true,
     typescript: enableTypeScript = isPackageExists("typescript"),
     unicorn: enableUnicorn = true,
-    vue: enableVue = VuePackages.some((pkg) => isPackageExists(pkg)),
     yaml: enableYaml = true,
     ...restOfOptions
   } = options;
@@ -1791,9 +1834,18 @@ var zayne = (options = {}, userConfigs = []) => {
       sortTsconfig()
     );
   }
+  if (restOfOptions.vue) {
+    componentExts.push("vue");
+    componentExtsTypeAware.push("vue");
+  }
   if (enableTypeScript) {
     configs.push(
-      typescript({ componentExts, stylistic: isStylistic, ...resolveOptions(enableTypeScript) })
+      typescript({
+        componentExts,
+        componentExtsTypeAware,
+        stylistic: isStylistic,
+        ...resolveOptions(enableTypeScript)
+      })
     );
   }
   if (restOfOptions.tailwindcss) {
@@ -1821,14 +1873,18 @@ var zayne = (options = {}, userConfigs = []) => {
   if (enableReact) {
     configs.push(react({ typescript: isTypeAware, ...resolveOptions(enableReact) }));
   }
-  if (enableVue) {
-    configs.push(vue({ typescript: isTypeAware, ...resolveOptions(enableVue) }));
-  }
-  if ("files" in restOfOptions) {
-    throw new Error(
-      `[@zayne-labs/eslint-config] The first argument should not contain the "files" property as the options are supposed to be global. Place it in the second config array instead.`
+  if (restOfOptions.vue) {
+    configs.push(
+      vue({ stylistic: isStylistic, typescript: isTypeAware, ...resolveOptions(restOfOptions.vue) })
     );
   }
+  if (restOfOptions.solid) {
+    configs.push(solid({ typescript: isTypeAware, ...resolveOptions(restOfOptions.solid) }));
+  }
+  assert(
+    !("files" in restOfOptions),
+    `[@zayne-labs/eslint-config] The first argument should not contain the "files" property as the options are supposed to be global. Place it in the second config array instead.`
+  );
   let composer = new FlatConfigComposer();
   composer = composer.append(...configs, ...userConfigs);
   if (autoRenamePlugins) {
@@ -1837,6 +1893,6 @@ var zayne = (options = {}, userConfigs = []) => {
   return composer;
 };
 
-export { GLOB_ALL_SRC, GLOB_ASTRO, GLOB_ASTRO_TS, GLOB_CSS, GLOB_EXCLUDE, GLOB_GRAPHQL, GLOB_HTML, GLOB_JS, GLOB_JSON, GLOB_JSON5, GLOB_JSONC, GLOB_JSX, GLOB_LESS, GLOB_MARKDOWN, GLOB_MARKDOWN_CODE, GLOB_MARKDOWN_IN_MARKDOWN, GLOB_POSTCSS, GLOB_SCSS, GLOB_SRC, GLOB_SRC_EXT, GLOB_STYLES, GLOB_SVELTE, GLOB_SVG, GLOB_TESTS, GLOB_TOML, GLOB_TS, GLOB_TSX, GLOB_VUE, GLOB_XML, GLOB_YAML, combine, comments, ensurePackages, gitIgnores, ignores, imports, interopDefault, isObject, isPackageInScope, javascript, jsdoc, jsonc, node, perfectionist, react, renamePluginInConfigs, renamePlugins, renameRules, sortPackageJson, sortTsconfig, stylistic, tailwindcss, tanstack, toml, typescript, unicorn, vue, yaml, zayne };
+export { GLOB_ALL_SRC, GLOB_ASTRO, GLOB_ASTRO_TS, GLOB_CSS, GLOB_EXCLUDE, GLOB_GRAPHQL, GLOB_HTML, GLOB_JS, GLOB_JSON, GLOB_JSON5, GLOB_JSONC, GLOB_JSX, GLOB_LESS, GLOB_MARKDOWN, GLOB_MARKDOWN_CODE, GLOB_MARKDOWN_IN_MARKDOWN, GLOB_POSTCSS, GLOB_SCSS, GLOB_SRC, GLOB_SRC_EXT, GLOB_STYLES, GLOB_SVELTE, GLOB_SVG, GLOB_TESTS, GLOB_TOML, GLOB_TS, GLOB_TSX, GLOB_VUE, GLOB_XML, GLOB_YAML, combine, comments, ensurePackages, gitIgnores, ignores, imports, interopDefault, isObject, isPackageInScope, javascript, jsdoc, jsonc, node, perfectionist, react, renamePluginInConfigs, renamePlugins, renameRules, resolveOptions, solid, sortPackageJson, sortTsconfig, stylistic, tailwindcss, tanstack, toml, typescript, unicorn, vue, yaml, zayne };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map