@curev/eslint-config 0.2.2 → 0.3.0

package/src/factory.ts

@@ -0,0 +1,255 @@
+import process from "node:process";
+import fs from "node:fs";
+import { isPackageExists } from "local-pkg";
+import type { Awaitable, FlatConfigItem, OptionsConfig, UserConfigItem } from "./types";
+import {
+  comments,
+  ignores,
+  imports,
+  javascript,
+  jsdoc,
+  jsonc,
+  markdown,
+  node,
+  perfectionist,
+  react,
+  sortPackageJson,
+  sortTsconfig,
+  stylistic,
+  svelte,
+  test,
+  toml,
+  typescript,
+  unicorn,
+  unocss,
+  vue,
+  yaml
+} from "./configs";
+import { combine, interopDefault } from "./utils";
+import { formatters } from "./configs/formatters";
+
+const flatConfigProps: (keyof FlatConfigItem)[] = [
+  "name",
+  "files",
+  "ignores",
+  "languageOptions",
+  "linterOptions",
+  "processor",
+  "plugins",
+  "rules",
+  "settings"
+];
+
+const VuePackages = [
+  "vue",
+  "nuxt",
+  "vitepress",
+  "@slidev/cli"
+];
+
+/**
+ * Construct an array of ESLint flat config items.
+ */
+export async function curev(
+  options: OptionsConfig & FlatConfigItem = {},
+  ...userConfigs: Awaitable<UserConfigItem | UserConfigItem[]>[]
+): Promise<UserConfigItem[]> {
+  const {
+    componentExts = [],
+    gitignore: enableGitignore = true,
+    isInEditor = !!((process.env.VSCODE_PID || process.env.JETBRAINS_IDE || process.env.VIM) && !process.env.CI),
+    react: enableReact = false,
+    svelte: enableSvelte = false,
+    typescript: enableTypeScript = isPackageExists("typescript"),
+    unocss: enableUnoCSS = false,
+    vue: enableVue = VuePackages.some(i => isPackageExists(i))
+  } = options;
+
+  const stylisticOptions = options.stylistic === false
+    ? false
+    : typeof options.stylistic === "object"
+      ? options.stylistic
+      : {};
+
+  if (stylisticOptions && !("jsx" in stylisticOptions)) {
+    stylisticOptions.jsx = options.jsx ?? true;
+  }
+
+  const configs: Awaitable<FlatConfigItem[]>[] = [];
+
+  if (enableGitignore) {
+    if (typeof enableGitignore !== "boolean") {
+      configs.push(interopDefault(import("eslint-config-flat-gitignore")).then(r => [r(enableGitignore)]));
+    } else {
+      if (fs.existsSync(".gitignore")) {
+        configs.push(interopDefault(import("eslint-config-flat-gitignore")).then(r => [r()]));
+      }
+    }
+  }
+
+  // Base configs
+  configs.push(
+    ignores(),
+    javascript({
+      isInEditor,
+      overrides: getOverrides(options, "javascript")
+    }),
+    comments(),
+    node(),
+    jsdoc({
+      stylistic: stylisticOptions
+    }),
+    imports({
+      stylistic: stylisticOptions
+    }),
+    unicorn(),
+
+    // Optional plugins (installed but not enabled by default)
+    perfectionist()
+  );
+
+  if (enableVue) {
+    componentExts.push("vue");
+  }
+
+  if (enableTypeScript) {
+    configs.push(typescript({
+      ...resolveSubOptions(options, "typescript"),
+      componentExts,
+      overrides: getOverrides(options, "typescript")
+    }));
+  }
+
+  if (stylisticOptions) {
+    configs.push(stylistic({
+      ...stylisticOptions,
+      overrides: getOverrides(options, "stylistic")
+    }));
+  }
+
+  if (options.test ?? true) {
+    configs.push(test({
+      isInEditor,
+      overrides: getOverrides(options, "test")
+    }));
+  }
+
+  if (enableVue) {
+    configs.push(vue({
+      ...resolveSubOptions(options, "vue"),
+      overrides: getOverrides(options, "vue"),
+      stylistic: stylisticOptions,
+      typescript: !!enableTypeScript
+    }));
+  }
+
+  if (enableReact) {
+    configs.push(react({
+      overrides: getOverrides(options, "react"),
+      typescript: !!enableTypeScript
+    }));
+  }
+
+  if (enableSvelte) {
+    configs.push(svelte({
+      overrides: getOverrides(options, "svelte"),
+      stylistic: stylisticOptions,
+      typescript: !!enableTypeScript
+    }));
+  }
+
+  if (enableUnoCSS) {
+    configs.push(unocss({
+      ...resolveSubOptions(options, "unocss"),
+      overrides: getOverrides(options, "unocss")
+    }));
+  }
+
+  if (options.jsonc ?? true) {
+    configs.push(
+      jsonc({
+        overrides: getOverrides(options, "jsonc"),
+        stylistic: stylisticOptions
+      }),
+      sortPackageJson(),
+      sortTsconfig()
+    );
+  }
+
+  if (options.yaml ?? true) {
+    configs.push(yaml({
+      overrides: getOverrides(options, "yaml"),
+      stylistic: stylisticOptions
+    }));
+  }
+
+  if (options.toml ?? true) {
+    configs.push(toml({
+      overrides: getOverrides(options, "toml"),
+      stylistic: stylisticOptions
+    }));
+  }
+
+  if (options.markdown ?? true) {
+    configs.push(
+      markdown(
+        {
+          componentExts,
+          overrides: getOverrides(options, "markdown")
+        }
+      )
+    );
+  }
+
+  if (options.formatters) {
+    configs.push(formatters(
+      options.formatters,
+      typeof stylisticOptions === "boolean" ? {} : stylisticOptions
+    ));
+  }
+
+  // User can optionally pass a flat config item to the first argument
+  // We pick the known keys as ESLint would do schema validation
+  const fusedConfig = flatConfigProps.reduce((acc, key) => {
+    if (key in options) {
+      acc[key] = options[key] as any;
+    }
+    return acc;
+  }, {} as FlatConfigItem);
+  if (Object.keys(fusedConfig).length) {
+    configs.push([fusedConfig]);
+  }
+
+  const merged = combine(
+    ...configs,
+    ...userConfigs
+  );
+
+  return merged;
+}
+
+export type ResolvedOptions<T> = T extends boolean
+  ? never
+  : NonNullable<T>;
+
+export function resolveSubOptions<K extends keyof OptionsConfig>(
+  options: OptionsConfig,
+  key: K
+): ResolvedOptions<OptionsConfig[K]> {
+  return typeof options[key] === "boolean"
+    ? {} as any
+    : options[key] || {};
+}
+
+export function getOverrides<K extends keyof OptionsConfig>(
+  options: OptionsConfig,
+  key: K
+) {
+  const sub = resolveSubOptions(options, key);
+  return {
+    ...(options.overrides as any)?.[key],
+    ..."overrides" in sub
+      ? sub.overrides
+      : {}
+  };
+}

package/src/globs.ts

@@ -0,0 +1,81 @@
+export const GLOB_SRC_EXT = "?([cm])[jt]s?(x)";
+export const GLOB_SRC = "**/*.?([cm])[jt]s?(x)";
+
+export const GLOB_JS = "**/*.?([cm])js";
+export const GLOB_JSX = "**/*.?([cm])jsx";
+
+export const GLOB_TS = "**/*.?([cm])ts";
+export const GLOB_TSX = "**/*.?([cm])tsx";
+
+export const GLOB_STYLE = "**/*.{c,le,sc}ss";
+export const GLOB_CSS = "**/*.css";
+export const GLOB_POSTCSS = "**/*.{p,post}css";
+export const GLOB_LESS = "**/*.less";
+export const GLOB_SCSS = "**/*.scss";
+
+export const GLOB_JSON = "**/*.json";
+export const GLOB_JSON5 = "**/*.json5";
+export const GLOB_JSONC = "**/*.jsonc";
+
+export const GLOB_MARKDOWN = "**/*.md";
+export const GLOB_MARKDOWN_IN_MARKDOWN = "**/*.md/*.md";
+export const GLOB_SVELTE = "**/*.svelte";
+export const GLOB_VUE = "**/*.vue";
+export const GLOB_YAML = "**/*.y?(a)ml";
+export const GLOB_TOML = "**/*.toml";
+export const GLOB_HTML = "**/*.htm?(l)";
+
+export const GLOB_MARKDOWN_CODE = `${GLOB_MARKDOWN}/${GLOB_SRC}`;
+
+export const GLOB_TESTS = [
+  `**/__tests__/**/*.${GLOB_SRC_EXT}`,
+  `**/*.spec.${GLOB_SRC_EXT}`,
+  `**/*.test.${GLOB_SRC_EXT}`,
+  `**/*.bench.${GLOB_SRC_EXT}`,
+  `**/*.benchmark.${GLOB_SRC_EXT}`
+];
+
+export const GLOB_ALL_SRC = [
+  GLOB_SRC,
+  GLOB_STYLE,
+  GLOB_JSON,
+  GLOB_JSON5,
+  GLOB_MARKDOWN,
+  GLOB_SVELTE,
+  GLOB_VUE,
+  GLOB_YAML,
+  GLOB_HTML
+];
+
+export const GLOB_EXCLUDE = [
+  "**/node_modules",
+  "**/dist",
+  "**/package-lock.json",
+  "**/yarn.lock",
+  "**/pnpm-lock.yaml",
+  "**/bun.lockb",
+
+  "**/output",
+  "**/coverage",
+  "**/temp",
+  "**/.temp",
+  "**/tmp",
+  "**/.tmp",
+  "**/.history",
+  "**/.vitepress/cache",
+  "**/.nuxt",
+  "**/.next",
+  "**/.vercel",
+  "**/.changeset",
+  "**/.idea",
+  "**/.cache",
+  "**/.output",
+  "**/.vite-inspect",
+
+  "**/CHANGELOG*.md",
+  "**/*.min.*",
+  "**/LICENSE*",
+  "**/__snapshots__",
+  "**/auto-import?(s).d.ts",
+  "**/components.d.ts"
+];

package/src/index.ts

@@ -0,0 +1,9 @@
+import { curev } from "./factory";
+
+export * from "./configs";
+export * from "./factory";
+export * from "./globs";
+export * from "./types";
+export * from "./utils";
+
+export default curev;

package/src/plugins.ts

@@ -0,0 +1,10 @@
+// eslint-disable-next-line ts/ban-ts-comment
+// @ts-nocheck
+
+export { default as pluginAntfu } from "eslint-plugin-antfu";
+export { default as pluginComments } from "eslint-plugin-eslint-comments";
+export * as pluginImport from "eslint-plugin-i";
+export { default as pluginNode } from "eslint-plugin-n";
+export { default as pluginUnicorn } from "eslint-plugin-unicorn";
+export { default as pluginUnusedImports } from "eslint-plugin-unused-imports";
+export { default as pluginPerfectionist } from "eslint-plugin-perfectionist";

package/src/stub.d.ts

@@ -0,0 +1,3 @@
+declare module "eslint-plugin-react"
+declare module "eslint-plugin-react-hooks"
+declare module "eslint-plugin-react-refresh"