@zayne-labs/eslint-config 0.3.0 → 0.4.0

package/dist/index.js

@@ -1,10 +1,11 @@
+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 { FlatConfigComposer } from 'eslint-flat-config-utils';
 
-// src/utils.ts
 var isObject = (value) => {
   return typeof value === "object" && value !== null && !Array.isArray(value);
 };
@@ -610,7 +611,10 @@ var unicorn = async (options = {}) => {
   const { overrides, type = "app" } = options;
   const eslintPluginUnicorn = await interopDefault(import('eslint-plugin-unicorn'));
   return [
-    { ...eslintPluginUnicorn.configs["flat/recommended"], name: "zayne/unicorn/recommended" },
+    {
+      ...eslintPluginUnicorn.configs["flat/recommended"],
+      name: "zayne/unicorn/recommended"
+    },
     {
       name: "zayne/unicorn/rules",
       rules: {
@@ -866,13 +870,19 @@ var stylistic = async (options = {}) => {
         },
         ...overrides
       }
+    },
+    {
+      files: [GLOB_YAML],
+      rules: {
+        "stylistic/spaced-comment": "off"
+      }
     }
   ];
 };
 
 // src/configs/jsonc.ts
 var jsonc = async (options = {}) => {
-  const { files, overrides, stylistic: stylistic2 = true } = options;
+  const { files = [GLOB_JSON, GLOB_JSON5, GLOB_JSONC], overrides, stylistic: stylistic2 = true } = options;
   const [eslintPluginJsonc, jsoncParser] = await Promise.all([
     interopDefault(import('eslint-plugin-jsonc')),
     interopDefault(import('jsonc-eslint-parser'))
@@ -885,7 +895,7 @@ var jsonc = async (options = {}) => {
       }
     },
     {
-      files: files ?? [GLOB_JSON, GLOB_JSON5, GLOB_JSONC],
+      files,
       languageOptions: {
         parser: jsoncParser
       },
@@ -979,9 +989,9 @@ var defaultPluginRenameMap = {
   "@eslint-react/hooks-extra": "react-hooks-extra",
   "@eslint-react/naming-convention": "react-naming-convention",
   "@eslint-react/web-api": "react-web-api",
-  /* eslint-disable perfectionist/sort-objects */
-  // @eslint-react has to be below the rest to avoid rename issues
+  /* eslint-disable perfectionist/sort-objects -- @eslint-react has to be below the rest to avoid plugin rename issues */
   "@eslint-react": "react",
+  /* eslint-enable perfectionist/sort-objects -- @eslint-react has to be below the rest to avoid plugin rename issues */
   "@next/next": "nextjs-next",
   "@stylistic": "stylistic",
   "@tanstack/query": "tanstack-query",
@@ -1001,8 +1011,7 @@ var react = async (options = {}) => {
     "@eslint-react/eslint-plugin",
     "eslint-plugin-react-hooks",
     "eslint-plugin-react-refresh",
-    ...nextjs ? ["@next/eslint-plugin-next"] : [],
-    "typescript-eslint"
+    ...nextjs ? ["@next/eslint-plugin-next"] : []
   ]);
   const [eslintPluginReact, eslintReactHooks, eslintPluginReactRefresh, eslintPluginNextjs] = await Promise.all([
     interopDefault(import('@eslint-react/eslint-plugin')),
@@ -1091,11 +1100,13 @@ var react = async (options = {}) => {
         "nextjs-next": fixupPluginRules(eslintPluginNextjs)
       },
       rules: renameRules(
-        /* eslint-disable ts-eslint/no-unsafe-argument, ts-eslint/no-unsafe-member-access */
+        // eslint-disable-next-line ts-eslint/no-unsafe-argument -- eslint-plugin-nextjs is not typed
         {
           // @ts-expect-error - eslint-plugin-nextjs is not typed
+          // eslint-disable-next-line ts-eslint/no-unsafe-member-access -- eslint-plugin-nextjs is not typed
           ...eslintPluginNextjs.configs?.recommended?.rules,
           // @ts-expect-error - eslint-plugin-nextjs is not typed
+          // eslint-disable-next-line ts-eslint/no-unsafe-member-access -- eslint-plugin-nextjs is not typed
           ...eslintPluginNextjs.configs?.["core-web-vitals"]?.rules
         },
         defaultPluginRenameMap
@@ -1390,6 +1401,311 @@ var node = async (options = {}) => {
   ];
 };
 
+// src/configs/comments.ts
+var comments = async (options = {}) => {
+  const { overrides, type = "app-strict" } = options;
+  const eslintPluginComments = await interopDefault(
+    import('@eslint-community/eslint-plugin-eslint-comments')
+  );
+  return [
+    {
+      name: "zayne/eslint-comments/rules",
+      plugins: {
+        "eslint-comments": eslintPluginComments
+      },
+      rules: {
+        "eslint-comments/disable-enable-pair": ["error", { allowWholeFile: true }],
+        "eslint-comments/no-aggregating-enable": "error",
+        "eslint-comments/no-duplicate-disable": "error",
+        "eslint-comments/no-unlimited-disable": "error",
+        "eslint-comments/no-unused-enable": "error",
+        "eslint-comments/require-description": "warn",
+        ...type !== "app" && {
+          "eslint-comments/require-description": "warn"
+        },
+        ...overrides
+      }
+    }
+  ];
+};
+
+// src/configs/toml.ts
+var toml = async (options = {}) => {
+  const { files = [GLOB_TOML], overrides, stylistic: stylistic2 = true } = options;
+  const [pluginToml, parserToml] = await Promise.all([
+    interopDefault(import('eslint-plugin-toml')),
+    interopDefault(import('toml-eslint-parser'))
+  ]);
+  return [
+    {
+      name: "zayne/toml/setup",
+      plugins: {
+        toml: pluginToml
+      }
+    },
+    {
+      files,
+      languageOptions: {
+        parser: parserToml
+      },
+      name: "zayne/toml/rules",
+      rules: {
+        "style/spaced-comment": "off",
+        "toml/comma-style": "error",
+        "toml/keys-order": "error",
+        "toml/no-space-dots": "error",
+        "toml/no-unreadable-number-separator": "error",
+        "toml/precision-of-fractional-seconds": "error",
+        "toml/precision-of-integer": "error",
+        "toml/tables-order": "error",
+        "toml/vue-custom-block/no-parsing-error": "error",
+        ...stylistic2 && {
+          "toml/array-bracket-newline": "error",
+          "toml/array-bracket-spacing": "error",
+          "toml/array-element-newline": "error",
+          // "toml/indent": ["error", indent],
+          "toml/inline-table-curly-spacing": "error",
+          "toml/key-spacing": "error",
+          "toml/padding-line-between-pairs": "error",
+          "toml/padding-line-between-tables": "error",
+          "toml/quoted-keys": "error",
+          "toml/spaced-comment": "error",
+          "toml/table-bracket-spacing": "error"
+        },
+        ...overrides
+      }
+    }
+  ];
+};
+
+// src/configs/yaml.ts
+var yaml = async (options = {}) => {
+  const { files = [GLOB_YAML], overrides, stylistic: stylistic2 = true } = options;
+  const [pluginYaml, parserYaml] = await Promise.all([
+    interopDefault(import('eslint-plugin-yml')),
+    interopDefault(import('yaml-eslint-parser'))
+  ]);
+  return [
+    {
+      name: "antfu/yaml/setup",
+      plugins: {
+        yaml: pluginYaml
+      }
+    },
+    {
+      files,
+      languageOptions: {
+        parser: parserYaml
+      },
+      name: "antfu/yaml/rules",
+      rules: {
+        "style/spaced-comment": "off",
+        "yaml/block-mapping": "error",
+        "yaml/block-sequence": "error",
+        "yaml/no-empty-key": "error",
+        "yaml/no-empty-sequence-entry": "error",
+        "yaml/no-irregular-whitespace": "error",
+        "yaml/plain-scalar": "error",
+        "yaml/vue-custom-block/no-parsing-error": "error",
+        ...stylistic2 ? {
+          "yaml/block-mapping-question-indicator-newline": "error",
+          "yaml/block-sequence-hyphen-indicator-newline": "error",
+          "yaml/flow-mapping-curly-newline": "error",
+          "yaml/flow-mapping-curly-spacing": "error",
+          "yaml/flow-sequence-bracket-newline": "error",
+          "yaml/flow-sequence-bracket-spacing": "error",
+          // "yaml/indent": ["error", indent],
+          "yaml/key-spacing": "error",
+          "yaml/no-tab-indent": "error",
+          // "yaml/quotes": [
+          // 	"error",
+          // 	{ avoidEscape: true, prefer: quotes === "backtick" ? "double" : quotes },
+          // ],
+          "yaml/spaced-comment": "error"
+        } : {},
+        ...overrides
+      }
+    }
+  ];
+};
+async function vue(options = {}) {
+  const {
+    files = [GLOB_VUE],
+    indent = 3,
+    overrides,
+    stylistic: stylistic2 = true,
+    typescript: typescript2 = true,
+    vueVersion = 3
+  } = options;
+  const sfcBlocks = options.sfcBlocks === true ? {} : options.sfcBlocks ?? {};
+  await ensurePackages([
+    "eslint-plugin-vue",
+    "vue-eslint-parser",
+    ...sfcBlocks ? ["eslint-processor-vue-blocks"] : []
+  ]);
+  const [pluginVue, parserVue, processorVueBlocks] = await Promise.all([
+    interopDefault(import('eslint-plugin-vue')),
+    interopDefault(import('vue-eslint-parser')),
+    interopDefault(import('eslint-processor-vue-blocks'))
+  ]);
+  return [
+    {
+      // This allows Vue plugin to work with auto imports
+      // https://github.com/vuejs/eslint-plugin-vue/pull/2422
+      languageOptions: {
+        globals: {
+          computed: "readonly",
+          defineEmits: "readonly",
+          defineExpose: "readonly",
+          defineProps: "readonly",
+          onMounted: "readonly",
+          onUnmounted: "readonly",
+          reactive: "readonly",
+          ref: "readonly",
+          shallowReactive: "readonly",
+          shallowRef: "readonly",
+          toRef: "readonly",
+          toRefs: "readonly",
+          watch: "readonly",
+          watchEffect: "readonly"
+        }
+      },
+      name: "zayne/vue/setup",
+      plugins: {
+        vue: pluginVue
+      }
+    },
+    {
+      files,
+      languageOptions: {
+        parser: parserVue,
+        parserOptions: {
+          ecmaFeatures: {
+            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"
+        }
+      },
+      name: "zayne/vue/rules",
+      processor: sfcBlocks === false ? pluginVue.processors[".vue"] : mergeProcessors([
+        pluginVue.processors[".vue"],
+        processorVueBlocks({
+          ...sfcBlocks,
+          blocks: {
+            styles: true,
+            ...sfcBlocks.blocks
+          }
+        })
+      ]),
+      rules: {
+        ...pluginVue.configs.base.rules,
+        ...vueVersion === 2 ? {
+          ...pluginVue.configs.essential.rules,
+          ...pluginVue.configs["strongly-recommended"].rules,
+          ...pluginVue.configs.recommended.rules
+        } : {
+          ...pluginVue.configs["vue3-essential"].rules,
+          ...pluginVue.configs["vue3-strongly-recommended"].rules,
+          ...pluginVue.configs["vue3-recommended"].rules
+        },
+        "node/prefer-global/process": "off",
+        "vue/block-order": [
+          "error",
+          {
+            order: ["script", "template", "style"]
+          }
+        ],
+        "vue/component-name-in-template-casing": ["error", "PascalCase"],
+        "vue/component-options-name-casing": ["error", "PascalCase"],
+        // == this is deprecated
+        "vue/component-tags-order": "off",
+        "vue/custom-event-name-casing": ["error", "camelCase"],
+        "vue/define-macros-order": [
+          "error",
+          {
+            order: ["defineOptions", "defineProps", "defineEmits", "defineSlots"]
+          }
+        ],
+        "vue/dot-location": ["error", "property"],
+        "vue/dot-notation": ["error", { allowKeywords: true }],
+        "vue/eqeqeq": ["error", "smart"],
+        "vue/html-indent": ["error", indent],
+        "vue/html-quotes": ["error", "double"],
+        "vue/max-attributes-per-line": "off",
+        "vue/multi-word-component-names": "off",
+        "vue/no-dupe-keys": "off",
+        "vue/no-empty-pattern": "error",
+        "vue/no-irregular-whitespace": "error",
+        "vue/no-loss-of-precision": "error",
+        "vue/no-restricted-syntax": [
+          "error",
+          "DebuggerStatement",
+          "LabeledStatement",
+          "WithStatement"
+        ],
+        "vue/no-restricted-v-bind": ["error", "/^v-/"],
+        "vue/no-setup-props-reactivity-loss": "off",
+        "vue/no-sparse-arrays": "error",
+        "vue/no-unused-refs": "error",
+        "vue/no-useless-v-bind": "error",
+        "vue/no-v-html": "off",
+        "vue/object-shorthand": [
+          "error",
+          "always",
+          {
+            avoidQuotes: true,
+            ignoreConstructors: false
+          }
+        ],
+        "vue/prefer-separate-static-class": "error",
+        "vue/prefer-template": "error",
+        "vue/prop-name-casing": ["error", "camelCase"],
+        "vue/require-default-prop": "off",
+        "vue/require-prop-types": "off",
+        "vue/space-infix-ops": "error",
+        "vue/space-unary-ops": ["error", { nonwords: false, words: true }],
+        ...stylistic2 && {
+          "vue/array-bracket-spacing": ["error", "never"],
+          "vue/arrow-spacing": ["error", { after: true, before: true }],
+          "vue/block-spacing": ["error", "always"],
+          "vue/block-tag-newline": [
+            "error",
+            {
+              multiline: "always",
+              singleline: "always"
+            }
+          ],
+          "vue/brace-style": ["error", "stroustrup", { allowSingleLine: true }],
+          "vue/comma-dangle": ["error", "always-multiline"],
+          "vue/comma-spacing": ["error", { after: true, before: false }],
+          "vue/comma-style": ["error", "last"],
+          "vue/html-comment-content-spacing": [
+            "error",
+            "always",
+            {
+              exceptions: ["-"]
+            }
+          ],
+          "vue/key-spacing": ["error", { afterColon: true, beforeColon: false }],
+          "vue/keyword-spacing": ["error", { after: true, before: true }],
+          "vue/object-curly-newline": "off",
+          "vue/object-curly-spacing": ["error", "always"],
+          "vue/object-property-newline": ["error", { allowMultiplePropertiesPerLine: true }],
+          "vue/operator-linebreak": ["error", "before"],
+          "vue/padding-line-between-blocks": ["error", "always"],
+          "vue/quote-props": ["error", "consistent-as-needed"],
+          "vue/space-in-parens": ["error", "never"],
+          "vue/template-curly-spacing": "error"
+        },
+        ...overrides
+      }
+    }
+  ];
+}
+
 // src/configs/jsx.ts
 var jsx = () => {
   return [
@@ -1409,35 +1725,54 @@ 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",
+    /* eslint-disable perfectionist/sort-objects -- I just want to put `type` at the beginning */
     autoRenamePlugins = true,
+    /* eslint-enable perfectionist/sort-objects -- I just want to put `type` at the beginning */
+    comments: enableComments = true,
     componentExts = [],
     gitignore: enableGitignore = true,
+    imports: enableImports = true,
+    jsdoc: enableJsdoc = true,
     jsonc: enableJsonc = true,
     jsx: enableJsx = true,
     node: enableNode = true,
     perfectionist: enablePerfectionist = true,
     react: enableReact = ReactPackages.some((pkg) => isPackageExists(pkg)),
     stylistic: enableStylistic = true,
-    type = "app",
+    toml: enableToml = true,
     typescript: enableTypeScript = isPackageExists("typescript"),
     unicorn: enableUnicorn = true,
+    vue: enableVue = VuePackages.some((pkg) => isPackageExists(pkg)),
+    yaml: enableYaml = true,
     ...restOfOptions
   } = options;
   const isStylistic = Boolean(enableStylistic);
   const tsconfigPath = isObject(enableTypeScript) && "tsconfigPath" in enableTypeScript ? enableTypeScript.tsconfigPath : null;
+  const isTypeAware = Boolean(tsconfigPath);
   const configs = [];
+  configs.push(ignores(restOfOptions.ignores), javascript(restOfOptions.javascript));
+  if (enableJsx) {
+    configs.push(jsx());
+  }
+  if (enableStylistic) {
+    configs.push(stylistic({ jsx: enableJsx, ...resolveOptions(enableStylistic) }));
+  }
+  if (enableComments) {
+    configs.push(comments(resolveOptions(enableComments)));
+  }
   if (enableGitignore) {
     configs.push(gitIgnores(resolveOptions(enableGitignore)));
   }
-  configs.push(
-    ignores(restOfOptions.ignores),
-    javascript(restOfOptions.javascript),
-    imports({ stylistic: isStylistic }),
-    jsdoc({ stylistic: isStylistic })
-  );
+  if (enableImports) {
+    configs.push(
+      imports({ stylistic: isStylistic, typescript: isTypeAware, ...resolveOptions(enableImports) })
+    );
+  }
   if (enableNode) {
     configs.push(node({ type, ...resolveOptions(enableNode) }));
   }
@@ -1447,23 +1782,19 @@ var zayne = (options = {}, userConfigs = []) => {
   if (enableUnicorn) {
     configs.push(unicorn({ type, ...resolveOptions(enableUnicorn) }));
   }
+  if (enableJsdoc) {
+    configs.push(jsdoc({ stylistic: isStylistic, ...resolveOptions(enableJsdoc) }));
+  }
   if (enableJsonc) {
     configs.push(
-      jsonc({
-        stylistic: isStylistic,
-        ...resolveOptions(enableJsonc)
-      }),
+      jsonc({ stylistic: isStylistic, ...resolveOptions(enableJsonc) }),
       sortPackageJson(),
       sortTsconfig()
     );
   }
   if (enableTypeScript) {
     configs.push(
-      typescript({
-        componentExts,
-        stylistic: isStylistic,
-        ...resolveOptions(enableTypeScript)
-      })
+      typescript({ componentExts, stylistic: isStylistic, ...resolveOptions(enableTypeScript) })
     );
   }
   if (restOfOptions.tailwindcss) {
@@ -1472,29 +1803,31 @@ var zayne = (options = {}, userConfigs = []) => {
   if (restOfOptions.tanstack) {
     configs.push(tanstack(resolveOptions(restOfOptions.tanstack)));
   }
-  if (enableJsx) {
-    configs.push(jsx());
-  }
-  if (enableStylistic) {
-    const stylisticOptions = resolveOptions(enableStylistic);
+  if (enableToml) {
     configs.push(
-      stylistic({
-        ...stylisticOptions,
-        ...!("jsx" in stylisticOptions) && { jsx: enableJsx }
+      toml({
+        stylistic: isStylistic,
+        ...resolveOptions(enableToml)
       })
     );
   }
-  if (enableReact) {
+  if (enableYaml) {
     configs.push(
-      react({
-        ...resolveOptions(enableReact),
-        typescript: Boolean(tsconfigPath)
+      yaml({
+        stylistic: isStylistic,
+        ...resolveOptions(enableYaml)
       })
     );
   }
+  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.'
+      `[@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();
@@ -1505,6 +1838,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, zayne as default, ensurePackages, gitIgnores, ignores, imports, interopDefault, isObject, isPackageInScope, javascript, jsdoc, jsonc, node, perfectionist, react, renamePluginInConfigs, renamePlugins, renameRules, sortPackageJson, sortTsconfig, stylistic, tailwindcss, tanstack, typescript, unicorn, 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, sortPackageJson, sortTsconfig, stylistic, tailwindcss, tanstack, toml, typescript, unicorn, vue, yaml, zayne };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map