@curev/eslint-config 0.2.1 → 0.3.0

package/src/configs/markdown.ts

@@ -0,0 +1,110 @@
+import { mergeProcessors, processorPassThrough } from "eslint-merge-processors";
+import type { FlatConfigItem, OptionsComponentExts, OptionsFiles, OptionsOverrides } from "../types";
+import { GLOB_MARKDOWN, GLOB_MARKDOWN_CODE, GLOB_MARKDOWN_IN_MARKDOWN } from "../globs";
+import { interopDefault, parserPlain } from "../utils";
+
+export async function markdown(
+  options: OptionsFiles & OptionsComponentExts & OptionsOverrides = {}
+): Promise<FlatConfigItem[]> {
+  const {
+    componentExts = [],
+    files = [GLOB_MARKDOWN],
+    overrides = {}
+  } = options;
+
+  // @ts-expect-error missing types
+  const markdown = await interopDefault(import("eslint-plugin-markdown"));
+
+  return [
+    {
+      name: "curev:markdown:setup",
+      plugins: {
+        markdown
+      }
+    },
+    {
+      files,
+      ignores: [GLOB_MARKDOWN_IN_MARKDOWN],
+      name: "curev:markdown:processor",
+      // `eslint-plugin-markdown` only creates virtual files for code blocks,
+      // but not the markdown file itself. We use `eslint-merge-processors` to
+      // add a pass-through processor for the markdown file itself.
+      processor: mergeProcessors([
+        markdown.processors.markdown,
+        processorPassThrough
+      ])
+    },
+    {
+      files,
+      languageOptions: {
+        parser: parserPlain
+      },
+      name: "curev:markdown:parser"
+    },
+    {
+      files: [
+        GLOB_MARKDOWN_CODE,
+        ...componentExts.map(ext => `${GLOB_MARKDOWN}/**/*.${ext}`)
+      ],
+      languageOptions: {
+        parserOptions: {
+          ecmaFeatures: {
+            impliedStrict: true
+          }
+        }
+      },
+      name: "curev:markdown:disables",
+      rules: {
+        "import/newline-after-import": "off",
+
+        "no-alert": "off",
+        "no-console": "off",
+        "no-labels": "off",
+        "no-lone-blocks": "off",
+        "no-restricted-syntax": "off",
+        "no-undef": "off",
+        "no-unused-expressions": "off",
+        "no-unused-labels": "off",
+        "no-unused-vars": "off",
+
+        "node/prefer-global/process": "off",
+        "style/comma-dangle": "off",
+
+        "style/eol-last": "off",
+        "ts/consistent-type-imports": "off",
+        "ts/no-namespace": "off",
+        "ts/no-redeclare": "off",
+        "ts/no-require-imports": "off",
+        "ts/no-unused-vars": "off",
+        "ts/no-use-before-define": "off",
+        "ts/no-var-requires": "off",
+
+        "unicode-bom": "off",
+        "unused-imports/no-unused-imports": "off",
+        "unused-imports/no-unused-vars": "off",
+
+        // Type aware rules
+        ...{
+          "ts/await-thenable": "off",
+          "ts/dot-notation": "off",
+          "ts/no-floating-promises": "off",
+          "ts/no-for-in-array": "off",
+          "ts/no-implied-eval": "off",
+          "ts/no-misused-promises": "off",
+          "ts/no-throw-literal": "off",
+          "ts/no-unnecessary-type-assertion": "off",
+          "ts/no-unsafe-argument": "off",
+          "ts/no-unsafe-assignment": "off",
+          "ts/no-unsafe-call": "off",
+          "ts/no-unsafe-member-access": "off",
+          "ts/no-unsafe-return": "off",
+          "ts/restrict-plus-operands": "off",
+          "ts/restrict-template-expressions": "off",
+          "ts/unbound-method": "off"
+        },
+
+        ...overrides
+      }
+    }
+  ];
+}

package/src/configs/node.ts

@@ -0,0 +1,24 @@
+import type { FlatConfigItem } from "../types";
+import { pluginNode } from "../plugins";
+
+export async function node(): Promise<FlatConfigItem[]> {
+  return [
+    {
+      name: "curev:node",
+      plugins: {
+        node: pluginNode
+      },
+      rules: {
+        "node/handle-callback-err": ["error", "^(err|error)$"],
+        "node/no-deprecated-api": "error",
+        "node/no-exports-assign": "error",
+        "node/no-new-require": "error",
+        "node/no-path-concat": "error",
+        "node/prefer-global/buffer": ["error", "never"],
+        "node/prefer-global/process": ["error", "never"],
+        "node/process-exit-as-throw": "error",
+        "node/no-callback-literal": "error"
+      }
+    }
+  ];
+}

package/src/configs/perfectionist.ts

@@ -0,0 +1,18 @@
+import type { FlatConfigItem } from "../types";
+import { pluginPerfectionist } from "../plugins";
+
+/**
+ * Optional perfectionist plugin for props and items sorting.
+ *
+ * @see https://github.com/azat-io/eslint-plugin-perfectionist
+ */
+export async function perfectionist(): Promise<FlatConfigItem[]> {
+  return [
+    {
+      name: "curev:perfectionist",
+      plugins: {
+        perfectionist: pluginPerfectionist
+      }
+    }
+  ];
+}

package/src/configs/react.ts

@@ -0,0 +1,111 @@
+import { isPackageExists } from "local-pkg";
+import { ensurePackages, interopDefault } from "../utils";
+import type { FlatConfigItem, OptionsFiles, OptionsHasTypeScript, OptionsOverrides } from "../types";
+import { GLOB_JSX, GLOB_TSX } from "../globs";
+
+// react refresh
+const ReactRefreshAllowConstantExportPackages = [
+  "vite"
+];
+
+export async function react(
+  options: OptionsHasTypeScript & OptionsOverrides & OptionsFiles = {}
+): Promise<FlatConfigItem[]> {
+  const {
+    files = [GLOB_JSX, GLOB_TSX],
+    overrides = {},
+    typescript = true
+  } = options;
+
+  await ensurePackages([
+    "eslint-plugin-react",
+    "eslint-plugin-react-hooks",
+    "eslint-plugin-react-refresh"
+  ]);
+
+  const [
+    pluginReact,
+    pluginReactHooks,
+    pluginReactRefresh
+  ] = await Promise.all([
+    interopDefault(import("eslint-plugin-react")),
+    interopDefault(import("eslint-plugin-react-hooks")),
+    interopDefault(import("eslint-plugin-react-refresh"))
+  ] as const);
+
+  const isAllowConstantExport = ReactRefreshAllowConstantExportPackages.some(
+    i => isPackageExists(i)
+  );
+
+  return [
+    {
+      name: "curev:react:setup",
+      plugins: {
+        "react": pluginReact,
+        "react-hooks": pluginReactHooks,
+        "react-refresh": pluginReactRefresh
+      },
+      settings: {
+        react: {
+          version: "detect"
+        }
+      }
+    },
+    {
+      files,
+      languageOptions: {
+        parserOptions: {
+          ecmaFeatures: {
+            jsx: true
+          }
+        }
+      },
+      name: "curev:react:rules",
+      rules: {
+        // recommended rules react-hooks
+        "react-hooks/exhaustive-deps": "warn",
+        "react-hooks/rules-of-hooks": "error",
+
+        // react refresh
+        "react-refresh/only-export-components": [
+          "warn",
+          { allowConstantExport: isAllowConstantExport }
+        ],
+
+        // recommended rules react
+        "react/display-name": "error",
+        "react/jsx-key": "error",
+        "react/jsx-no-comment-textnodes": "error",
+        "react/jsx-no-duplicate-props": "error",
+        "react/jsx-no-target-blank": "error",
+        "react/jsx-no-undef": "error",
+        "react/jsx-uses-react": "error",
+        "react/jsx-uses-vars": "error",
+        "react/no-children-prop": "error",
+        "react/no-danger-with-children": "error",
+        "react/no-deprecated": "error",
+        "react/no-direct-mutation-state": "error",
+        "react/no-find-dom-node": "error",
+        "react/no-is-mounted": "error",
+        "react/no-render-return-value": "error",
+        "react/no-string-refs": "error",
+        "react/no-unescaped-entities": "error",
+        "react/no-unknown-property": "error",
+        "react/no-unsafe": "off",
+        "react/prop-types": "error",
+        "react/react-in-jsx-scope": "off",
+        "react/require-render-return": "error",
+
+        ...typescript
+          ? {
+              "react/jsx-no-undef": "off",
+              "react/prop-type": "off"
+            }
+          : {},
+
+        // overrides
+        ...overrides
+      }
+    }
+  ];
+}

package/src/configs/sort.ts

@@ -0,0 +1,223 @@
+import type { FlatConfigItem } from "../types";
+
+/**
+ * Sort package.json
+ *
+ * Requires `jsonc` config
+ */
+export async function sortPackageJson(): Promise<FlatConfigItem[]> {
+  return [
+    {
+      files: ["**/package.json"],
+      name: "curev:sort-package-json",
+      rules: {
+        "jsonc/sort-array-values": [
+          "error",
+          {
+            order: { type: "asc" },
+            pathPattern: "^files$"
+          }
+        ],
+        "jsonc/sort-keys": [
+          "error",
+          {
+            order: [
+              "publisher",
+              "name",
+              "displayName",
+              "type",
+              "version",
+              "private",
+              "packageManager",
+              "description",
+              "author",
+              "license",
+              "funding",
+              "homepage",
+              "repository",
+              "bugs",
+              "keywords",
+              "categories",
+              "sideEffects",
+              "exports",
+              "main",
+              "module",
+              "unpkg",
+              "jsdelivr",
+              "types",
+              "typesVersions",
+              "bin",
+              "icon",
+              "files",
+              "engines",
+              "activationEvents",
+              "contributes",
+              "scripts",
+              "peerDependencies",
+              "peerDependenciesMeta",
+              "dependencies",
+              "optionalDependencies",
+              "devDependencies",
+              "pnpm",
+              "overrides",
+              "resolutions",
+              "husky",
+              "simple-git-hooks",
+              "lint-staged",
+              "eslintConfig"
+            ],
+            pathPattern: "^$"
+          },
+          {
+            order: { type: "asc" },
+            pathPattern: "^(?:dev|peer|optional|bundled)?[Dd]ependencies(Meta)?$"
+          },
+          {
+            order: { type: "asc" },
+            pathPattern: "^(?:resolutions|overrides|pnpm.overrides)$"
+          },
+          {
+            order: [
+              "types",
+              "import",
+              "require",
+              "default"
+            ],
+            pathPattern: "^exports.*$"
+          }
+        ]
+      }
+    }
+  ];
+}
+/**
+ * Sort tsconfig.json
+ *
+ * Requires `jsonc` config
+ */
+
+export function sortTsconfig(): FlatConfigItem[] {
+  return [
+    {
+      files: ["**/tsconfig.json", "**/tsconfig.*.json"],
+      name: "curev:sort-tsconfig",
+      rules: {
+        "jsonc/sort-keys": [
+          "error",
+          {
+            order: [
+              "extends",
+              "compilerOptions",
+              "references",
+              "files",
+              "include",
+              "exclude"
+            ],
+            pathPattern: "^$"
+          },
+          {
+            order: [
+              /* Projects */
+              "incremental",
+              "composite",
+              "tsBuildInfoFile",
+              "disableSourceOfProjectReferenceRedirect",
+              "disableSolutionSearching",
+              "disableReferencedProjectLoad",
+              /* Language and Environment */
+              "target",
+              "jsx",
+              "jsxFactory",
+              "jsxFragmentFactory",
+              "jsxImportSource",
+              "lib",
+              "moduleDetection",
+              "noLib",
+              "reactNamespace",
+              "useDefineForClassFields",
+              "emitDecoratorMetadata",
+              "experimentalDecorators",
+              /* Modules */
+              "baseUrl",
+              "rootDir",
+              "rootDirs",
+              "customConditions",
+              "module",
+              "moduleResolution",
+              "moduleSuffixes",
+              "noResolve",
+              "paths",
+              "resolveJsonModule",
+              "resolvePackageJsonExports",
+              "resolvePackageJsonImports",
+              "typeRoots",
+              "types",
+              "allowArbitraryExtensions",
+              "allowImportingTsExtensions",
+              "allowUmdGlobalAccess",
+              /* JavaScript Support */
+              "allowJs",
+              "checkJs",
+              "maxNodeModuleJsDepth",
+              /* Type Checking */
+              "strict",
+              "strictBindCallApply",
+              "strictFunctionTypes",
+              "strictNullChecks",
+              "strictPropertyInitialization",
+              "allowUnreachableCode",
+              "allowUnusedLabels",
+              "alwaysStrict",
+              "exactOptionalPropertyTypes",
+              "noFallthroughCasesInSwitch",
+              "noImplicitAny",
+              "noImplicitOverride",
+              "noImplicitReturns",
+              "noImplicitThis",
+              "noPropertyAccessFromIndexSignature",
+              "noUncheckedIndexedAccess",
+              "noUnusedLocals",
+              "noUnusedParameters",
+              "useUnknownInCatchVariables",
+              /* Emit */
+              "declaration",
+              "declarationDir",
+              "declarationMap",
+              "downlevelIteration",
+              "emitBOM",
+              "emitDeclarationOnly",
+              "importHelpers",
+              "importsNotUsedAsValues",
+              "inlineSourceMap",
+              "inlineSources",
+              "mapRoot",
+              "newLine",
+              "noEmit",
+              "noEmitHelpers",
+              "noEmitOnError",
+              "outDir",
+              "outFile",
+              "preserveConstEnums",
+              "preserveValueImports",
+              "removeComments",
+              "sourceMap",
+              "sourceRoot",
+              "stripInternal",
+              /* Interop Constraints */
+              "allowSyntheticDefaultImports",
+              "esModuleInterop",
+              "forceConsistentCasingInFileNames",
+              "isolatedModules",
+              "preserveSymlinks",
+              "verbatimModuleSyntax",
+              /* Completeness */
+              "skipDefaultLibCheck",
+              "skipLibCheck"
+            ],
+            pathPattern: "^compilerOptions$"
+          }
+        ]
+      }
+    }
+  ];
+}

package/src/configs/stylistic.ts

@@ -0,0 +1,52 @@
+import { interopDefault } from "../utils";
+import type { FlatConfigItem, OptionsOverrides, StylisticConfig } from "../types";
+import { pluginAntfu } from "../plugins";
+
+export const StylisticConfigDefaults: StylisticConfig = {
+  indent: 2,
+  jsx: true,
+  quotes: "double",
+  semi: true,
+  braceStyle: "1tbs",
+  commaDangle: "never"
+};
+
+export async function stylistic(
+  options: StylisticConfig & OptionsOverrides = {}
+): Promise<FlatConfigItem[]> {
+  const mergeOptions = {
+    ...StylisticConfigDefaults,
+    ...options
+  };
+
+  const { overrides = {} } = mergeOptions;
+
+  const pluginStylistic = await interopDefault(import("@stylistic/eslint-plugin"));
+
+  const config = pluginStylistic.configs.customize({
+    flat: true,
+    pluginName: "style",
+    ...mergeOptions
+  });
+
+  return [
+    {
+      name: "curev:stylistic",
+      plugins: {
+        curev: pluginAntfu,
+        style: pluginStylistic
+      },
+      rules: {
+        ...config.rules,
+
+        "antfu/consistent-list-newline": "error",
+        "antfu/if-newline": "error",
+        "antfu/top-level-function": "error",
+        "semi-spacing": ["error", { before: false, after: true }],
+        "style/brace-style": ["error", "1tbs", { allowSingleLine: true }],
+        "curly": ["error", "all"],
+        ...overrides
+      }
+    }
+  ];
+}

package/src/configs/svelte.ts

@@ -0,0 +1,107 @@
+import { ensurePackages, interopDefault } from "../utils";
+import type { FlatConfigItem, OptionsFiles, OptionsHasTypeScript, OptionsOverrides, OptionsStylistic } from "../types";
+import { GLOB_SVELTE } from "../globs";
+
+export async function svelte(
+  options: OptionsHasTypeScript & OptionsOverrides & OptionsStylistic & OptionsFiles = {}
+): Promise<FlatConfigItem[]> {
+  const {
+    files = [GLOB_SVELTE],
+    overrides = {},
+    stylistic = true
+  } = options;
+
+  const {
+    indent = 2,
+    quotes = "single"
+  } = typeof stylistic === "boolean" ? {} : stylistic;
+
+  await ensurePackages([
+    "eslint-plugin-svelte"
+  ]);
+
+  const [
+    pluginSvelte,
+    parserSvelte
+  ] = await Promise.all([
+    interopDefault(import("eslint-plugin-svelte")),
+    interopDefault(import("svelte-eslint-parser"))
+  ] as const);
+
+  return [
+    {
+      name: "curev:svelte:setup",
+      plugins: {
+        svelte: pluginSvelte
+      }
+    },
+    {
+      files,
+      languageOptions: {
+        parser: parserSvelte,
+        parserOptions: {
+          extraFileExtensions: [".svelte"],
+          parser: options.typescript
+            ? await interopDefault(import("@typescript-eslint/parser")) as any
+            : null
+        }
+      },
+      name: "curev:svelte:rules",
+      processor: pluginSvelte.processors[".svelte"],
+      rules: {
+        "import/no-mutable-exports": "off",
+        "no-undef": "off", // incompatible with most recent (attribute-form) generic types RFC
+        "no-unused-vars": ["error", {
+          args: "none",
+          caughtErrors: "none",
+          ignoreRestSiblings: true,
+          vars: "all",
+          varsIgnorePattern: "^\\$\\$Props$"
+        }],
+
+        "svelte/comment-directive": "error",
+        "svelte/no-at-debug-tags": "warn",
+        "svelte/no-at-html-tags": "error",
+        "svelte/no-dupe-else-if-blocks": "error",
+        "svelte/no-dupe-style-properties": "error",
+        "svelte/no-dupe-use-directives": "error",
+        "svelte/no-dynamic-slot-name": "error",
+        "svelte/no-export-load-in-svelte-module-in-kit-pages": "error",
+        "svelte/no-inner-declarations": "error",
+        "svelte/no-not-function-handler": "error",
+        "svelte/no-object-in-text-mustaches": "error",
+        "svelte/no-reactive-functions": "error",
+        "svelte/no-reactive-literals": "error",
+        "svelte/no-shorthand-style-property-overrides": "error",
+        "svelte/no-unknown-style-directive-property": "error",
+        "svelte/no-unused-svelte-ignore": "error",
+        "svelte/no-useless-mustaches": "error",
+        "svelte/require-store-callbacks-use-set-param": "error",
+        "svelte/system": "error",
+        "svelte/valid-compile": "error",
+        "svelte/valid-each-key": "error",
+
+        "unused-imports/no-unused-vars": [
+          "error",
+          { args: "after-used", argsIgnorePattern: "^_", vars: "all", varsIgnorePattern: "^(_|\\$\\$Props$)" }
+        ],
+
+        ...stylistic
+          ? {
+              "style/no-trailing-spaces": "off", // superseded by svelte/no-trailing-spaces
+              "svelte/derived-has-same-inputs-outputs": "error",
+              "svelte/html-closing-bracket-spacing": "error",
+              "svelte/html-quotes": ["error", { prefer: quotes }],
+              "svelte/indent": ["error", { alignAttributesVertically: true, indent }],
+              "svelte/mustache-spacing": "error",
+              "svelte/no-spaces-around-equal-signs-in-attribute": "error",
+              "svelte/no-trailing-spaces": "error",
+              "svelte/spaced-html-comment": "error"
+            }
+          : {},
+
+        ...overrides
+      }
+    }
+  ];
+}