@zayne-labs/eslint-config 0.4.2 → 0.4.3

package/dist/index.d.ts

@@ -14125,7 +14125,7 @@ type Yoda = []|[("always" | "never")]|[("always" | "never"), {
 }]
 
 // Names of all the configs
-type ConfigNames = "zayne/js-eslint/setup" | "zayne/js-eslint/recommended" | "zayne/js-eslint/rules" | "zayne/unicorn/recommended" | "zayne/unicorn/rules" | "zayne/ts-eslint/setup" | "zayne/ts-eslint/strict" | "zayne/ts-eslint/strict" | "zayne/ts-eslint/strict" | "zayne/ts-eslint/stylistic" | "zayne/ts-eslint/stylistic" | "zayne/ts-eslint/stylistic" | "zayne/ts-eslint/rules" | "zayne/tailwindcss/setup" | "zayne/tailwindcss/recommended" | "zayne/tailwindcss/rules" | "zayne/perfectionist/rules" | "zayne/stylistic/rules" | "zayne/import/setup" | "zayne/import/recommended" | "zayne/import/rules" | "zayne/jsdoc/rules" | "zayne/jsonc/setup" | "zayne/jsonc/rules" | "zayne/react/setup" | "zayne/react/recommended" | "zayne/react/rules" | "zayne/react/next" | "zayne/node/setup" | "zayne/node/recommended" | "zayne/node/rules" | "zayne/tanstack/query-recommended" | "zayne/eslint-comments/rules" | "zayne/toml/setup" | "zayne/toml/rules" | "antfu/yaml/setup" | "antfu/yaml/rules" | "zayne/vue/setup" | "zayne/vue/rules"
+type ConfigNames = "zayne/js-eslint/setup" | "zayne/js-eslint/recommended" | "zayne/js-eslint/rules" | "zayne/unicorn/recommended" | "zayne/unicorn/rules" | "zayne/ts-eslint/setup" | "zayne/ts-eslint/strict" | "zayne/ts-eslint/strict" | "zayne/ts-eslint/strict" | "zayne/ts-eslint/stylistic" | "zayne/ts-eslint/stylistic" | "zayne/ts-eslint/stylistic" | "zayne/ts-eslint/rules" | "zayne/tailwindcss/setup" | "zayne/tailwindcss/recommended" | "zayne/tailwindcss/rules" | "zayne/perfectionist/rules" | "zayne/stylistic/rules" | "zayne/import/setup" | "zayne/import/recommended" | "zayne/import/rules" | "zayne/jsdoc/rules" | "zayne/jsonc/setup" | "zayne/jsonc/rules" | "zayne/react/setup" | "zayne/react/recommended" | "zayne/react/rules" | "zayne/react/nextjs" | "zayne/node/setup" | "zayne/node/recommended" | "zayne/node/rules" | "zayne/tanstack/query-recommended" | "zayne/eslint-comments/rules" | "zayne/toml/setup" | "zayne/toml/rules" | "antfu/yaml/setup" | "antfu/yaml/rules" | "zayne/vue/setup" | "zayne/vue/rules"
 
 type LiteralUnion<TUnion extends TBase, TBase = string> = TUnion | (TBase & { _ignore?: never });
 
@@ -14410,6 +14410,12 @@ interface OptionsComponentExts {
      * @default []
      */
     componentExts?: string[];
+    /**
+     * Additional extensions for type aware components.
+     * @example ['vue']
+     * @default []
+     */
+    componentExtsTypeAware?: string[];
 }
 interface OptionsTypeScriptParserOptions {
     /**
@@ -14450,6 +14456,11 @@ interface OptionsHasTypeScript {
     typescript?: boolean;
 }
 interface OptionsReact {
+    /**
+     * Enable react compiler rules.
+     * @default false
+     */
+    compiler?: boolean;
     /**
      * Enable nextjs rules.
      * @default auto-detect-from-dependencies
@@ -14693,7 +14704,7 @@ declare const jsonc: (options?: ExtractOptions<OptionsConfig["jsonc"]>) => Promi
 
 declare const jsdoc: (options?: ExtractOptions<OptionsConfig["jsdoc"]>) => Promise<TypedFlatConfigItem[]>;
 
-declare const react: (options?: OptionsFiles & OptionsHasTypeScript & OptionsOverrides & OptionsReact) => Promise<TypedFlatConfigItem[]>;
+declare const react: (options?: ExtractOptions<OptionsConfig["react"]>) => Promise<TypedFlatConfigItem[]>;
 
 declare const tanstack: (options?: ExtractOptions<OptionsConfig["tanstack"]>) => Promise<TypedFlatConfigItem[]>;
 
@@ -14816,5 +14827,6 @@ declare const isPackageInScope: (name: string) => boolean;
  * @param packages - The packages to ensure are installed.
  */
 declare const ensurePackages: (packages: Array<string | undefined>) => Promise<void>;
+declare const resolveOptions: <TObject>(option: boolean | TObject | undefined) => TObject;
 
-export { type Awaitable, type ConfigNames, type ExtractOptions, 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, type OptionsAppType, type OptionsComponentExts, type OptionsConfig, type OptionsFiles, type OptionsHasJsx, type OptionsHasTypeScript, type OptionsNode, type OptionsOverrides, type OptionsReact, type OptionsRegExp, type OptionsStylistic, type OptionsTailwindCSS, type OptionsTanstack, type OptionsTypeScriptParserOptions, type OptionsTypeScriptWithTypes, type OptionsTypescript$1 as OptionsTypescript, type OptionsVue, type Prettify, type Rules, type TypedFlatConfigItem, 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 { type Awaitable, type ConfigNames, type ExtractOptions, 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, type OptionsAppType, type OptionsComponentExts, type OptionsConfig, type OptionsFiles, type OptionsHasJsx, type OptionsHasTypeScript, type OptionsNode, type OptionsOverrides, type OptionsReact, type OptionsRegExp, type OptionsStylistic, type OptionsTailwindCSS, type OptionsTanstack, type OptionsTypeScriptParserOptions, type OptionsTypeScriptWithTypes, type OptionsTypescript$1 as OptionsTypescript, type OptionsVue, type Prettify, type Rules, type TypedFlatConfigItem, combine, comments, ensurePackages, gitIgnores, ignores, imports, interopDefault, isObject, isPackageInScope, javascript, jsdoc, jsonc, node, perfectionist, react, renamePluginInConfigs, renamePlugins, renameRules, resolveOptions, sortPackageJson, sortTsconfig, stylistic, tailwindcss, tanstack, toml, typescript, unicorn, vue, yaml, zayne };

package/dist/index.js

@@ -1,4 +1,3 @@
-import './chunk-VUNV25KB.js';
 import { fileURLToPath } from 'node:url';
 import { isPackageExists } from 'local-pkg';
 import globals from 'globals';
@@ -6,6 +5,7 @@ import { fixupPluginRules } from '@eslint/compat';
 import { mergeProcessors } from 'eslint-merge-processors';
 import { FlatConfigComposer } from 'eslint-flat-config-utils';
 
+// src/utils.ts
 var isObject = (value) => {
   return typeof value === "object" && value !== null && !Array.isArray(value);
 };
@@ -64,6 +64,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)";
@@ -516,7 +517,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,
@@ -870,12 +871,6 @@ var stylistic = async (options = {}) => {
         },
         ...overrides
       }
-    },
-    {
-      files: [GLOB_YAML],
-      rules: {
-        "stylistic/spaced-comment": "off"
-      }
     }
   ];
 };
@@ -1006,19 +1001,27 @@ 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,
+    typescript: typescript2 = true
+  } = options;
   await ensurePackages([
     "@eslint-react/eslint-plugin",
     "eslint-plugin-react-hooks",
     "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, eslintPluginReactCompiler] = 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'))] : []
+    ...compiler ? [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 +1042,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 +1096,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 +1522,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 +1537,8 @@ var yaml = async (options = {}) => {
           // 	{ avoidEscape: true, prefer: quotes === "backtick" ? "double" : quotes },
           // ],
           "yaml/spaced-comment": "error"
-        } : {},
+        },
+        "stylistic/spaced-comment": "off",
         ...overrides
       }
     }
@@ -1530,13 +1547,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 +1561,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 +1599,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 +1646,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 +1679,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,6 +1715,7 @@ async function vue(options = {}) {
           "vue/space-in-parens": ["error", "never"],
           "vue/template-curly-spacing": "error"
         },
+        "ts-eslint/no-unused-vars": "off",
         ...overrides
       }
     }
@@ -1725,7 +1742,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 +1750,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,
@@ -1791,9 +1808,18 @@ var zayne = (options = {}, userConfigs = []) => {
       sortTsconfig()
     );
   }
+  if (enableVue) {
+    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) {
@@ -1822,7 +1848,7 @@ var zayne = (options = {}, userConfigs = []) => {
     configs.push(react({ typescript: isTypeAware, ...resolveOptions(enableReact) }));
   }
   if (enableVue) {
-    configs.push(vue({ typescript: isTypeAware, ...resolveOptions(enableVue) }));
+    configs.push(vue({ stylistic: isStylistic, ...resolveOptions(enableVue) }));
   }
   if ("files" in restOfOptions) {
     throw new Error(
@@ -1837,6 +1863,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, sortPackageJson, sortTsconfig, stylistic, tailwindcss, tanstack, toml, typescript, unicorn, vue, yaml, zayne };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map