eslint-plugin-jest 28.8.3 → 28.9.0

package/README.md

@@ -22,28 +22,43 @@ yarn add --dev eslint eslint-plugin-jest
 
 ## Usage
 
-> [!NOTE]
->
-> `eslint.config.js` is supported, though most of the plugin documentation still
-> currently uses `.eslintrc` syntax.
->
-> Refer to the
-> [ESLint documentation on the new configuration file format](https://eslint.org/docs/latest/use/configure/configuration-files-new)
-> for more.
+If you're using flat configuration:
 
-Add `jest` to the plugins section of your `.eslintrc` configuration file. You
-can omit the `eslint-plugin-` prefix:
+With
+[flat configuration](https://eslint.org/docs/latest/use/configure/configuration-files),
+just import the plugin and away you go:
 
-```json
-{
-  "plugins": ["jest"]
-}
+```js
+const pluginJest = require('eslint-plugin-jest');
+
+module.exports = [
+  {
+    // update this to match your test files
+    files: ['**/*.spec.js', '**/*.test.js'],
+    plugins: { jest: pluginJest },
+    languageOptions: {
+      globals: pluginJest.environments.globals.globals,
+    },
+    rules: {
+      'jest/no-disabled-tests': 'warn',
+      'jest/no-focused-tests': 'error',
+      'jest/no-identical-title': 'error',
+      'jest/prefer-to-have-length': 'warn',
+      'jest/valid-expect': 'error',
+    },
+  },
+];
 ```
 
-Then configure the rules you want to use under the rules section.
+With legacy configuration, add `jest` to the plugins section of your `.eslintrc`
+configuration file. You can omit the `eslint-plugin-` prefix:
 
 ```json
 {
+  "plugins": ["jest"],
+  "env": {
+    "jest/globals": true
+  },
   "rules": {
     "jest/no-disabled-tests": "warn",
     "jest/no-focused-tests": "error",
@@ -54,19 +69,10 @@ Then configure the rules you want to use under the rules section.
 }
 ```
 
-You can also tell ESLint about the environment variables provided by Jest by
-doing:
-
-```json
-{
-  "env": {
-    "jest/globals": true
-  }
-}
-```
-
-This is included in all configs shared by this plugin, so can be omitted if
-extending them.
+> [!NOTE]
+>
+> You only need to explicitly include our globals if you're not using one of our
+> shared configs
 
 #### Aliased Jest globals
 

package/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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-jest",
-  "version": "28.8.3",
+  "version": "28.9.0",
   "description": "ESLint rules for Jest",
   "keywords": [
     "eslint",
@@ -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__'",
@@ -74,7 +76,7 @@
     "@tsconfig/node16": "^16.0.0",
     "@types/eslint": "^8.4.6",
     "@types/jest": "^29.0.0",
-    "@types/node": "^14.18.26",
+    "@types/node": "^16.0.0",
     "@typescript-eslint/eslint-plugin": "^6.0.0",
     "@typescript-eslint/parser": "^6.0.0",
     "@typescript-eslint/utils": "^6.0.0",
@@ -118,7 +120,7 @@
       "optional": true
     }
   },
-  "packageManager": "yarn@3.8.4",
+  "packageManager": "yarn@3.8.6",
   "engines": {
     "node": "^16.10.0 || ^18.12.0 || >=20.0.0"
   },