@so1ve/eslint-config 1.0.2 → 1.1.0

package/dist/index.cjs

@@ -1540,7 +1540,6 @@ function so1ve(options = {}, ...userConfigs) {
     solid: enableSolid = localPkg.isPackageExists("solid-js"),
     typescript: enableTypeScript = localPkg.isPackageExists("typescript"),
     gitignore: enableGitignore = true,
-    overrides = {},
     componentExts = []
   } = options;
   const configs = [];
@@ -1556,7 +1555,7 @@ function so1ve(options = {}, ...userConfigs) {
   configs.push(
     ignores(),
     javascript({
-      overrides: overrides.javascript
+      overrides: getOverrides(options, "javascript")
     }),
     comments(),
     node(),
@@ -1574,21 +1573,21 @@ function so1ve(options = {}, ...userConfigs) {
     configs.push(
       typescript({
         componentExts,
-        overrides: overrides.typescript
+        overrides: getOverrides(options, "typescript")
       })
     );
   }
   if ((_a = options.test) != null ? _a : true) {
     configs.push(
       test({
-        overrides: overrides.test
+        overrides: getOverrides(options, "test")
       })
     );
   }
   if (enableVue) {
     configs.push(
       vue({
-        overrides: overrides.vue,
+        overrides: getOverrides(options, "vue"),
         typescript: !!enableTypeScript
       })
     );
@@ -1596,7 +1595,7 @@ function so1ve(options = {}, ...userConfigs) {
   if (enableSolid) {
     configs.push(
       solid({
-        overrides: overrides.solid,
+        overrides: getOverrides(options, "solid"),
         typescript: !!enableTypeScript
       })
     );
@@ -1607,14 +1606,14 @@ function so1ve(options = {}, ...userConfigs) {
   if ((_c = options.toml) != null ? _c : true) {
     configs.push(
       toml({
-        overrides: overrides.toml
+        overrides: getOverrides(options, "toml")
       })
     );
   }
   if ((_d = options.yaml) != null ? _d : true) {
     configs.push(
       yaml({
-        overrides: overrides.yaml
+        overrides: getOverrides(options, "yaml")
       })
     );
   }
@@ -1622,7 +1621,7 @@ function so1ve(options = {}, ...userConfigs) {
     configs.push(
       mdx({
         componentExts,
-        overrides: overrides.mdx
+        overrides: getOverrides(options, "mdx")
       })
     );
   }
@@ -1641,6 +1640,16 @@ function so1ve(options = {}, ...userConfigs) {
   const merged = [...configs, ...userConfigs].flat();
   return merged;
 }
+const resolveSubOptions = (options, key) => typeof options[key] === "boolean" ? {} : options[key] || {};
+function getOverrides(options, key) {
+  var _a;
+  const sub = resolveSubOptions(options, key);
+  return {
+    // eslint-disable-next-line etc/no-deprecated
+    ...(_a = options.overrides) == null ? void 0 : _a[key],
+    ..."overrides" in sub ? sub.overrides : {}
+  };
+}
 
 Object.defineProperty(exports, 'pluginComments', {
 	enumerable: true,
@@ -1799,6 +1808,7 @@ exports.GLOB_VUE = GLOB_VUE;
 exports.GLOB_YAML = GLOB_YAML;
 exports.comments = comments;
 exports.formatting = formatting;
+exports.getOverrides = getOverrides;
 exports.html = html;
 exports.ignores = ignores;
 exports.imports = imports;
@@ -1811,6 +1821,7 @@ exports.promise = promise;
 exports.recordRulesState = recordRulesState;
 exports.recordRulesStateConfigs = recordRulesStateConfigs;
 exports.renameRules = renameRules;
+exports.resolveSubOptions = resolveSubOptions;
 exports.so1ve = so1ve;
 exports.solid = solid;
 exports.sortImports = sortImports;

package/dist/index.d.ts

@@ -65,6 +65,10 @@ interface Options extends OptionsComponentExts {
      * @see https://github.com/antfu/eslint-config-flat-gitignore
      */
     gitignore?: boolean | FlatGitignoreOptions;
+    /**
+     * Core rules. Can't be disabled.
+     */
+    javascript?: OptionsOverrides;
     /**
      * Enable TypeScript support.
      *
@@ -72,57 +76,59 @@ interface Options extends OptionsComponentExts {
      *
      * @default auto-detect based on the dependencies
      */
-    typescript?: boolean;
+    typescript?: boolean | OptionsOverrides;
     /**
      * Enable test support.
      *
      * @default true
      */
-    test?: boolean;
+    test?: boolean | OptionsOverrides;
     /**
      * Enable Vue support.
      *
      * @default auto-detect based on the dependencies
      */
-    vue?: boolean;
+    vue?: boolean | OptionsOverrides;
     /**
      * Enable Solid.js support.
      *
      * @default auto-detect based on the dependencies
      */
-    solid?: boolean;
+    solid?: boolean | OptionsOverrides;
     /**
      * Enable JSONC support.
      *
      * @default true
      */
-    jsonc?: boolean;
+    jsonc?: boolean | OptionsOverrides;
     /**
      * Enable YAML support.
      *
      * @default true
      */
-    yaml?: boolean;
+    yaml?: boolean | OptionsOverrides;
     /**
      * Enable TOML support.
      *
      * @default true
      */
-    toml?: boolean;
+    toml?: boolean | OptionsOverrides;
     /**
      * Enable markdown and mdx support.
      *
      * @default true
      */
-    mdx?: boolean;
+    mdx?: boolean | OptionsOverrides;
     /**
      * Enable formatting rules.
      *
      * @default true
      */
-    formatting?: boolean;
+    formatting?: boolean | OptionsOverrides;
     /**
      * Provide overrides for rules for each integration.
+     *
+     * @deprecated Use `overrides` option in each integration key instead
      */
     overrides?: {
         javascript?: ConfigItem["rules"];
@@ -194,6 +200,9 @@ declare const yaml: ({ overrides }?: OptionsOverrides) => ConfigItem[];
  * Construct an array of ESLint flat config items.
  */
 declare function so1ve(options?: Options, ...userConfigs: (ConfigItem | ConfigItem[])[]): ConfigItem[];
+type ResolvedOptions<T> = T extends boolean ? never : NonNullable<T>;
+declare const resolveSubOptions: <K extends keyof Options>(options: Options & ConfigItem, key: K) => ResolvedOptions<Options[K]>;
+declare function getOverrides<K extends keyof Options>(options: Options, key: K): any;
 
 declare const GLOB_SRC_EXT = "?([cm])[jt]s?(x)";
 declare const GLOB_SRC = "**/*.?([cm])[jt]s?(x)";
@@ -229,4 +238,4 @@ declare function recordRulesStateConfigs(configs: ConfigItem[]): ConfigItem[];
 declare function recordRulesState(rules: ConfigItem["rules"]): ConfigItem["rules"];
 declare function warnUnnecessaryOffRules(): void;
 
-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, OptionsTypeScriptParserOptions, RenamedRules, 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, OptionsTypeScriptParserOptions, RenamedRules, ResolvedOptions, comments, formatting, getOverrides, html, ignores, imports, javascript, jsonc, mdx, node, onlyError, promise, recordRulesState, recordRulesStateConfigs, renameRules, resolveSubOptions, so1ve, solid, sortImports, test, toml, typescript, unicorn, vue, warnUnnecessaryOffRules, yaml };

package/dist/index.mjs

@@ -1511,7 +1511,6 @@ function so1ve(options = {}, ...userConfigs) {
     solid: enableSolid = isPackageExists("solid-js"),
     typescript: enableTypeScript = isPackageExists("typescript"),
     gitignore: enableGitignore = true,
-    overrides = {},
     componentExts = []
   } = options;
   const configs = [];
@@ -1527,7 +1526,7 @@ function so1ve(options = {}, ...userConfigs) {
   configs.push(
     ignores(),
     javascript({
-      overrides: overrides.javascript
+      overrides: getOverrides(options, "javascript")
     }),
     comments(),
     node(),
@@ -1545,21 +1544,21 @@ function so1ve(options = {}, ...userConfigs) {
     configs.push(
       typescript({
         componentExts,
-        overrides: overrides.typescript
+        overrides: getOverrides(options, "typescript")
       })
     );
   }
   if ((_a = options.test) != null ? _a : true) {
     configs.push(
       test({
-        overrides: overrides.test
+        overrides: getOverrides(options, "test")
       })
     );
   }
   if (enableVue) {
     configs.push(
       vue({
-        overrides: overrides.vue,
+        overrides: getOverrides(options, "vue"),
         typescript: !!enableTypeScript
       })
     );
@@ -1567,7 +1566,7 @@ function so1ve(options = {}, ...userConfigs) {
   if (enableSolid) {
     configs.push(
       solid({
-        overrides: overrides.solid,
+        overrides: getOverrides(options, "solid"),
         typescript: !!enableTypeScript
       })
     );
@@ -1578,14 +1577,14 @@ function so1ve(options = {}, ...userConfigs) {
   if ((_c = options.toml) != null ? _c : true) {
     configs.push(
       toml({
-        overrides: overrides.toml
+        overrides: getOverrides(options, "toml")
       })
     );
   }
   if ((_d = options.yaml) != null ? _d : true) {
     configs.push(
       yaml({
-        overrides: overrides.yaml
+        overrides: getOverrides(options, "yaml")
       })
     );
   }
@@ -1593,7 +1592,7 @@ function so1ve(options = {}, ...userConfigs) {
     configs.push(
       mdx({
         componentExts,
-        overrides: overrides.mdx
+        overrides: getOverrides(options, "mdx")
       })
     );
   }
@@ -1612,5 +1611,15 @@ function so1ve(options = {}, ...userConfigs) {
   const merged = [...configs, ...userConfigs].flat();
   return merged;
 }
+const resolveSubOptions = (options, key) => typeof options[key] === "boolean" ? {} : options[key] || {};
+function getOverrides(options, key) {
+  var _a;
+  const sub = resolveSubOptions(options, key);
+  return {
+    // eslint-disable-next-line etc/no-deprecated
+    ...(_a = options.overrides) == null ? void 0 : _a[key],
+    ..."overrides" in sub ? sub.overrides : {}
+  };
+}
 
-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, 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 { 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, comments, formatting, getOverrides, html, ignores, imports, javascript, jsonc, mdx, node, onlyError, promise, recordRulesState, recordRulesStateConfigs, renameRules, resolveSubOptions, so1ve, solid, sortImports, test, toml, typescript, unicorn, vue, warnUnnecessaryOffRules, yaml };

package/package.json

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