@so1ve/eslint-config 1.0.0-alpha.13 → 1.0.0-alpha.15

package/dist/index.cjs

@@ -360,9 +360,7 @@ const html = () => [
   }
 ];
 
-const ignores = () => [
-  { ignores: GLOB_EXCLUDE }
-];
+const ignores = () => [{ ignores: GLOB_EXCLUDE }];
 
 const imports = (options = {}) => [
   {
@@ -883,9 +881,7 @@ const sortImports = () => [
   }
 ];
 
-const test = ({
-  overrides
-} = {}) => [
+const test = ({ overrides } = {}) => [
   {
     plugins: {
       "no-only-tests": pluginNoOnlyTests__default["default"],
@@ -919,9 +915,7 @@ const test = ({
   }
 ];
 
-const toml = ({
-  overrides
-} = {}) => [
+const toml = ({ overrides } = {}) => [
   {
     plugins: {
       toml: pluginToml__default["default"]
@@ -985,7 +979,8 @@ function warnUnnecessaryOffRules() {
 function typescript({
   componentExts = [],
   parserOptions,
-  overrides
+  overrides,
+  tsconfigPath
 } = {}) {
   const typeAwareRules = {
     "etc/no-assign-mutated-array": "error",
@@ -1038,7 +1033,13 @@ function typescript({
         parserOptions: {
           sourceType: "module",
           extraFileExtensions: componentExts.map((ext) => `.${ext}`),
-          EXPERIMENTAL_useProjectService: true,
+          // Disable this because it doesn't work well with vue
+          // EXPERIMENTAL_useProjectService: true,
+          ...tsconfigPath ? {
+            project: [tsconfigPath],
+            tsconfigRootDir: process.cwd()
+          } : {},
+          // eslint-disable-next-line ts/no-unnecessary-type-assertion
           ...parserOptions
         }
       },
@@ -1131,7 +1132,15 @@ function typescript({
         "ts/prefer-ts-expect-error": "error",
         "ts/no-require-imports": "error",
         "ts/method-signature-style": ["error", "property"],
-        "ts/explicit-member-accessibility": "error",
+        "ts/explicit-member-accessibility": [
+          "error",
+          {
+            accessibility: "explicit",
+            overrides: {
+              constructors: "no-public"
+            }
+          }
+        ],
         // Override JS
         "no-useless-constructor": "off",
         "no-invalid-this": "off",
@@ -1175,7 +1184,7 @@ function typescript({
         "ts/no-non-null-asserted-nullish-coalescing": "error",
         // handled by unused-imports/no-unused-imports
         "ts/no-unused-vars": "off",
-        ...typeAwareRules,
+        ...tsconfigPath ? typeAwareRules : {},
         ...overrides
       }
     },
@@ -1457,9 +1466,7 @@ const vue = ({
   }
 ];
 
-const yaml = ({
-  overrides
-} = {}) => [
+const yaml = ({ overrides } = {}) => [
   {
     plugins: {
       yaml: pluginYaml__default["default"]
@@ -1494,11 +1501,11 @@ function so1ve(options = {}, ...userConfigs) {
   const {
     vue: enableVue = VuePackages.some((i) => localPkg.isPackageExists(i)),
     solid: enableSolid = localPkg.isPackageExists("solid-js"),
-    typescript: enableTypeScript = localPkg.isPackageExists("typescript"),
     gitignore: enableGitignore = true,
     overrides = {},
     componentExts = []
   } = options;
+  let { typescript: enableTypeScript = localPkg.isPackageExists("typescript") } = options;
   const configs = [];
   if (enableGitignore) {
     if (typeof enableGitignore === "boolean") {
@@ -1526,10 +1533,16 @@ function so1ve(options = {}, ...userConfigs) {
     componentExts.push("vue");
   }
   if (enableTypeScript) {
+    if (typeof enableTypeScript !== "object") {
+      enableTypeScript = {
+        tsconfigPath: "tsconfig.json"
+      };
+    }
     configs.push(
       typescript({
         componentExts,
-        overrides: overrides.typescript
+        overrides: overrides.typescript,
+        ...enableTypeScript
       })
     );
   }

package/dist/index.d.ts

@@ -1,11 +1,12 @@
-import { FlatESLintConfigItem } from 'eslint-define-config';
+import so1vePlugin from '@so1ve/eslint-plugin';
+export { default as pluginSo1ve } from '@so1ve/eslint-plugin';
 import { ParserOptions } from '@typescript-eslint/parser';
 export { default as parserTs } from '@typescript-eslint/parser';
 import { FlatGitignoreOptions } from 'eslint-config-flat-gitignore';
+import { Rules, FlatESLintConfigItem } from 'eslint-define-config';
 export { default as pluginComments } from '@eslint-community/eslint-plugin-eslint-comments';
 export { default as pluginHtml } from '@html-eslint/eslint-plugin';
 export { default as parserHtml } from '@html-eslint/parser';
-export { default as pluginSo1ve } from '@so1ve/eslint-plugin';
 export { default as pluginSortImports } from '@so1ve/eslint-plugin-sort-imports';
 export { default as pluginTs } from '@typescript-eslint/eslint-plugin';
 export { default as parserMdx } from 'eslint-mdx';
@@ -34,21 +35,25 @@ export { default as parserToml } from 'toml-eslint-parser';
 export { default as parserVue } from 'vue-eslint-parser';
 export { default as parserYaml } from 'yaml-eslint-parser';
 
-declare const comments: () => FlatESLintConfigItem[];
-
 interface OptionsComponentExts {
     /** Additional extensions for components. */
     componentExts?: string[];
 }
-interface OptionsTypeScriptParserOptions {
+interface OptionsTypeScript {
     /** Additional parser options for TypeScript. */
     parserOptions?: Partial<ParserOptions>;
+    /**
+     * Path to `tsconfig.json`.
+     *
+     * @default "tsconfig.json"
+     */
+    tsconfigPath?: string;
 }
 interface OptionsHasTypeScript {
     typescript?: boolean;
 }
 interface OptionsOverrides {
-    overrides?: FlatESLintConfigItem["rules"];
+    overrides?: ConfigItem["rules"];
 }
 interface Options extends OptionsComponentExts {
     /**
@@ -67,7 +72,7 @@ interface Options extends OptionsComponentExts {
      *
      * @default auto-detect based on the dependencies
      */
-    typescript?: boolean;
+    typescript?: boolean | OptionsTypeScript;
     /**
      * Enable test support.
      *
@@ -118,56 +123,73 @@ interface Options extends OptionsComponentExts {
     formatting?: boolean;
     /** Provide overrides for rules for each integration. */
     overrides?: {
-        javascript?: FlatESLintConfigItem["rules"];
-        typescript?: FlatESLintConfigItem["rules"];
-        test?: FlatESLintConfigItem["rules"];
-        vue?: FlatESLintConfigItem["rules"];
-        solid?: FlatESLintConfigItem["rules"];
-        jsonc?: FlatESLintConfigItem["rules"];
-        mdx?: FlatESLintConfigItem["rules"];
-        yaml?: FlatESLintConfigItem["rules"];
-        toml?: FlatESLintConfigItem["rules"];
+        javascript?: ConfigItem["rules"];
+        typescript?: ConfigItem["rules"];
+        test?: ConfigItem["rules"];
+        vue?: ConfigItem["rules"];
+        solid?: ConfigItem["rules"];
+        jsonc?: ConfigItem["rules"];
+        mdx?: ConfigItem["rules"];
+        yaml?: ConfigItem["rules"];
+        toml?: ConfigItem["rules"];
     };
 }
+type Unprefix<T extends Record<string, any>, Pre extends string> = {
+    [K in keyof T as K extends `${Pre}${infer U}` ? U : never]: T[K];
+};
+type Prefix<T extends Record<string, any>, Pre extends string> = {
+    [K in keyof T as `${Pre}${K & string}`]: T[K];
+};
+type RenamePrefix<T extends Record<string, any>, Old extends string, New extends string> = Prefix<Unprefix<T, Old>, New>;
+type MergeIntersection<T extends Record<any, any>> = {
+    [K in keyof T]: T[K];
+};
+type RenamedRules = MergeIntersection<Rules & RenamePrefix<Rules, "@typescript-eslint/", "ts/"> & RenamePrefix<Rules, "yml/", "yaml/"> & RenamePrefix<Rules, "n/", "node/"> & Prefix<Partial<(typeof so1vePlugin)["rules"]>, "so1ve/">>;
+type ConfigItem = Omit<FlatESLintConfigItem, "plugins" | "rules"> & {
+    plugins?: Record<string, any>;
+    rules?: RenamedRules | Record<string, any>;
+};
+
+declare const comments: () => ConfigItem[];
 
-declare const formatting: (options: Options) => FlatESLintConfigItem[];
+declare const formatting: (options: Options) => ConfigItem[];
 
-declare const html: () => FlatESLintConfigItem[];
+declare const html: () => ConfigItem[];
 
-declare const ignores: () => FlatESLintConfigItem[];
+declare const ignores: () => ConfigItem[];
 
-declare const imports: (options?: Options) => FlatESLintConfigItem[];
+declare const imports: (options?: Options) => ConfigItem[];
 
-declare const javascript: ({ overrides, }?: OptionsOverrides) => FlatESLintConfigItem[];
+declare const javascript: ({ overrides, }?: OptionsOverrides) => ConfigItem[];
 
-declare const jsonc: () => FlatESLintConfigItem[];
+declare const jsonc: () => ConfigItem[];
 
-declare const mdx: ({ componentExts, overrides, }?: OptionsComponentExts & OptionsOverrides) => FlatESLintConfigItem[];
+declare const mdx: ({ componentExts, overrides, }?: OptionsComponentExts & OptionsOverrides) => ConfigItem[];
 
-declare const node: () => FlatESLintConfigItem[];
+declare const node: () => ConfigItem[];
 
-declare const onlyError: () => FlatESLintConfigItem[];
+declare const onlyError: () => ConfigItem[];
 
-declare const promise: () => FlatESLintConfigItem[];
+declare const promise: () => ConfigItem[];
 
-declare const solid: ({ overrides, typescript, }?: OptionsHasTypeScript & OptionsOverrides) => FlatESLintConfigItem[];
+declare const solid: ({ overrides, typescript, }?: OptionsHasTypeScript & OptionsOverrides) => ConfigItem[];
 
-declare const sortImports: () => FlatESLintConfigItem[];
+declare const sortImports: () => ConfigItem[];
 
-declare const test: ({ overrides, }?: OptionsOverrides) => FlatESLintConfigItem[];
+declare const test: ({ overrides }?: OptionsOverrides) => ConfigItem[];
 
-declare const toml: ({ overrides, }?: OptionsOverrides) => FlatESLintConfigItem[];
+declare const toml: ({ overrides }?: OptionsOverrides) => ConfigItem[];
 
-declare function typescript({ componentExts, parserOptions, overrides, }?: OptionsTypeScriptParserOptions & OptionsComponentExts & OptionsOverrides): FlatESLintConfigItem[];
+declare function typescript({ componentExts, parserOptions, overrides, tsconfigPath, }?: OptionsTypeScript & OptionsComponentExts & OptionsOverrides): ConfigItem[];
 
-declare const unicorn: () => FlatESLintConfigItem[];
+declare const unicorn: () => ConfigItem[];
 
-declare const vue: ({ overrides, typescript, }?: OptionsHasTypeScript & OptionsOverrides) => FlatESLintConfigItem[];
+declare const vue: ({ overrides, typescript, }?: OptionsHasTypeScript & OptionsOverrides) => ConfigItem[];
 
-declare const yaml: ({ overrides, }?: OptionsOverrides) => FlatESLintConfigItem[];
+declare const yaml: ({ overrides }?: OptionsOverrides) => ConfigItem[];
 
 /** Construct an array of ESLint flat config items. */
-declare function so1ve(options?: Options, ...userConfigs: (FlatESLintConfigItem | FlatESLintConfigItem[])[]): FlatESLintConfigItem[];
+declare function so1ve(options?: Options, ...userConfigs: (ConfigItem | ConfigItem[])[]): ConfigItem[];
 
 declare const GLOB_SRC_EXT = "?([cm])[jt]s?(x)";
 declare const GLOB_SRC = "**/*.?([cm])[jt]s?(x)";
@@ -197,12 +219,12 @@ declare const GLOB_ALL_SRC: string[];
 declare const GLOB_EXCLUDE: string[];
 
 /** Combine array and non-array configs into a single array. */
-declare const combine: (...configs: (FlatESLintConfigItem | FlatESLintConfigItem[])[]) => FlatESLintConfigItem[];
+declare const combine: (...configs: (ConfigItem | ConfigItem[])[]) => ConfigItem[];
 declare const renameRules: (rules: Record<string, any>, from: string, to: string) => {
     [k: string]: any;
 };
-declare function recordRulesStateConfigs(configs: FlatESLintConfigItem[]): FlatESLintConfigItem[];
-declare function recordRulesState(rules: FlatESLintConfigItem["rules"]): FlatESLintConfigItem["rules"];
+declare function recordRulesStateConfigs(configs: ConfigItem[]): ConfigItem[];
+declare function recordRulesState(rules: ConfigItem["rules"]): ConfigItem["rules"];
 declare function warnUnnecessaryOffRules(): void;
 
-export { GLOB_ALL_SRC, GLOB_CSS, GLOB_DTS, GLOB_ESLINTRC, GLOB_EXCLUDE, GLOB_HTML, GLOB_JS, GLOB_JSON, GLOB_JSON5, GLOB_JSONC, GLOB_JSX, GLOB_LESS, GLOB_MARKDOWN, GLOB_MARKDOWN_CODE, GLOB_PACKAGEJSON, GLOB_SCSS, GLOB_SRC, GLOB_SRC_EXT, GLOB_STYLE, GLOB_TESTS, GLOB_TOML, GLOB_TS, GLOB_TSCONFIG, GLOB_TSX, GLOB_VUE, GLOB_YAML, Options, OptionsComponentExts, OptionsHasTypeScript, OptionsOverrides, OptionsTypeScriptParserOptions, combine, comments, formatting, html, ignores, imports, javascript, jsonc, mdx, node, onlyError, promise, recordRulesState, recordRulesStateConfigs, renameRules, so1ve, solid, sortImports, test, toml, typescript, unicorn, vue, warnUnnecessaryOffRules, yaml };
+export { ConfigItem, GLOB_ALL_SRC, GLOB_CSS, GLOB_DTS, GLOB_ESLINTRC, GLOB_EXCLUDE, GLOB_HTML, GLOB_JS, GLOB_JSON, GLOB_JSON5, GLOB_JSONC, GLOB_JSX, GLOB_LESS, GLOB_MARKDOWN, GLOB_MARKDOWN_CODE, GLOB_PACKAGEJSON, GLOB_SCSS, GLOB_SRC, GLOB_SRC_EXT, GLOB_STYLE, GLOB_TESTS, GLOB_TOML, GLOB_TS, GLOB_TSCONFIG, GLOB_TSX, GLOB_VUE, GLOB_YAML, Options, OptionsComponentExts, OptionsHasTypeScript, OptionsOverrides, OptionsTypeScript, RenamedRules, combine, comments, formatting, html, ignores, imports, javascript, jsonc, mdx, node, onlyError, promise, recordRulesState, recordRulesStateConfigs, renameRules, so1ve, solid, sortImports, test, toml, typescript, unicorn, vue, warnUnnecessaryOffRules, yaml };

package/dist/index.mjs

@@ -349,9 +349,7 @@ const html = () => [
   }
 ];
 
-const ignores = () => [
-  { ignores: GLOB_EXCLUDE }
-];
+const ignores = () => [{ ignores: GLOB_EXCLUDE }];
 
 const imports = (options = {}) => [
   {
@@ -872,9 +870,7 @@ const sortImports = () => [
   }
 ];
 
-const test = ({
-  overrides
-} = {}) => [
+const test = ({ overrides } = {}) => [
   {
     plugins: {
       "no-only-tests": pluginNoOnlyTests,
@@ -908,9 +904,7 @@ const test = ({
   }
 ];
 
-const toml = ({
-  overrides
-} = {}) => [
+const toml = ({ overrides } = {}) => [
   {
     plugins: {
       toml: pluginToml
@@ -974,7 +968,8 @@ function warnUnnecessaryOffRules() {
 function typescript({
   componentExts = [],
   parserOptions,
-  overrides
+  overrides,
+  tsconfigPath
 } = {}) {
   const typeAwareRules = {
     "etc/no-assign-mutated-array": "error",
@@ -1027,7 +1022,13 @@ function typescript({
         parserOptions: {
           sourceType: "module",
           extraFileExtensions: componentExts.map((ext) => `.${ext}`),
-          EXPERIMENTAL_useProjectService: true,
+          // Disable this because it doesn't work well with vue
+          // EXPERIMENTAL_useProjectService: true,
+          ...tsconfigPath ? {
+            project: [tsconfigPath],
+            tsconfigRootDir: process.cwd()
+          } : {},
+          // eslint-disable-next-line ts/no-unnecessary-type-assertion
           ...parserOptions
         }
       },
@@ -1120,7 +1121,15 @@ function typescript({
         "ts/prefer-ts-expect-error": "error",
         "ts/no-require-imports": "error",
         "ts/method-signature-style": ["error", "property"],
-        "ts/explicit-member-accessibility": "error",
+        "ts/explicit-member-accessibility": [
+          "error",
+          {
+            accessibility: "explicit",
+            overrides: {
+              constructors: "no-public"
+            }
+          }
+        ],
         // Override JS
         "no-useless-constructor": "off",
         "no-invalid-this": "off",
@@ -1164,7 +1173,7 @@ function typescript({
         "ts/no-non-null-asserted-nullish-coalescing": "error",
         // handled by unused-imports/no-unused-imports
         "ts/no-unused-vars": "off",
-        ...typeAwareRules,
+        ...tsconfigPath ? typeAwareRules : {},
         ...overrides
       }
     },
@@ -1446,9 +1455,7 @@ const vue = ({
   }
 ];
 
-const yaml = ({
-  overrides
-} = {}) => [
+const yaml = ({ overrides } = {}) => [
   {
     plugins: {
       yaml: pluginYaml
@@ -1483,11 +1490,11 @@ function so1ve(options = {}, ...userConfigs) {
   const {
     vue: enableVue = VuePackages.some((i) => isPackageExists(i)),
     solid: enableSolid = isPackageExists("solid-js"),
-    typescript: enableTypeScript = isPackageExists("typescript"),
     gitignore: enableGitignore = true,
     overrides = {},
     componentExts = []
   } = options;
+  let { typescript: enableTypeScript = isPackageExists("typescript") } = options;
   const configs = [];
   if (enableGitignore) {
     if (typeof enableGitignore === "boolean") {
@@ -1515,10 +1522,16 @@ function so1ve(options = {}, ...userConfigs) {
     componentExts.push("vue");
   }
   if (enableTypeScript) {
+    if (typeof enableTypeScript !== "object") {
+      enableTypeScript = {
+        tsconfigPath: "tsconfig.json"
+      };
+    }
     configs.push(
       typescript({
         componentExts,
-        overrides: overrides.typescript
+        overrides: overrides.typescript,
+        ...enableTypeScript
       })
     );
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@so1ve/eslint-config",
-  "version": "1.0.0-alpha.13",
+  "version": "1.0.0-alpha.15",
   "author": "Ray <i@mk1.io> (https://github.com/so1ve/)",
   "description": "Ray's eslint config.",
   "keywords": [
@@ -70,8 +70,8 @@
     "toml-eslint-parser": "^0.6.0",
     "vue-eslint-parser": "^9.3.1",
     "yaml-eslint-parser": "^1.2.2",
-    "@so1ve/eslint-plugin": "1.0.0-alpha.13",
-    "@so1ve/eslint-plugin-sort-imports": "1.0.0-alpha.13"
+    "@so1ve/eslint-plugin": "1.0.0-alpha.15",
+    "@so1ve/eslint-plugin-sort-imports": "1.0.0-alpha.15"
   },
   "devDependencies": {
     "eslint": "^8.46.0"