chore: improve type definition

edvardchen · Sep 14, 2024 · 4cb23d8 · 4cb23d8
1 parent 88747c4
commit 4cb23d8
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -20,7 +20,7 @@ import i18next from 'eslint-plugin-i18next';
 
 export default [
   // your other configs
-  i18next.configs?.['flat/recommended'],
+  i18next.configs['flat/recommended'],
 ];
 ```
 

diff --git a/examples/app-with-eslint9/eslint.config.mjs b/examples/app-with-eslint9/eslint.config.mjs
@@ -8,7 +8,7 @@ export default [
     linterOptions: { reportUnusedDisableDirectives: 'error' },
   },
   pluginJs.configs.recommended,
-  i18next.configs?.['flat/recommended'],
+  i18next.configs['flat/recommended'],
   {
     rules: { 'i18next/no-literal-string': ['error', { mode: 'all' }] },
   },

diff --git a/lib/index.d.ts b/lib/index.d.ts
@@ -1,5 +1,9 @@
 import type { ESLint } from 'eslint';
 
-declare const plugin: ESLint.Plugin;
+declare const plugin: ESLint.Plugin & {
+    configs: {
+        'flat/recommended': ESLint.ConfigData
+    }
+};
 
 export = plugin;
diff --git a/lib/index.js b/lib/index.js
@@ -16,6 +16,9 @@ var requireIndex = require('requireindex');
 
 // import all rules in lib/rules
 const rules = requireIndex(__dirname + '/rules');
+/**
+ * @type {import('eslint').ESLint.Plugin}
+ */
 const plugin = {
   rules,