feat: add TypeScript types (#1667)

Author: mskelton

.eslintrc.js

@@ -133,5 +133,11 @@ module.exports = {
  'import/no-commonjs': 'off',
  },
  },
+ {
+ files: ['*.d.ts'],
+ rules: {
+ strict: 'off',
+ },
+ },
  ],
 };

index.d.ts

@@ -0,0 +1,28 @@
+import type { Linter, Rule } from 'eslint';
+
+declare const plugin: {
+ meta: {
+ name: string;
+ version: string;
+ };
+ environments: {
+ globals: {
+ globals: {
+ [key: string]: boolean;
+ };
+ };
+ };
+ configs: {
+ all: Linter.LegacyConfig;
+ recommended: Linter.LegacyConfig;
+ style: Linter.LegacyConfig;
+ 'flat/all': Linter.FlatConfig;
+ 'flat/recommended': Linter.FlatConfig;
+ 'flat/style': Linter.FlatConfig;
+ };
+ rules: {
+ [key: string]: Rule.RuleModule;
+ };
+};
+
+export = plugin;

package.json

@@ -15,9 +15,11 @@
  "url": "jkimbo.com"
  },
  "main": "lib/index.js",
+ "types": "index.d.ts",
  "files": [
  "docs/",
- "lib/"
+ "lib/",
+ "index.d.ts"
  ],
  "scripts": {
  "build": "babel --extensions .js,.ts src --out-dir lib --copy-files && rimraf --glob lib/__tests__ 'lib/**/__tests__'",