Add TypeScript declarations for configs (#2528)

Shinigami92 · web-flow · commit 3157fad6900e · 2024-09-12T20:21:42.000+09:00
diff --git a/lib/index.d.ts b/lib/index.d.ts
@@ -0,0 +1,43 @@
+type ConfigName =
+  | "base"
+  | "essential"
+  | "no-layout-rules"
+  | "recommended"
+  | "strongly-recommended"
+  | "vue3-essential"
+  | "vue3-recommended"
+  | "vue3-strongly-recommended"
+  | "flat/base"
+  | "flat/vue2-essential"
+  | "flat/vue2-recommended"
+  | "flat/vue2-strongly-recommended"
+  | "flat/essential"
+  | "flat/recommended"
+  | "flat/strongly-recommended"
+
+declare const vue: {
+  meta: any
+  configs: {
+    [name in keyof ConfigName]: any
+  }
+  rules: Record<string, any>
+  processors: {
+    ".vue": any
+    vue: any
+  }
+  environments: {
+    /**
+     * @deprecated
+     */
+    "setup-compiler-macros": {
+      globals: {
+        defineProps: "readonly"
+        defineEmits: "readonly"
+        defineExpose: "readonly"
+        withDefaults: "readonly"
+      }
+    }
+  }
+}
+
+export = vue
diff --git a/package.json b/package.json
@@ -3,6 +3,7 @@
   "version": "9.28.0",
   "description": "Official ESLint plugin for Vue.js",
   "main": "lib/index.js",
+  "types": "lib/index.d.ts",
   "scripts": {
     "new": "node tools/new-rule.js",
     "start": "npm run test:base -- --watch --growl",
