@so1ve/eslint-config 4.1.7 → 4.2.0

package/dist/types.d.mts

@@ -0,0 +1,175 @@
+import { RuleOptions } from "./typegen.mjs";
+import { FlatGitignoreOptions } from "eslint-config-flat-gitignore";
+import { ParserOptions } from "@typescript-eslint/utils/ts-eslint";
+import { Linter } from "eslint";
+
+//#region src/types.d.ts
+type MaybePromise<T> = T | Promise<T>;
+type MaybeArray<T> = T | T[];
+type Rules = RuleOptions;
+type TypedFlatConfigItem = Omit<Linter.Config<Linter.RulesRecord & Rules>, "plugins"> & {
+  /**
+  * An object containing a name-value mapping of plugin names to plugin
+  * objects. When `files` is specified, these plugins are only available to the
+  * matching files.
+  *
+  * @see [Using plugins in your configuration](https://eslint.org/docs/latest/user-guide/configuring/configuration-files-new#using-plugins-in-your-configuration)
+  */
+  plugins?: Record<string, any>;
+};
+interface OptionsComponentExts {
+  /**
+  * Additional extensions for components.
+  */
+  componentExts?: string[];
+}
+interface OptionsTypeScriptParserOptions {
+  /**
+  * Additional parser options for TypeScript.
+  */
+  parserOptions?: Partial<ParserOptions>;
+}
+interface OptionsHasTypeScript {
+  typescript?: boolean;
+}
+interface OptionsPnpm {
+  /**
+  * Requires catalogs usage
+  */
+  catalogs?: boolean;
+  /**
+  * Enable linting for package.json
+  *
+  * @default true
+  */
+  json?: boolean;
+  /**
+  * Enable linting for pnpm-workspace.yaml
+  *
+  * @default true
+  */
+  yaml?: boolean;
+}
+interface OptionsOverrides {
+  overrides?: TypedFlatConfigItem["rules"];
+}
+interface Options extends OptionsComponentExts {
+  /**
+  * Enable gitignore support.
+  *
+  * Passing an object to configure the options.
+  *
+  * @default true
+  * @see https://github.com/antfu/eslint-config-flat-gitignore
+  */
+  gitignore?: boolean | FlatGitignoreOptions;
+  /**
+  * Extend the global ignores.
+  *
+  * Passing an array to extends the ignores. Passing a function to modify the
+  * default ignores.
+  *
+  * @default [ ]
+  */
+  ignores?: string[] | ((originals: string[]) => string[]);
+  /**
+  * Enable pnpm catalogs support.
+  *
+  * @default false
+  */
+  pnpm?: boolean | OptionsPnpm;
+  /**
+  * Core rules. Can't be disabled.
+  */
+  javascript?: OptionsOverrides;
+  /**
+  * Enable HTML support.
+  */
+  html?: boolean;
+  /**
+  * Enable TypeScript support.
+  *
+  * Passing an object to enable TypeScript Language Server support.
+  *
+  * @default auto-detect based on the dependencies
+  */
+  typescript?: boolean | OptionsOverrides;
+  /**
+  * Enable test support.
+  *
+  * @default true
+  */
+  test?: boolean | OptionsOverrides;
+  /**
+  * Enable Astro support.
+  *
+  * @default auto-detect based on the dependencies
+  */
+  astro?: boolean | OptionsOverrides;
+  /**
+  * Enable Vue support.
+  *
+  * @default auto-detect based on the dependencies
+  */
+  vue?: boolean | OptionsOverrides;
+  /**
+  * Enable Solid.js support.
+  *
+  * @default auto-detect based on the dependencies
+  */
+  solid?: boolean | OptionsOverrides;
+  /**
+  * Enable JSONC support.
+  *
+  * @default true
+  */
+  jsonc?: boolean | OptionsOverrides;
+  /**
+  * Enable YAML support.
+  *
+  * @default true
+  */
+  yaml?: boolean | OptionsOverrides;
+  /**
+  * Enable TOML support.
+  *
+  * @default true
+  */
+  toml?: boolean | OptionsOverrides;
+  /**
+  * Enable markdown and mdx support.
+  *
+  * @default true
+  */
+  mdx?: boolean | OptionsOverrides;
+  /**
+  * Enable formatting rules.
+  *
+  * @default true
+  */
+  formatting?: boolean;
+  /**
+  * Enable perfectionist rules.
+  *
+  * @default true
+  */
+  perfectionist?: boolean;
+  /**
+  * Provide overrides for rules for each integration.
+  *
+  * @deprecated Use `overrides` option in each integration key instead
+  */
+  overrides?: {
+    javascript?: TypedFlatConfigItem["rules"];
+    typescript?: TypedFlatConfigItem["rules"];
+    test?: TypedFlatConfigItem["rules"];
+    vue?: TypedFlatConfigItem["rules"];
+    solid?: TypedFlatConfigItem["rules"];
+    jsonc?: TypedFlatConfigItem["rules"];
+    mdx?: TypedFlatConfigItem["rules"];
+    yaml?: TypedFlatConfigItem["rules"];
+    toml?: TypedFlatConfigItem["rules"];
+  };
+}
+//#endregion
+export { MaybeArray, MaybePromise, Options, OptionsComponentExts, OptionsHasTypeScript, OptionsOverrides, OptionsPnpm, OptionsTypeScriptParserOptions, Rules, TypedFlatConfigItem };

package/dist/utils.d.mts

@@ -0,0 +1,30 @@
+import { MaybePromise } from "./types.mjs";
+
+//#region src/utils.d.ts
+
+/**
+* Rename plugin prefixes in a rule object. Accepts a map of prefixes to rename.
+*
+* @example
+*
+* ```ts
+* import { renameRules } from "@antfu/eslint-config";
+*
+* export default [
+*   {
+*     rules: renameRules(
+*       {
+*         "@typescript-eslint/indent": "error",
+*       },
+*       { "@typescript-eslint": "ts" },
+*     ),
+*   },
+* ];
+* ```
+*/
+declare const renameRules: (rules: Record<string, any>, map: Record<string, string>) => Record<string, any>;
+declare function interopDefault<T>(m: MaybePromise<T>): Promise<T extends {
+  default: infer U;
+} ? U : T>;
+//#endregion
+export { interopDefault, renameRules };

package/dist/utils.mjs

@@ -0,0 +1,32 @@
+//#region src/utils.ts
+/**
+* Rename plugin prefixes in a rule object. Accepts a map of prefixes to rename.
+*
+* @example
+*
+* ```ts
+* import { renameRules } from "@antfu/eslint-config";
+*
+* export default [
+*   {
+*     rules: renameRules(
+*       {
+*         "@typescript-eslint/indent": "error",
+*       },
+*       { "@typescript-eslint": "ts" },
+*     ),
+*   },
+* ];
+* ```
+*/
+const renameRules = (rules, map) => Object.fromEntries(Object.entries(rules).map(([key, value]) => {
+	for (const [from, to] of Object.entries(map)) if (key.startsWith(`${from}/`)) return [to + key.slice(from.length), value];
+	return [key, value];
+}));
+async function interopDefault(m) {
+	const resolved = await m;
+	return resolved.default ?? resolved;
+}
+
+//#endregion
+export { interopDefault, renameRules };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@so1ve/eslint-config",
-  "version": "4.1.7",
+  "version": "4.2.0",
   "author": "Ray <i@mk1.io> (https://github.com/so1ve/)",
   "type": "module",
   "description": "Ray's eslint config.",
@@ -48,6 +48,7 @@
     "eslint-plugin-astro": "^1.5.0",
     "eslint-plugin-case-police": "^2.1.1",
     "eslint-plugin-command": "^3.4.0",
+    "eslint-plugin-de-morgan": "^2.0.0",
     "eslint-plugin-html": "^8.1.3",
     "eslint-plugin-import-lite": "^0.4.0",
     "eslint-plugin-import-x": "^4.16.1",
@@ -69,6 +70,7 @@
     "eslint-plugin-unused-imports": "^4.3.0",
     "eslint-plugin-vue": "^10.6.2",
     "eslint-plugin-yml": "^1.19.1",
+    "find-up-simple": "^1.0.1",
     "globals": "^16.5.0",
     "jsonc-eslint-parser": "^2.4.2",
     "local-pkg": "^1.1.2",
@@ -76,11 +78,7 @@
     "typescript-eslint": "^8.50.1",
     "vue-eslint-parser": "^10.2.0",
     "yaml-eslint-parser": "^1.3.2",
-    "@so1ve/eslint-plugin": "4.1.7"
-  },
-  "devDependencies": {
-    "eslint-plugin-de-morgan": "^2.0.0",
-    "find-up-simple": "^1.0.1"
+    "@so1ve/eslint-plugin": "4.2.0"
   },
   "peerDependencies": {
     "eslint": "^9.39.2",