From 7cc514feb0bf6f4757626f96949e7c8dc13570df Mon Sep 17 00:00:00 2001 From: Gareth Jones Date: Wed, 20 Nov 2024 07:32:48 +1300 Subject: [PATCH] feat: add TypeScript types --- index.d.ts | 25 +++++++++++++++++++++++++ package.json | 4 +++- 2 files changed, 28 insertions(+), 1 deletion(-) create mode 100644 index.d.ts diff --git a/index.d.ts b/index.d.ts new file mode 100644 index 00000000..360dbbfa --- /dev/null +++ b/index.d.ts @@ -0,0 +1,25 @@ +import type { Linter, Rule } from 'eslint'; + +declare const plugin: { + meta: { + name: string; + version: string; + }; + configs: { + angular: Linter.LegacyConfig; + dom: Linter.LegacyConfig; + marko: Linter.LegacyConfig; + react: Linter.LegacyConfig; + vue: Linter.LegacyConfig; + 'flat/angular': Linter.FlatConfig; + 'flat/dom': Linter.FlatConfig; + 'flat/marko': Linter.FlatConfig; + 'flat/react': Linter.FlatConfig; + 'flat/vue': Linter.FlatConfig; + }; + rules: { + [key: string]: Rule.RuleModule; + }; +}; + +export = plugin; diff --git a/package.json b/package.json index 93a6074b..d0c88b86 100644 --- a/package.json +++ b/package.json @@ -27,9 +27,11 @@ "files": [ "dist", "README.md", - "LICENSE" + "LICENSE", + "index.d.ts" ], "main": "./dist/index.js", + "types": "index.d.ts", "scripts": { "prebuild": "del-cli dist", "build": "tsc",