@curev/eslint-config 0.2.1 → 0.3.0

package/src/configs/formatters.ts

@@ -0,0 +1,187 @@
+import { GLOB_CSS, GLOB_LESS, GLOB_MARKDOWN, GLOB_POSTCSS, GLOB_SCSS } from "../globs";
+import type { VendoredPrettierOptions } from "../vender/prettier-types";
+import { ensurePackages, interopDefault, parserPlain } from "../utils";
+import type { FlatConfigItem, OptionsFormatters, StylisticConfig } from "../types";
+import { StylisticConfigDefaults } from "./stylistic";
+
+export async function formatters(
+  options: OptionsFormatters | true = {},
+  stylistic: StylisticConfig = {}
+): Promise<FlatConfigItem[]> {
+  await ensurePackages([
+    "eslint-plugin-format"
+  ]);
+
+  if (options === true) {
+    options = {
+      css: true,
+      graphql: true,
+      html: true,
+      markdown: true
+    };
+  }
+
+  const {
+    indent,
+    quotes,
+    semi
+  } = {
+    ...StylisticConfigDefaults,
+    ...stylistic
+  };
+
+  const prettierOptions: VendoredPrettierOptions = Object.assign(
+    {
+      endOfLine: "auto",
+      semi,
+      singleQuote: quotes === "single",
+      tabWidth: typeof indent === "number" ? indent : 2,
+      trailingComma: "all",
+      useTabs: indent === "tab"
+    } satisfies VendoredPrettierOptions,
+    options.prettierOptions || {}
+  );
+
+  const dprintOptions = Object.assign(
+    {
+      indentWidth: typeof indent === "number" ? indent : 2,
+      quoteStyle: quotes === "single" ? "preferSingle" : "preferDouble",
+      useTabs: indent === "tab"
+    },
+    options.dprintOptions || {}
+  );
+
+  const pluginFormat = await interopDefault(import("eslint-plugin-format"));
+
+  const configs: FlatConfigItem[] = [
+    {
+      name: "curev:formatters:setup",
+      plugins: {
+        format: pluginFormat
+      }
+    }
+  ];
+
+  if (options.css) {
+    configs.push(
+      {
+        files: [GLOB_CSS, GLOB_POSTCSS],
+        languageOptions: {
+          parser: parserPlain
+        },
+        name: "curev:formatter:css",
+        rules: {
+          "format/prettier": [
+            "error",
+            {
+              ...prettierOptions,
+              parser: "css"
+            }
+          ]
+        }
+      },
+      {
+        files: [GLOB_SCSS],
+        languageOptions: {
+          parser: parserPlain
+        },
+        name: "curev:formatter:scss",
+        rules: {
+          "format/prettier": [
+            "error",
+            {
+              ...prettierOptions,
+              parser: "scss"
+            }
+          ]
+        }
+      },
+      {
+        files: [GLOB_LESS],
+        languageOptions: {
+          parser: parserPlain
+        },
+        name: "curev:formatter:less",
+        rules: {
+          "format/prettier": [
+            "error",
+            {
+              ...prettierOptions,
+              parser: "less"
+            }
+          ]
+        }
+      }
+    );
+  }
+
+  if (options.html) {
+    configs.push({
+      files: ["**/*.html"],
+      languageOptions: {
+        parser: parserPlain
+      },
+      name: "curev:formatter:html",
+      rules: {
+        "format/prettier": [
+          "error",
+          {
+            ...prettierOptions,
+            parser: "html"
+          }
+        ]
+      }
+    });
+  }
+
+  if (options.markdown) {
+    const formater = options.markdown === true
+      ? "prettier"
+      : options.markdown;
+
+    configs.push({
+      files: [GLOB_MARKDOWN],
+      languageOptions: {
+        parser: parserPlain
+      },
+      name: "curev:formatter:markdown",
+      rules: {
+        [`format/${formater}`]: [
+          "error",
+          formater === "prettier"
+            ? {
+                printWidth: 120,
+                ...prettierOptions,
+                embeddedLanguageFormatting: "off",
+                parser: "markdown"
+              }
+            : {
+                ...dprintOptions,
+                language: "markdown"
+              }
+        ]
+      }
+    });
+  }
+
+  if (options.graphql) {
+    configs.push({
+      files: ["**/*.graphql"],
+      languageOptions: {
+        parser: parserPlain
+      },
+      name: "curev:formatter:graphql",
+      rules: {
+        "format/prettier": [
+          "error",
+          {
+            ...prettierOptions,
+            parser: "graphql"
+          }
+        ]
+      }
+    });
+  }
+
+  return configs;
+}

package/src/configs/ignores.ts

@@ -0,0 +1,10 @@
+import type { FlatConfigItem } from "../types";
+import { GLOB_EXCLUDE } from "../globs";
+
+export async function ignores(): Promise<FlatConfigItem[]> {
+  return [
+    {
+      ignores: GLOB_EXCLUDE
+    }
+  ];
+}

package/src/configs/imports.ts

@@ -0,0 +1,46 @@
+import type { FlatConfigItem, OptionsStylistic } from "../types";
+import { pluginAntfu, pluginImport } from "../plugins";
+import { GLOB_SRC_EXT } from "../globs";
+
+export async function imports(options: OptionsStylistic = {}): Promise<FlatConfigItem[]> {
+  const {
+    stylistic = true
+  } = options;
+
+  return [
+    {
+      name: "curev:imports",
+      plugins: {
+        curev: pluginAntfu,
+        import: pluginImport
+      },
+      rules: {
+        "antfu/import-dedupe": "error",
+        "antfu/no-import-dist": "error",
+        "antfu/no-import-node-modules-by-path": "error",
+
+        "import/first": "error",
+        "import/no-duplicates": "error",
+        "import/no-mutable-exports": "error",
+        "import/no-named-default": "error",
+        "import/no-self-import": "error",
+        "import/no-webpack-loader-syntax": "error",
+        "import/order": "error",
+
+        ...stylistic
+          ? {
+              "import/newline-after-import": ["error", { considerComments: true, count: 1 }]
+            }
+          : {}
+      }
+    },
+    {
+      files: ["**/bin/**/*", `**/bin.${GLOB_SRC_EXT}`],
+      name: "curev:imports:bin",
+      rules: {
+        "antfu/no-import-dist": "off",
+        "antfu/no-import-node-modules-by-path": "off"
+      }
+    }
+  ];
+}

package/src/configs/index.ts

@@ -0,0 +1,21 @@
+export * from "./comments";
+export * from "./ignores";
+export * from "./imports";
+export * from "./javascript";
+export * from "./jsdoc";
+export * from "./jsonc";
+export * from "./markdown";
+export * from "./node";
+export * from "./perfectionist";
+export * from "./formatters";
+export * from "./react";
+export * from "./sort";
+export * from "./stylistic";
+export * from "./svelte";
+export * from "./test";
+export * from "./typescript";
+export * from "./unicorn";
+export * from "./unocss";
+export * from "./vue";
+export * from "./yaml";
+export * from "./toml";

package/src/configs/javascript.ts

@@ -0,0 +1,277 @@
+import globals from "globals";
+import type { FlatConfigItem, OptionsIsInEditor, OptionsOverrides } from "../types";
+import { pluginAntfu, pluginUnusedImports } from "../plugins";
+import { GLOB_SRC, GLOB_SRC_EXT } from "../globs";
+
+export async function javascript(
+  options: OptionsIsInEditor & OptionsOverrides = {}
+): Promise<FlatConfigItem[]> {
+  const {
+    isInEditor = false,
+    overrides = {}
+  } = options;
+
+  return [
+    {
+      languageOptions: {
+        ecmaVersion: 2022,
+        globals: {
+          ...globals.browser,
+          ...globals.es2021,
+          ...globals.node,
+          document: "readonly",
+          navigator: "readonly",
+          window: "readonly"
+        },
+        parserOptions: {
+          ecmaFeatures: {
+            jsx: true
+          },
+          ecmaVersion: 2022,
+          sourceType: "module"
+        },
+        sourceType: "module"
+      },
+      linterOptions: {
+        reportUnusedDisableDirectives: true
+      },
+      name: "curev:javascript",
+      plugins: {
+        "antfu": pluginAntfu,
+        "unused-imports": pluginUnusedImports
+      },
+      rules: {
+        "no-var": "warn",
+        "object-shorthand": ["warn", "properties"],
+
+        "accessor-pairs": ["error", { setWithoutGet: true, enforceForClassMembers: true }],
+        "array-callback-return": ["error", {
+          allowImplicit: false,
+          checkForEach: false
+        }],
+        "camelcase": ["error", {
+          allow: ["^UNSAFE_"],
+          properties: "never",
+          ignoreGlobals: true,
+          ignoreImports: true
+        }],
+        "constructor-super": "error",
+        "default-case-last": "error",
+        "eol-last": "error",
+        "eqeqeq": ["error", "always", { null: "ignore" }],
+        "func-call-spacing": ["error", "never"],
+        "generator-star-spacing": ["error", { before: true, after: true }],
+        "lines-between-class-members": ["error", "always", { exceptAfterSingleLine: true }],
+        "multiline-ternary": ["error", "always-multiline"],
+        "new-cap": ["error", { newIsCap: true, capIsNew: false, properties: true }],
+        "new-parens": "error",
+        "no-array-constructor": "error",
+        "no-async-promise-executor": "error",
+        "no-caller": "error",
+        "no-case-declarations": "error",
+        "no-class-assign": "error",
+        "no-compare-neg-zero": "error",
+        "no-cond-assign": "error",
+        "no-const-assign": "error",
+        "no-constant-condition": ["error", { checkLoops: false }],
+        "no-control-regex": "error",
+        "no-debugger": "error",
+        "no-delete-var": "error",
+        "no-dupe-args": "error",
+        "no-dupe-class-members": "error",
+        "no-dupe-keys": "error",
+        "no-duplicate-case": "error",
+        "no-useless-backreference": "error",
+        "no-empty": ["error", { allowEmptyCatch: true }],
+        "no-empty-character-class": "error",
+        "no-empty-pattern": "error",
+        "no-eval": "error",
+        "no-ex-assign": "error",
+        "no-extend-native": "error",
+        "no-extra-bind": "error",
+        "no-extra-boolean-cast": "error",
+        "no-extra-parens": ["error", "functions"],
+        "no-fallthrough": "error",
+        "no-floating-decimal": "error",
+        "no-func-assign": "error",
+        "no-global-assign": "error",
+        "no-implied-eval": "error",
+        "no-import-assign": "error",
+        "no-invalid-regexp": "error",
+        "no-irregular-whitespace": "error",
+        "no-iterator": "error",
+        "no-labels": ["error", { allowLoop: false, allowSwitch: false }],
+        "no-lone-blocks": "error",
+        "no-loss-of-precision": "error",
+        "no-misleading-character-class": "error",
+        "no-prototype-builtins": "error",
+        "no-useless-catch": "error",
+        "no-mixed-operators": ["error", {
+          groups: [
+            ["==", "!=", "===", "!==", ">", ">=", "<", "<="],
+            ["&&", "||"],
+            ["in", "instanceof"]
+          ],
+          allowSamePrecedence: true
+        }],
+        "no-mixed-spaces-and-tabs": "error",
+        "no-multi-spaces": "error",
+        "no-multi-str": "error",
+        "no-new": "error",
+        "no-new-func": "error",
+        "no-new-object": "error",
+        "no-new-symbol": "error",
+        "no-new-wrappers": "error",
+        "no-obj-calls": "error",
+        "no-octal": "error",
+        "no-octal-escape": "error",
+        "no-proto": "error",
+        "no-redeclare": ["error", { builtinGlobals: false }],
+        "no-regex-spaces": "error",
+        "no-return-assign": ["error", "except-parens"],
+        "no-self-assign": ["error", { props: true }],
+        "no-self-compare": "error",
+        "no-sequences": "error",
+        "no-shadow-restricted-names": "error",
+        "no-sparse-arrays": "error",
+        "no-tabs": "error",
+        "no-template-curly-in-string": "error",
+        "no-this-before-super": "error",
+        "no-throw-literal": "error",
+        "no-trailing-spaces": [
+          "error",
+          {
+            skipBlankLines: true
+          }
+        ],
+        "no-multiple-empty-lines": [
+          "error",
+          {
+            max: 3,
+            maxBOF: 0,
+            maxEOF: 1
+          }
+        ],
+        "no-undef": "error",
+        "no-undef-init": "error",
+        "no-unexpected-multiline": "error",
+        "no-unmodified-loop-condition": "error",
+        "no-unneeded-ternary": ["error", { defaultAssignment: false }],
+        "no-unreachable": "error",
+        "no-unreachable-loop": "error",
+        "no-unsafe-finally": "error",
+        "no-unsafe-negation": "error",
+        "no-unused-expressions": ["error", {
+          allowShortCircuit: true,
+          allowTernary: true,
+          allowTaggedTemplates: true
+        }],
+        "no-unused-vars": ["error", {
+          args: "none",
+          caughtErrors: "none",
+          ignoreRestSiblings: true,
+          vars: "all"
+        }],
+        "no-use-before-define": ["error", { functions: false, classes: false, variables: false }],
+        "no-useless-call": "error",
+        "no-useless-computed-key": "error",
+        "no-useless-constructor": "error",
+        "no-useless-escape": "error",
+        "no-useless-rename": "error",
+        "no-useless-return": "error",
+        "no-void": "error",
+        "no-with": "error",
+        "object-curly-newline": ["error", { multiline: true, consistent: true }],
+        "object-curly-spacing": ["error", "always"],
+        "object-property-newline": ["error", { allowMultiplePropertiesPerLine: true }],
+        "one-var": ["error", { initialized: "never" }],
+        "padded-blocks": ["error", { blocks: "never", switches: "never", classes: "never" }],
+        "prefer-const": ["error", { destructuring: "all" }],
+        "prefer-promise-reject-errors": "error",
+        "prefer-regex-literals": ["error", { disallowRedundantWrapping: true }],
+        "rest-spread-spacing": ["error", "never"],
+        "symbol-description": "error",
+        "template-curly-spacing": ["error", "never"],
+        "template-tag-spacing": ["error", "never"],
+        "unicode-bom": ["error", "never"],
+        "use-isnan": ["error", {
+          enforceForSwitchCase: true,
+          enforceForIndexOf: true
+        }],
+        "valid-typeof": ["error", { requireStringLiterals: true }],
+        "wrap-iife": ["error", "any", { functionPrototypeMethods: true }],
+        "yield-star-spacing": ["error", "both"],
+        "yoda": ["error", "never"],
+
+        "import/export": "error",
+        "import/first": "error",
+        "import/no-absolute-path": ["error", { esmodule: true, commonjs: true, amd: false }],
+        "import/no-duplicates": "error",
+        "import/no-named-default": "error",
+        "import/no-webpack-loader-syntax": "error",
+
+        "block-scoped-var": "error",
+        "no-alert": "error",
+        "no-console": ["error", { allow: ["warn", "error"] }],
+        "no-restricted-globals": [
+          "error",
+          { message: "Use `globalThis` instead.", name: "global" },
+          { message: "Use `globalThis` instead.", name: "self" }
+        ],
+        "no-restricted-properties": [
+          "error",
+          { message: "Use `Object.getPrototypeOf` or `Object.setPrototypeOf` instead.", property: "__proto__" },
+          { message: "Use `Object.defineProperty` instead.", property: "__defineGetter__" },
+          { message: "Use `Object.defineProperty` instead.", property: "__defineSetter__" },
+          { message: "Use `Object.getOwnPropertyDescriptor` instead.", property: "__lookupGetter__" },
+          { message: "Use `Object.getOwnPropertyDescriptor` instead.", property: "__lookupSetter__" }
+        ],
+        "no-restricted-syntax": [
+          "error",
+          "DebuggerStatement",
+          "LabeledStatement",
+          "WithStatement",
+          "TSEnumDeclaration[const=true]",
+          "TSExportAssignment"
+        ],
+        "prefer-arrow-callback": [
+          "error",
+          {
+            allowNamedFunctions: false,
+            allowUnboundThis: true
+          }
+        ],
+        "prefer-exponentiation-operator": "error",
+        "prefer-rest-params": "error",
+        "prefer-spread": "error",
+        "prefer-template": "error",
+        "sort-imports": [
+          "error",
+          {
+            allowSeparatedGroups: false,
+            ignoreCase: false,
+            ignoreDeclarationSort: true,
+            ignoreMemberSort: false,
+            memberSyntaxSortOrder: ["none", "all", "multiple", "single"]
+          }
+        ],
+
+        "unused-imports/no-unused-imports": isInEditor ? "off" : "error",
+
+        "unused-imports/no-unused-vars": [
+          "error",
+          { args: "after-used", argsIgnorePattern: "^_", vars: "all", varsIgnorePattern: "^_" }
+        ],
+        "vars-on-top": "error",
+        ...overrides
+      }
+    },
+    {
+      files: [`scripts/${GLOB_SRC}`, `cli.${GLOB_SRC_EXT}`],
+      name: "curev:scripts-overrides",
+      rules: {
+        "no-console": "off"
+      }
+    }
+  ];
+}

package/src/configs/jsdoc.ts

@@ -0,0 +1,41 @@
+import { interopDefault } from "../utils";
+import type { FlatConfigItem, OptionsStylistic } from "../types";
+
+export async function jsdoc(options: OptionsStylistic = {}): Promise<FlatConfigItem[]> {
+  const {
+    stylistic = true
+  } = options;
+
+  return [
+    {
+      name: "curev:jsdoc",
+      plugins: {
+        jsdoc: await interopDefault(import("eslint-plugin-jsdoc"))
+      },
+      rules: {
+        "jsdoc/check-access": "warn",
+        "jsdoc/check-param-names": "warn",
+        "jsdoc/check-property-names": "warn",
+        "jsdoc/check-types": "warn",
+        "jsdoc/empty-tags": "warn",
+        "jsdoc/implements-on-classes": "warn",
+        "jsdoc/no-defaults": "warn",
+        "jsdoc/no-multi-asterisks": "warn",
+        "jsdoc/require-param-name": "warn",
+        "jsdoc/require-property": "warn",
+        "jsdoc/require-property-description": "warn",
+        "jsdoc/require-property-name": "warn",
+        "jsdoc/require-returns-check": "warn",
+        "jsdoc/require-returns-description": "warn",
+        "jsdoc/require-yields-check": "warn",
+
+        ...stylistic
+          ? {
+              "jsdoc/check-alignment": "warn",
+              "jsdoc/multiline-blocks": "warn"
+            }
+          : {}
+      }
+    }
+  ];
+}

package/src/configs/jsonc.ts

@@ -0,0 +1,86 @@
+import type { FlatConfigItem, OptionsFiles, OptionsOverrides, OptionsStylistic } from "../types";
+import { GLOB_JSON, GLOB_JSON5, GLOB_JSONC } from "../globs";
+import { interopDefault } from "../utils";
+
+export async function jsonc(
+  options: OptionsFiles & OptionsStylistic & OptionsOverrides = {}
+): Promise<FlatConfigItem[]> {
+  const {
+    files = [GLOB_JSON, GLOB_JSON5, GLOB_JSONC],
+    overrides = {},
+    stylistic = true
+  } = options;
+
+  const {
+    indent = 2
+  } = typeof stylistic === "boolean" ? {} : stylistic;
+
+  const [
+    pluginJsonc,
+    parserJsonc
+  ] = await Promise.all([
+    interopDefault(import("eslint-plugin-jsonc")),
+    interopDefault(import("jsonc-eslint-parser"))
+  ] as const);
+
+  return [
+    {
+      name: "curev:jsonc:setup",
+      plugins: {
+        jsonc: pluginJsonc as any
+      }
+    },
+    {
+      files,
+      languageOptions: {
+        parser: parserJsonc
+      },
+      name: "curev:jsonc:rules",
+      rules: {
+        "jsonc/no-bigint-literals": "error",
+        "jsonc/no-binary-expression": "error",
+        "jsonc/no-binary-numeric-literals": "error",
+        "jsonc/no-dupe-keys": "error",
+        "jsonc/no-escape-sequence-in-identifier": "error",
+        "jsonc/no-floating-decimal": "error",
+        "jsonc/no-hexadecimal-numeric-literals": "error",
+        "jsonc/no-infinity": "error",
+        "jsonc/no-multi-str": "error",
+        "jsonc/no-nan": "error",
+        "jsonc/no-number-props": "error",
+        "jsonc/no-numeric-separators": "error",
+        "jsonc/no-octal": "error",
+        "jsonc/no-octal-escape": "error",
+        "jsonc/no-octal-numeric-literals": "error",
+        "jsonc/no-parenthesized": "error",
+        "jsonc/no-plus-sign": "error",
+        "jsonc/no-regexp-literals": "error",
+        "jsonc/no-sparse-arrays": "error",
+        "jsonc/no-template-literals": "error",
+        "jsonc/no-undefined-value": "error",
+        "jsonc/no-unicode-codepoint-escapes": "error",
+        "jsonc/no-useless-escape": "error",
+        "jsonc/space-unary-ops": "error",
+        "jsonc/valid-json-number": "error",
+        "jsonc/vue-custom-block/no-parsing-error": "error",
+
+        ...stylistic
+          ? {
+              "jsonc/array-bracket-spacing": ["error", "never"],
+              "jsonc/comma-dangle": ["error", "never"],
+              "jsonc/comma-style": ["error", "last"],
+              "jsonc/indent": ["error", indent],
+              "jsonc/key-spacing": ["error", { afterColon: true, beforeColon: false }],
+              "jsonc/object-curly-newline": ["error", { consistent: true, multiline: true }],
+              "jsonc/object-curly-spacing": ["error", "always"],
+              "jsonc/object-property-newline": ["error", { allowMultiplePropertiesPerLine: true }],
+              "jsonc/quote-props": "error",
+              "jsonc/quotes": "error"
+            }
+          : {},
+
+        ...overrides
+      }
+    }
+  ];
+}