eslint-plugin-jest 27.8.0-next.1 → 27.9.0

package/README.md

@@ -22,6 +22,15 @@ 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.
+
 Add `jest` to the plugins section of your `.eslintrc` configuration file. You
 can omit the `eslint-plugin-` prefix:
 
@@ -85,7 +94,7 @@ test-related. This means it's generally not suitable to include them in your
 top-level configuration as that applies to all files being linted which can
 include source files.
 
-You can use
+For `.eslintrc` configs you can use
 [overrides](https://eslint.org/docs/user-guide/configuring/configuration-files#how-do-overrides-work)
 to have ESLint apply additional rules to specific files:
 
@@ -106,6 +115,30 @@ to have ESLint apply additional rules to specific files:
 }
 ```
 
+For `eslint.config.js` you can use
+[`files` and `ignores`](https://eslint.org/docs/latest/use/configure/configuration-files-new#specifying-files-and-ignores):
+
+```js
+const jest = require('eslint-plugin-jest');
+
+module.exports = [
+  ...require('@eslint/js').configs.recommended,
+  {
+    files: ['test/**'],
+    ...jest.configs['flat/recommended'],
+    rules: {
+      ...jest.configs['flat/recommended'],
+      'jest/prefer-expect-assertions': 'off',
+    },
+  },
+  // you can also configure jest rules in other objects, so long as some of the `files` match
+  {
+    files: ['test/**'],
+    rules: { 'jest/prefer-expect-assertions': 'off' },
+  },
+];
+```
+
 ### Jest `version` setting
 
 The behaviour of some rules (specifically [`no-deprecated-functions`][]) change
@@ -145,13 +178,18 @@ module.exports = {
 
 ## Shareable configurations
 
+> [!NOTE]
+>
+> `eslint.config.js` compatible versions of configs are available prefixed with
+> `flat/` and may be subject to small breaking changes while ESLint v9 is being
+> finalized.
+
 ### Recommended
 
 This plugin exports a recommended configuration that enforces good testing
 practices.
 
-To enable this configuration use the `extends` property in your `.eslintrc`
-config file:
+To enable this configuration with `.eslintrc`, use the `extends` property:
 
 ```json
 {
@@ -159,6 +197,22 @@ config file:
 }
 ```
 
+To enable this configuration with `eslint.config.js`, use
+`jest.configs['flat/recommended']`:
+
+```js
+const jest = require('eslint-plugin-jest');
+
+module.exports = [
+  {
+    files: [
+      /* glob matching your test files */
+    ],
+    ...jest.configs['flat/recommended'],
+  },
+];
+```
+
 ### Style
 
 This plugin also exports a configuration named `style`, which adds some
@@ -174,9 +228,21 @@ config file:
 }
 ```
 
-See
-[ESLint documentation](https://eslint.org/docs/user-guide/configuring/configuration-files#extending-configuration-files)
-for more information about extending configuration files.
+To enable this configuration with `eslint.config.js`, use
+`jest.configs['flat/style']`:
+
+```js
+const jest = require('eslint-plugin-jest');
+
+module.exports = [
+  {
+    files: [
+      /* glob matching your test files */
+    ],
+    ...jest.configs['flat/style'],
+  },
+];
+```
 
 ### All
 
@@ -189,10 +255,55 @@ If you want to enable all rules instead of only some you can do so by adding the
 }
 ```
 
+To enable this configuration with `eslint.config.js`, use
+`jest.configs['flat/all']`:
+
+```js
+const jest = require('eslint-plugin-jest');
+
+module.exports = [
+  {
+    files: [
+      /* glob matching your test files */
+    ],
+    ...jest.configs['flat/all'],
+  },
+];
+```
+
 While the `recommended` and `style` configurations only change in major versions
 the `all` configuration may change in any release and is thus unsuited for
 installations requiring long-term consistency.
 
+## Snapshot processing
+
+> [!NOTE]
+>
+> This is only relevant for `eslint.config.js`
+
+This plugin provides a
+[custom processor](https://eslint.org/docs/latest/extend/custom-processors) to
+allow rules to "lint" snapshot files.
+
+For `.eslintrc` based configs, this is automatically enabled out of the box but
+must be opted into for `eslint.config.js` using the `flat/snapshots` config:
+
+```js
+const jest = require('eslint-plugin-jest');
+
+module.exports = [
+  {
+    ...jest.configs['flat/snapshots'],
+    rules: {
+      'jest/no-large-snapshots': ['error', { maxSize: 1 }],
+    },
+  },
+];
+```
+
+Unlike other configs, this includes a `files` array that matches `.snap` files
+meaning you can use it directly
+
 ## Rules
 
 <!-- begin auto-generated rules list -->

package/lib/index.js

@@ -23,35 +23,65 @@ const excludedFiles = ['__tests__', 'detectJestVersion', 'utils'];
 const rules = Object.fromEntries((0, _fs.readdirSync)(rulesDir).map(rule => (0, _path.parse)(rule).name).filter(rule => !excludedFiles.includes(rule)).map(rule => [rule, importDefault((0, _path.join)(rulesDir, rule))]));
 const recommendedRules = Object.fromEntries(Object.entries(rules).filter(([, rule]) => rule.meta.docs.recommended).map(([name, rule]) => [`jest/${name}`, rule.meta.docs.recommended]));
 const allRules = Object.fromEntries(Object.entries(rules).filter(([, rule]) => !rule.meta.deprecated).map(([name]) => [`jest/${name}`, 'error']));
-const createConfig = rules => ({
-  plugins: ['jest'],
-  env: {
-    'jest/globals': true
-  },
-  rules
-});
-module.exports = {
+const plugin = {
   meta: {
     name: _package.name,
     version: _package.version
   },
-  configs: {
-    all: createConfig(allRules),
-    recommended: createConfig(recommendedRules),
-    style: createConfig({
-      'jest/no-alias-methods': 'warn',
-      'jest/prefer-to-be': 'error',
-      'jest/prefer-to-contain': 'error',
-      'jest/prefer-to-have-length': 'error'
-    })
-  },
+  // ugly cast for now to keep TypeScript happy since
+  // we don't have types for flat config yet
+  configs: {},
   environments: {
     globals: {
       globals: _globals.default
     }
   },
   processors: {
+    snapshots: snapshotProcessor,
     '.snap': snapshotProcessor
   },
   rules
-};
+};
+const createRCConfig = rules => ({
+  plugins: ['jest'],
+  env: {
+    'jest/globals': true
+  },
+  rules
+});
+const createFlatConfig = rules => ({
+  plugins: {
+    jest: plugin
+  },
+  languageOptions: {
+    globals: _globals.default
+  },
+  rules
+});
+plugin.configs = {
+  all: createRCConfig(allRules),
+  recommended: createRCConfig(recommendedRules),
+  style: createRCConfig({
+    'jest/no-alias-methods': 'warn',
+    'jest/prefer-to-be': 'error',
+    'jest/prefer-to-contain': 'error',
+    'jest/prefer-to-have-length': 'error'
+  }),
+  'flat/all': createFlatConfig(allRules),
+  'flat/recommended': createFlatConfig(recommendedRules),
+  'flat/style': createFlatConfig({
+    'jest/no-alias-methods': 'warn',
+    'jest/prefer-to-be': 'error',
+    'jest/prefer-to-contain': 'error',
+    'jest/prefer-to-have-length': 'error'
+  }),
+  'flat/snapshots': {
+    // @ts-expect-error this is introduced in flat config
+    files: ['**/*.snap'],
+    plugins: {
+      jest: plugin
+    },
+    processor: 'jest/snapshots'
+  }
+};
+module.exports = plugin;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-jest",
-  "version": "27.8.0-next.1",
+  "version": "27.9.0",
   "description": "ESLint rules for Jest",
   "keywords": [
     "eslint",