feat: annotate plugin type

edvardchen · Aug 23, 2024 · a76dc42 · a76dc42
1 parent 675c507
commit a76dc42
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 3 deletions.
diff --git a/lib/index.d.ts b/lib/index.d.ts
@@ -0,0 +1,5 @@
+import type { ESLint } from 'eslint';
+
+declare const plugin: ESLint.Plugin;
+
+export = plugin;
diff --git a/lib/index.js b/lib/index.js
@@ -14,14 +14,16 @@ var requireIndex = require('requireindex');
 // Plugin Definition
 //------------------------------------------------------------------------------
 
-// import all rules in lib/rules
-module.exports.rules = requireIndex(__dirname + '/rules');
+const plugin = {
+  // import all rules in lib/rules
+  rules: requireIndex(__dirname + '/rules'),
 
-module.exports.configs = {
   recommended: {
     plugins: ['i18next'],
     rules: {
       'i18next/no-literal-string': [2]
     }
   }
 };
+
+module.exports = plugin;
diff --git a/package.json b/package.json
@@ -16,6 +16,7 @@
   "files": [
     "lib"
   ],
+  "types": "lib/index.d.ts",
   "repository": {
     "type": "git",
     "url": "https://github.com/edvardchen/eslint-plugin-i18next.git"