feat: add ts typings

lib/mod.d.ts

@@ -0,0 +1,44 @@
+/**
+ * @fileoverview Allow multiple configurations of a rule without overriding it.
+ * @author
+ * 唯然<weiran.zsd@outlook.com>
+ */
+
+declare module "@weiran.zsd/multi-eslint-rule-config" {
+  import { Linter, Rule } from "eslint";
+
+  interface RuleOptions {
+    rule: string | Rule.RuleModule;
+    ruleConfig: Linter.RuleEntry;
+    asRuleName?: string;
+    plugin?: {
+      rules: Record<string, Rule.RuleModule>;
+    };
+  }
+
+  interface ConfigOptions {
+    name: string;
+    plugins: {
+      [prefix: string]: {
+        meta: {
+          name: string;
+          version: string;
+        };
+        rules: Record<string, Rule.RuleModule>;
+      };
+    };
+    rules: Record<string, Linter.RuleEntry>;
+  }
+
+  /**
+   * Generates a configuration object for ESLint with multiple rule configurations.
+   *
+   * @param options - Array or single item containing rule options to configure.
+   * @param prefix - Optional prefix to use for the plugin (default is "@@").
+   * @returns The generated configuration object.
+   */
+  export function config(
+    options: RuleOptions | RuleOptions[],
+    prefix?: string,
+  ): ConfigOptions;
+}

package.json

@@ -12,6 +12,7 @@
   "author": "唯然<weiran.zsd@outlook.com",
   "type": "commonjs",
   "exports": "./lib/mod.js",
+  "types": "./lib/mod.d.ts",
   "files": [
     "LICENSE",
     "README.md",

readme.md

@@ -2,7 +2,7 @@
 
 ## Why?
 
-This plugin allows you to configure the same ESLint rule multiple times, which is not possible with the default ESLint behavior. Normally, when the same rule (e.g., no-debugger) is defined more than once, the latter configuration overwrites the previous one. With this plugin, you can apply multiple configurations for the same rule, offering greater flexibility in defining your ESLint settings. This can be particularly useful for different scenarios or environments that require specific rule adjustments without overriding previous configurations.
+This plugin allows you to configure the same ESLint rule multiple times, which is not possible with the default ESLint behavior. Normally, when the same rule (e.g., `[no-restricted-imports](https://eslint.org/docs/latest/rules/no-restricted-imports)`) is configured more than once, the latter configuration overwrites the previous one. With this plugin, you can apply multiple configurations for the same rule, offering greater flexibility in defining your ESLint settings. This can be particularly useful for different scenarios or environments that require specific rule adjustments without overriding previous configurations.
 
 ## Usage