@curev/eslint-config 0.3.0 → 0.3.1

package/src/configs/unicorn.ts

@@ -1,41 +0,0 @@
-import type { FlatConfigItem } from "../types";
-import { pluginUnicorn } from "../plugins";
-
-export async function unicorn(): Promise<FlatConfigItem[]> {
-  return [
-    {
-      name: "curev:unicorn",
-      plugins: {
-        unicorn: pluginUnicorn
-      },
-      rules: {
-        // Pass error message when throwing errors
-        "unicorn/error-message": "error",
-        // Uppercase regex escapes
-        "unicorn/escape-case": "error",
-        // Array.isArray instead of instanceof
-        "unicorn/no-instanceof-array": "error",
-        // Ban `new Array` as `Array` constructor's params are ambiguous
-        "unicorn/no-new-array": "error",
-        // Prevent deprecated `new Buffer()`
-        "unicorn/no-new-buffer": "error",
-        // Lowercase number formatting for octal, hex, binary (0x1'error' instead of 0X1'error')
-        "unicorn/number-literal-case": "error",
-        // textContent instead of innerText
-        "unicorn/prefer-dom-node-text-content": "error",
-        // includes over indexOf when checking for existence
-        "unicorn/prefer-includes": "error",
-        // Prefer using the node: protocol
-        "unicorn/prefer-node-protocol": "error",
-        // Prefer using number properties like `Number.isNaN` rather than `isNaN`
-        "unicorn/prefer-number-properties": "error",
-        // String methods startsWith/endsWith instead of more complicated stuff
-        "unicorn/prefer-string-starts-ends-with": "error",
-        // Enforce throwing type error when throwing error while checking typeof
-        "unicorn/prefer-type-error": "error",
-        // Use new when throwing error
-        "unicorn/throw-new-error": "error"
-      }
-    }
-  ];
-}

package/src/configs/unocss.ts

@@ -1,43 +0,0 @@
-import { ensurePackages, interopDefault } from "../utils";
-import type { FlatConfigItem, OptionsUnoCSS } from "../types";
-
-export async function unocss(
-  options: OptionsUnoCSS = {}
-): Promise<FlatConfigItem[]> {
-  const {
-    attributify = true,
-    strict = false
-  } = options;
-
-  await ensurePackages([
-    "@unocss/eslint-plugin"
-  ]);
-
-  const [
-    pluginUnoCSS
-  ] = await Promise.all([
-    interopDefault(import("@unocss/eslint-plugin"))
-  ] as const);
-
-  return [
-    {
-      name: "curev:unocss",
-      plugins: {
-        unocss: pluginUnoCSS
-      },
-      rules: {
-        "unocss/order": "warn",
-        ...attributify
-          ? {
-              "unocss/order-attributify": "warn"
-            }
-          : {},
-        ...strict
-          ? {
-              "unocss/blocklist": "error"
-            }
-          : {}
-      }
-    }
-  ];
-}

package/src/configs/vue.ts

@@ -1,170 +0,0 @@
-import { mergeProcessors } from "eslint-merge-processors";
-import { interopDefault } from "../utils";
-import type { FlatConfigItem, OptionsFiles, OptionsHasTypeScript, OptionsOverrides, OptionsStylistic, OptionsVue } from "../types";
-import { GLOB_VUE } from "../globs";
-
-export async function vue(
-  options: OptionsVue & OptionsHasTypeScript & OptionsOverrides & OptionsStylistic & OptionsFiles = {}
-): Promise<FlatConfigItem[]> {
-  const {
-    files = [GLOB_VUE],
-    overrides = {},
-    stylistic = true,
-    vueVersion = 3
-  } = options;
-
-  const sfcBlocks = options.sfcBlocks === true
-    ? {}
-    : options.sfcBlocks ?? {};
-
-  const {
-    indent = 2
-  } = typeof stylistic === "boolean" ? {} : stylistic;
-
-  const [
-    pluginVue,
-    parserVue,
-    processorVueBlocks
-  ] = await Promise.all([
-    // @ts-expect-error missing types
-    interopDefault(import("eslint-plugin-vue")),
-    interopDefault(import("vue-eslint-parser")),
-    interopDefault(import("eslint-processor-vue-blocks"))
-  ] as const);
-
-  return [
-    {
-      name: "curev:vue:setup",
-      plugins: {
-        vue: pluginVue
-      }
-    },
-    {
-      files,
-      languageOptions: {
-        parser: parserVue,
-        parserOptions: {
-          ecmaFeatures: {
-            jsx: true
-          },
-          extraFileExtensions: [".vue"],
-          parser: options.typescript
-            ? await interopDefault(import("@typescript-eslint/parser")) as any
-            : null,
-          sourceType: "module"
-        }
-      },
-      name: "curev:vue:rules",
-      processor: sfcBlocks === false
-        ? pluginVue.processors[".vue"]
-        : mergeProcessors([
-          pluginVue.processors[".vue"],
-          processorVueBlocks({
-            ...sfcBlocks,
-            blocks: {
-              styles: true,
-              ...sfcBlocks.blocks
-            }
-          })
-        ]),
-      rules: {
-        ...pluginVue.configs.base.rules as any,
-
-        ...vueVersion === 2
-          ? {
-              ...pluginVue.configs.essential.rules as any,
-              ...pluginVue.configs["strongly-recommended"].rules as any,
-              ...pluginVue.configs.recommended.rules as any
-            }
-          : {
-              ...pluginVue.configs["vue3-essential"].rules as any,
-              ...pluginVue.configs["vue3-strongly-recommended"].rules as any,
-              ...pluginVue.configs["vue3-recommended"].rules as any
-            },
-
-        "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 }],
-
-        ...stylistic
-          ? {
-              "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
-      }
-    }
-  ];
-}

package/src/configs/yaml.ts

@@ -1,72 +0,0 @@
-import type { FlatConfigItem, OptionsFiles, OptionsOverrides, OptionsStylistic } from "../types";
-import { GLOB_YAML } from "../globs";
-import { interopDefault } from "../utils";
-
-export async function yaml(
-  options: OptionsOverrides & OptionsStylistic & OptionsFiles = {}
-): Promise<FlatConfigItem[]> {
-  const {
-    files = [GLOB_YAML],
-    overrides = {},
-    stylistic = true
-  } = options;
-
-  const {
-    indent = 2,
-    quotes = "single"
-  } = typeof stylistic === "boolean" ? {} : stylistic;
-
-  const [
-    pluginYaml,
-    parserYaml
-  ] = await Promise.all([
-    interopDefault(import("eslint-plugin-yml")),
-    interopDefault(import("yaml-eslint-parser"))
-  ] as const);
-
-  return [
-    {
-      name: "curev:yaml:setup",
-      plugins: {
-        yaml: pluginYaml
-      }
-    },
-    {
-      files,
-      languageOptions: {
-        parser: parserYaml
-      },
-      name: "curev: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",
-
-        ...stylistic
-          ? {
-              "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 === "tab" ? 2 : indent],
-              "yaml/key-spacing": "error",
-              "yaml/no-tab-indent": "error",
-              "yaml/quotes": ["error", { avoidEscape: false, prefer: quotes }],
-              "yaml/spaced-comment": "error"
-            }
-          : {},
-
-        ...overrides
-      }
-    }
-  ];
-}

package/src/factory.ts

@@ -1,255 +0,0 @@
-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

@@ -1,81 +0,0 @@
-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

@@ -1,9 +0,0 @@
-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

@@ -1,10 +0,0 @@
-// 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

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