@exbotanical/eslint-config 1.0.0 → 1.1.0

package/dist/index.d.ts

@@ -1952,6 +1952,7 @@ type Rules = RuleOptions;
 type FlatConfigRecord = Omit<Linter.Config<Linter.RulesRecord & Rules>, 'plugins'> & {
     plugins?: Record<string, any>;
 };
+type Awaitable<T> = T | Promise<T>;
 
 interface OptionsIgnores extends AllOptions {
     files?: string[];
@@ -1978,6 +1979,11 @@ interface OptionsTypescript extends AllOptions, OptionsTypeScriptParser {
     typeAwareOverrides?: FlatConfigRecord['rules'];
 }
 
+interface OptionsVue extends AllOptions, OptionsHasTypeScript {
+    vueVersion?: 2 | 3;
+    graphql?: boolean;
+}
+
 interface OptionsOverrides {
     overrides?: FlatConfigRecord['rules'];
 }
@@ -2022,7 +2028,7 @@ interface OptionsConfig extends OptionsProjectType {
     /**
      * Core ruleset. Cannot be disabled.
      */
-    javascript?: OptionsOverrides;
+    javascript?: OptionsOverrides & OptionsFiles;
     /**
      * Enables TypeScript support.
      *
@@ -2039,23 +2045,24 @@ interface OptionsConfig extends OptionsProjectType {
      * Enables Vue rules.
      *
      * Requires installing:
-     * - `eslint-plugin-vue`
-     * - `vue-eslint-parser`
+     * - eslint-plugin-vue
+     * - vue-eslint-parser
+     * - eslint-processor-vue-blocks (only if embedded graphql is enabled)
      *
      * @default false
      */
-    vue?: boolean | OptionsOverrides;
+    vue?: boolean | OptionsVue;
     /**
      * Enables React rules.
      *
      * Requires installing:
-     * - `@eslint-react/eslint-plugin`
-     * - `eslint-plugin-react-hooks`
-     * - `eslint-plugin-react-refresh`
+     * - @eslint-react/eslint-plugin
+     * - eslint-plugin-react-hooks
+     * - eslint-plugin-react-refresh
      *
      * @default false
      */
-    react?: boolean | OptionsOverrides;
+    react?: boolean | (OptionsOverrides & OptionsFiles);
     /**
      * Enables JSONC support.
      */
@@ -2065,7 +2072,7 @@ interface OptionsConfig extends OptionsProjectType {
      *
      * @default true
      */
-    yaml?: boolean | OptionsOverrides;
+    yaml?: boolean | (OptionsOverrides & OptionsFiles);
     /**
      * Enables TOML support.
      *
@@ -2077,7 +2084,7 @@ interface OptionsConfig extends OptionsProjectType {
      * TODO: update rules
      * @default true
      */
-    markdown?: boolean | OptionsOverrides;
+    markdown?: boolean | (OptionsOverrides & OptionsFiles);
     /**
      * Configurable global ignores.
      */
@@ -2092,6 +2099,16 @@ interface OptionsConfig extends OptionsProjectType {
      * @default true
      */
     formatter?: boolean;
+    /**
+     * Enables graphql linting.
+     *
+     * Requires installing:
+     * - @graphql-eslint/eslint-plugin
+     * - eslint-processor-vue-blocks (only if graphql embedded in vue is enabled)
+     
+     * @default false
+     */
+    graphql?: boolean | (OptionsOverrides & OptionsFiles);
 }
 interface OptionsStyle {
     indent?: number | 'tab';
@@ -2101,6 +2118,6 @@ interface OptionsStyle {
 }
 
 type LinterOptions = OptionsConfig;
-declare function exbotanical({ javascript: optionsJavascript, ignores: optionsIgnore, jsonc: optionsJsonc, markdown: optionsMarkdown, toml: optionsToml, yaml: optionsYaml, test: optionsTest, formatter, typescript: optionsTypescript, style: optionsStyle, react: optionsReact, vue: optionsVue, ...otherOptions }: LinterOptions): Promise<FlatConfigRecord[]>;
+declare function exbotanical({ javascript: optionsJavascript, ignores: optionsIgnore, jsonc: optionsJsonc, markdown: optionsMarkdown, toml: optionsToml, yaml: optionsYaml, test: optionsTest, formatter, typescript: optionsTypescript, style: optionsStyle, react: optionsReact, vue: optionsVue, graphql: optionsGraphql, type, }: LinterOptions, ...userConfigs: Awaitable<FlatConfigRecord | FlatConfigRecord[] | Linter.Config[]>[]): Promise<FlatConfigRecord[]>;
 
-export { type AllOptions, type FlatConfigRecord, type OptionsConfig, type OptionsFiles, type OptionsHasTypeScript, type OptionsOverrides, type OptionsProjectType, type OptionsStyle, type OptionsTypeScriptParser, type Rules, exbotanical as default };
+export { type AllOptions, type Awaitable, type FlatConfigRecord, type OptionsConfig, type OptionsFiles, type OptionsHasTypeScript, type OptionsOverrides, type OptionsProjectType, type OptionsStyle, type OptionsTypeScriptParser, type Rules, exbotanical as default };

package/dist/index.js

@@ -24,6 +24,7 @@ async function comments() {
 }
 
 // src/filepaths.ts
+var GLOB_JS = "**/*.?([cm])js";
 var GLOB_JSX = "**/*.?([cm])jsx";
 var GLOB_TS = "**/*.?([cm])ts";
 var GLOB_TSX = "**/*.?([cm])tsx";
@@ -36,6 +37,7 @@ var GLOB_MARKDOWN = "**/*.md";
 var GLOB_VUE = "**/*.vue";
 var GLOB_YAML = "**/*.y?(a)ml";
 var GLOB_TOML = "**/*.toml";
+var GLOB_GRAPHQL = "**/*.{g,graph}ql";
 var GLOB_MARKDOWN_CODE = `${GLOB_MARKDOWN}/${GLOB_SRC}`;
 var GLOB_TESTS = [
   `**/__tests__/**/*.${GLOB_SRC_EXT}`,
@@ -116,6 +118,110 @@ async function disables() {
   ];
 }
 
+// src/utils.ts
+import { fileURLToPath } from "node:url";
+import { isPackageExists } from "local-pkg";
+var parserPlain = {
+  meta: {
+    name: "parser-plain"
+  },
+  parseForESLint: (code) => ({
+    ast: {
+      body: [],
+      comments: [],
+      loc: { end: code.length, start: 0 },
+      range: [0, code.length],
+      tokens: [],
+      type: "Program"
+    },
+    scopeManager: null,
+    services: { isPlain: true },
+    visitorKeys: {
+      Program: []
+    }
+  })
+};
+async function interopDefault(module) {
+  const resolved = await module;
+  return resolved.default || resolved;
+}
+function renameRules(rules, map) {
+  return Object.fromEntries(
+    Object.entries(rules).map(([key, value]) => {
+      for (const [from, to] of Object.entries(map)) {
+        if (key.startsWith(`${from}/`))
+          return [to + key.slice(from.length), value];
+      }
+      return [key, value];
+    })
+  );
+}
+function mergeProcessors(processors) {
+  const cache = /* @__PURE__ */ new Map();
+  return {
+    meta: {
+      name: `merged-processor:${processors.map((processor) => processor.meta?.name || "unknown").join("+")}`
+    },
+    supportsAutofix: true,
+    preprocess(text, filename) {
+      const counts = [];
+      cache.set(filename, counts);
+      return processors.flatMap((processor) => {
+        const result = processor.preprocess?.(text, filename) || [];
+        counts.push(result.length);
+        return result;
+      });
+    },
+    postprocess(messages, filename) {
+      const counts = cache.get(filename);
+      cache.delete(filename);
+      let index = 0;
+      return processors.flatMap((processor, index_) => {
+        const msgs = messages.slice(index, index + counts[index_]);
+        index += counts[index_];
+        return processor.postprocess?.(msgs, filename) || [];
+      });
+    }
+  };
+}
+var processorPassThrough = {
+  meta: {
+    name: "pass-through"
+  },
+  preprocess(text) {
+    return [text];
+  },
+  postprocess(messages) {
+    return messages[0];
+  }
+};
+var scopeUrl = fileURLToPath(new URL(".", import.meta.url));
+
+// src/configs/graphql.ts
+async function graphql() {
+  const graphqlPlugin = await interopDefault(import("@graphql-eslint/eslint-plugin"));
+  const rules = {
+    ...graphqlPlugin.configs["flat/operations-recommended"].rules,
+    ...graphqlPlugin.configs["flat/schema-recommended"].rules
+  };
+  return [
+    {
+      files: [GLOB_JS, GLOB_JSX, GLOB_TS, GLOB_TSX],
+      processor: graphqlPlugin.processor
+    },
+    {
+      files: [GLOB_GRAPHQL],
+      languageOptions: {
+        parser: graphqlPlugin.parser
+      },
+      plugins: {
+        "@graphql-eslint": graphqlPlugin
+      },
+      rules
+    }
+  ];
+}
+
 // src/configs/ignores.ts
 var NAMESPACE3 = "exbotanical/ignores";
 async function ignores({ files = [] } = {}) {
@@ -254,7 +360,8 @@ async function javascript({ overrides = {} } = {}) {
         "no-dupe-else-if": ["error"],
         "no-dupe-keys": ["error"],
         "no-duplicate-case": ["error"],
-        "no-duplicate-imports": ["error"],
+        // See `import` ruleset
+        "no-duplicate-imports": ["off"],
         "no-empty-character-class": ["error"],
         "no-empty-pattern": ["error"],
         "no-unsafe-finally": ["error"],
@@ -468,85 +575,6 @@ async function javascript({ overrides = {} } = {}) {
   ];
 }
 
-// src/utils.ts
-import { fileURLToPath } from "node:url";
-import { isPackageExists } from "local-pkg";
-var parserPlain = {
-  meta: {
-    name: "parser-plain"
-  },
-  parseForESLint: (code) => ({
-    ast: {
-      body: [],
-      comments: [],
-      loc: { end: code.length, start: 0 },
-      range: [0, code.length],
-      tokens: [],
-      type: "Program"
-    },
-    scopeManager: null,
-    services: { isPlain: true },
-    visitorKeys: {
-      Program: []
-    }
-  })
-};
-async function interopDefault(module) {
-  const resolved = await module;
-  return resolved.default || resolved;
-}
-function renameRules(rules, map) {
-  return Object.fromEntries(
-    Object.entries(rules).map(([key, value]) => {
-      for (const [from, to] of Object.entries(map)) {
-        if (key.startsWith(`${from}/`))
-          return [to + key.slice(from.length), value];
-      }
-      return [key, value];
-    })
-  );
-}
-function mergeProcessors(processors) {
-  const cache = /* @__PURE__ */ new Map();
-  return {
-    meta: {
-      name: `merged-processor:${processors.map((processor) => processor.meta?.name || "unknown").join("+")}`
-    },
-    supportsAutofix: true,
-    preprocess(text, filename) {
-      const counts = [];
-      cache.set(filename, counts);
-      return processors.flatMap((processor) => {
-        const result = processor.preprocess?.(text, filename) || [];
-        counts.push(result.length);
-        return result;
-      });
-    },
-    postprocess(messages, filename) {
-      const counts = cache.get(filename);
-      cache.delete(filename);
-      let index = 0;
-      return processors.flatMap((processor, index_) => {
-        const msgs = messages.slice(index, index + counts[index_]);
-        index += counts[index_];
-        return processor.postprocess?.(msgs, filename) || [];
-      });
-    }
-  };
-}
-var processorPassThrough = {
-  meta: {
-    name: "pass-through"
-  },
-  preprocess(text) {
-    return [text];
-  },
-  postprocess(messages) {
-    return messages[0];
-  }
-};
-var scopeUrl = fileURLToPath(new URL(".", import.meta.url));
-
 // src/configs/jsdoc.ts
 var NAMESPACE6 = "exbotanical/jsdoc";
 async function jsdoc() {
@@ -1821,11 +1849,13 @@ async function vue({
   files = [GLOB_VUE],
   overrides = {},
   typescript: typescript2 = true,
-  vueVersion = 3
+  vueVersion = 3,
+  graphql: graphql2 = false
 }, { indent } = STYLE_DEFAULTS) {
-  const [pluginVue, parserVue] = await Promise.all([
+  const [pluginVue, parserVue, processorVueBlocks] = await Promise.all([
     interopDefault(import("eslint-plugin-vue")),
-    interopDefault(import("vue-eslint-parser"))
+    interopDefault(import("vue-eslint-parser")),
+    interopDefault(import("eslint-processor-vue-blocks"))
   ]);
   return [
     {
@@ -1866,7 +1896,16 @@ async function vue({
           sourceType: "module"
         }
       },
-      processor: pluginVue.processors[".vue"],
+      processor: graphql2 === false ? pluginVue.processors[".vue"] : mergeProcessors([
+        pluginVue.processors[".vue"],
+        processorVueBlocks({
+          blocks: {
+            script: true,
+            scriptSetup: true,
+            customBlocks: true
+          }
+        })
+      ]),
       rules: {
         ...pluginVue.configs.base.rules,
         ...vueVersion === 2 ? {
@@ -1893,12 +1932,7 @@ async function vue({
         "vue/define-macros-order": [
           "error",
           {
-            order: [
-              "defineOptions",
-              "defineProps",
-              "defineEmits",
-              "defineSlots"
-            ]
+            order: ["defineOptions", "defineProps", "defineEmits", "defineSlots"]
           }
         ],
         "vue/dot-location": ["error", "property"],
@@ -2050,19 +2084,20 @@ async function exbotanical({
   style: optionsStyle = STYLE_DEFAULTS,
   react: optionsReact,
   vue: optionsVue,
-  ...otherOptions
-}) {
+  graphql: optionsGraphql,
+  type
+}, ...userConfigs) {
   const configs2 = [
     perfectionist(),
     unicorn(),
     comments(),
     imports(),
-    javascript({ ...optionsJavascript, ...otherOptions }),
+    javascript({ ...optionsJavascript, type }),
     jsdoc(),
     jsx(),
     node(),
     regexpr(),
-    test({ ...factoryConfig(optionsTest), ...otherOptions })
+    test({ ...factoryConfig(optionsTest) })
   ];
   if (optionsJsonc) {
     configs2.push(
@@ -2070,41 +2105,39 @@ async function exbotanical({
       tsconfig(),
       jsonc({
         ...factoryConfig(optionsJsonc),
-        ...optionsStyle,
-        ...otherOptions
+        ...optionsStyle
       })
     );
   }
   if (optionsMarkdown) {
-    configs2.push(
-      markdown({ ...factoryConfig(optionsMarkdown), ...otherOptions })
-    );
+    configs2.push(markdown({ ...factoryConfig(optionsMarkdown) }));
+  }
+  if (optionsGraphql) {
+    configs2.push(graphql());
   }
   if (optionsReact) {
-    configs2.push(react({ ...factoryConfig(optionsReact), ...otherOptions }));
+    configs2.push(react({ ...factoryConfig(optionsReact) }));
   }
   if (optionsToml) {
-    configs2.push(
-      toml({ ...factoryConfig(optionsToml), ...optionsStyle, ...otherOptions })
-    );
+    configs2.push(toml({ ...factoryConfig(optionsToml), ...optionsStyle }));
   }
   if (optionsTypescript) {
-    configs2.push(
-      typescript({ ...factoryConfig(optionsTypescript), ...otherOptions })
-    );
+    configs2.push(typescript({ ...factoryConfig(optionsTypescript), type }));
   }
   if (optionsVue) {
-    configs2.push(vue({ ...factoryConfig(optionsVue), ...otherOptions }));
+    configs2.push(vue({ ...factoryConfig(optionsVue), graphql: !!optionsGraphql }));
   }
   if (optionsYaml) {
-    configs2.push(
-      yaml({ ...factoryConfig(optionsYaml), ...optionsStyle, ...otherOptions })
-    );
+    configs2.push(yaml({ ...factoryConfig(optionsYaml), ...optionsStyle }));
   }
   if (formatter) {
     configs2.push(prettier());
   }
-  configs2.push(disables(), ignores({ ...optionsIgnore, ...otherOptions }));
+  configs2.push(disables(), ignores({ ...optionsIgnore }));
+  if (userConfigs.length > 0) {
+    const resolved2 = await Promise.all(userConfigs);
+    configs2.push(...resolved2.map((r) => Promise.resolve(Array.isArray(r) ? r : [r])));
+  }
   const resolved = await Promise.all(configs2);
   return resolved.flat();
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@exbotanical/eslint-config",
   "type": "module",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "private": false,
   "description": "Zito's eslint config",
   "author": "Matthew Zito <exbotanical@protonmail.com> (https://github.com/exbotanical/)",
@@ -34,22 +34,27 @@
     "prepack": "npm run build",
     "prepare": "simple-git-hooks",
     "typecheck": "tsc --noEmit",
-    "release": "npm publish"
+    "release": "bumpp && npm publish"
   },
   "peerDependencies": {
     "@eslint-react/eslint-plugin": "^1.30.1",
+    "@graphql-eslint/eslint-plugin": "^4.3.0",
     "@prettier/plugin-xml": "^3.4.1",
     "eslint": "^9.10.0",
     "eslint-plugin-react-hooks": "^5.0.0",
     "eslint-plugin-react-refresh": "^0.4.4",
     "eslint-plugin-tap": "^1.2.1",
     "eslint-plugin-vue": "^9.32.0",
+    "eslint-processor-vue-blocks": "^2.0.0",
     "vue-eslint-parser": "^9.4.3"
   },
   "peerDependenciesMeta": {
     "@eslint-react/eslint-plugin": {
       "optional": true
     },
+    "@graphql-eslint/eslint-plugin": {
+      "optional": true
+    },
     "@prettier/plugin-xml": {
       "optional": true
     },
@@ -65,6 +70,9 @@
     "eslint-plugin-vue": {
       "optional": true
     },
+    "eslint-processor-vue-blocks": {
+      "optional": true
+    },
     "vue-eslint-parser": {
       "optional": true
     }
@@ -97,7 +105,8 @@
   },
   "devDependencies": {
     "@eslint-react/eslint-plugin": "^1.31.0",
-    "@magister_zito/prettier-config": "^0.0.5",
+    "@exbotanical/prettier-config": "^1.0.1",
+    "@graphql-eslint/eslint-plugin": "^4.3.0",
     "@prettier/plugin-xml": "^3.4.1",
     "@stylistic/eslint-plugin": "^4.2.0",
     "@types/eslint-config-prettier": "^6.11.3",
@@ -107,6 +116,7 @@
     "eslint-plugin-react-hooks": "^5.2.0",
     "eslint-plugin-react-refresh": "^0.4.19",
     "eslint-plugin-vue": "^9.32.0",
+    "eslint-processor-vue-blocks": "^2.0.0",
     "jiti": "^2.4.2",
     "lint-staged": "^15.4.3",
     "simple-git-hooks": "^2.11.1",
@@ -116,7 +126,6 @@
     "vitest": "^3.0.7",
     "vue-eslint-parser": "^10.1.1"
   },
-  "prettier": "@magister_zito/prettier-config",
   "simple-git-hooks": {
     "pre-commit": "npx lint-staged"
   },