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

Merged
merged 1 commit into from
Nov 17, 2024

Conversation

bradzacher
Copy link
Contributor

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.
@ljharb
Copy link
Member

ljharb commented Nov 15, 2024

Can we add a test that covers this?

@ljharb ljharb marked this pull request as draft November 16, 2024 22:28
@bradzacher bradzacher marked this pull request as ready for review November 17, 2024 03:45
@ljharb ljharb merged commit 53ca775 into jsx-eslint:main Nov 17, 2024
112 checks passed
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.

2 participants