Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Fix] fix unstable plugin reference with flat configs #1038

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

bradzacher
Copy link

The previous use of spread meant that

import jsxA11y from 'eslint-plugin-jsx-a11y';

jsxA11y !== jsxA11y.flatConfigs.recommended.plugins['jsx-a11y']

This is a problem because if someone does something like this

import jsxA11y from 'eslint-plugin-jsx-a11y';

export default [
  { plugins: { 'jsx-a11y': jsxA11y } },
  jsxA11y.flatConfigs.recommended,
];

then ESLint will crash with the error Config "jsx-a11y/recommended": Key "plugins": Cannot redefine plugin "jsx-a11y".

This PR fixes that by using Object.assign to mutate the jsxA11y object and maintain referential equality.

The previous use of spread meant that
```ts
import jsxA11y from 'eslint-plugin-jsx-a11y';

jsxA11y !== jsxA11y.flatConfigs.recommended.plugins['jsx-a11y']
```

This is a problem because if someone does something like this 
```js
import jsxA11y from 'eslint-plugin-jsx-a11y';

export default [
  { plugins: { 'jsx-a11y': jsxA11y } },
  jsxA11y.flatConfigs.recommended,
];
```
then ESLint will crash with the error `Config "jsx-a11y/recommended": Key "plugins": Cannot redefine plugin "jsx-a11y".`

This PR fixes that by using `Object.assign` to mutate the `jsxA11y` object and maintain referential equality.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant