eslint-plugin-jest

eslint-plugin-jest copied to clipboard

Supporting eslint's new config system of eslint.

The legacy config system always has require()d plugins and sharable configs, while the new system is available in both ESM and CJS.

Therefore conditional export is great to keep compatibility while introducing the new config.

plugin: protocol(e.g. plugin:jest/recommended) is not valid any more. In the new config system, a bi-directional dependency between a plugin object and a preset config object is detached. From now on, only a config object should depend on a plugin object, not vice-versa. Thus, the new plugin (a new entry point index.js) doesn't have configs property, following the spec, though having the property does not mean incompatibility.

Users should have a way to import shareable configs independently. Hence eslint-plugin-jest/all, eslint-plugin-jest/recommended, eslint-plugin-jest/style are introduced as new entrypoints.

tbh I'm kind of tempted to ignore the new config format until v9 of ESLint is released, from a documentation perspective - I'm really looking forward to it and am happy with doing the minimum we need to let people start using it now, but it feels like it could be taxing on our brains to deal with ensuring we have clean documentation for both config formats everywhere (we could still have something saying we do support the new config format though).

What do people think?

What do people think?

Adding support for the new config format is very good idea, but the amount of documentation is currently overwhelming.

How do other plugins deal with this? Perhaps it would be enough mentioning: "eslint-plugin-jest supports the new config format since vX.X. Usage example:" and code block?

I think we don't have to change docs/rules/*.md. Because the rule usages are compatible with the new config system. The only thing to change is readme. And this is just done in this PR.

@jjangga0214 my understanding is that technically the config for rules is slightly changed, but it is actually the Readme change that I'm not happy with currently - I think we should just have a short sentence saying we're compatible with the new config system with a link to the docs, and leave it as that for now.

Then we can switch over when ESLint v9 is released.

@G-Rath It makes sense logically. However, psychologically, a person can feel assured by our a little bit detailed docs. Eslint's docs only describe how the new system works, not how a specific shareable config should be configured. Of course, people can indeed infer how it should be configured after reading eslint's docs, but having assurance is a different matter. This feeling can trigger people to migrate more confidently, being beneficial at the beginning of the new specification. So we can make our docs concise later, when people get used to the new config system.

@jjangga0214 I understand that, but that documentation should ideally be consistent with the surrounding content otherwise it can be jaring and confusing, which can undermine that feeling of assurance.

I'm generally happy to help with documentation but I'm pretty busy right now, still have not had a chance to checkout the new config system myself, and in the meantime (from what I understand) without this PR people can't use this plugin at all with the new config system; so I think let's go with the simpler form here to get this landed, and then we can bikeshed about the documentation in another dedicated PR :)

(Also ESLint v8 is about two weeks shy of being a year old, so we might only be waiting a month or two before v9 comes out anyway)

@G-Rath I allowed editing by maintainers. You can remove the new description and add some simpler sentences you want.

As someone who's also trying to migrate to the new config format and uses this plugin it would be great to get support on this.

Either conditional exports or create a new package name since plugins no longer need to be prefixed with eslint-plugin.

Either way, would be nice to see this effort completed. Currently, I'm modifying it myself in eslint.config.js like

import js from '@eslint/js'
import globals from 'globals'
import jest from 'eslint-plugin-jest'

/**
 * Can't extend jest's configuration due to the
 * incompatibility between the classic config,
 * and the new flat config. Change it here, for now.
 * @see https://github.com/eslint/eslint/issues/17355
 */
jest.configs.recommended.plugins = { jest }
jest.configs.recommended.languageOptions = {
  globals: {
    ...globals.jest
  }
}
delete jest.configs.recommended.env

export default [
  js.configs.recommended,
  jest.configs.recommended,
  {
    languageOptions: {
      ecmaVersion: 2023,
      sourceType: 'module',
      globals: {
        ...globals.node,
        ...globals.jest
      }
    },
    files: ['**/*.js'],
    plugins: {
      jest
    },
    rules: {
      'no-console': 'error'
    }
  }
]

Closing in favor of #1408