fix: share same plugin reference for default export #344
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Coverage summary from CodacySee diff coverage on Codacy
Coverage variation details
Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: Diff coverage details
Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: See your quality gate settings Change summary preferences |
🦋 Changeset detectedLatest commit: 8925d8b The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
WalkthroughThe changes introduce a new changeset file documenting a patch update for the Changes
Sequence Diagram(s)sequenceDiagram
participant Importer as Importer
participant Plugin as plugin object
participant FlatConfigs as flatConfigs
Importer->>src/index.ts: import default
src/index.ts->>Plugin: create plugin object with meta, configs, rules, etc.
src/index.ts->>FlatConfigs: reference flatConfigs
src/index.ts->>Importer: return Object.assign(plugin, { flatConfigs })
Suggested labels
Suggested reviewers
Poem
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 ESLint
src/index.tsOops! Something went wrong! :( ESLint: 9.27.0 Error [ERR_MODULE_NOT_FOUND]: Cannot find module '/lib/index.js' imported from /eslint.config.js 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (3)
✅ Files skipped from review due to trivial changes (1)
🚧 Files skipped from review as they are similar to previous changes (2)
⏰ Context from checks skipped due to timeout of 90000ms (190)
✨ Finishing Touches
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
WalkthroughThis pull request modifies the export structure of the plugin to share the same plugin reference for default export. This change is intended to avoid the error Changes
|
![petercat-assistant[bot]](https://avatars.githubusercontent.com/in/875736?s=60&v=4){kind=small}
There was a problem hiding this comment.
Pull Request Overview
This PR refactors the default export to reuse a single plugin object reference—preventing repeated plugin definitions that cause the Cannot redefine plugin "import-x" error.
- Added
configs,cjsRequire,importXResolverCompat, andcreateNodeResolverinto the basepluginobject - Changed the default export to
Object.assign(plugin, { flatConfigs })so it mergesflatConfigsinto that samepluginreference
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. |
commit: |
![ellipsis-dev[bot]](https://avatars.githubusercontent.com/in/64358?s=60&v=4){kind=small}
There was a problem hiding this comment.
Important
Looks good to me! 👍
Reviewed everything up to 7edc5e1 in 53 seconds. Click for details.
- Reviewed
33lines of code in1files - Skipped
0files when reviewing. - Skipped posting
2draft comments. View those below. - Modify your settings and rules to customize what types of comments Ellipsis leaves. And don't forget to react with 👍 or 👎 to teach Ellipsis.
1. src/index.ts:151
- Draft comment:
Including 'configs', 'cjsRequire', 'importXResolverCompat', and 'createNodeResolver' within the plugin object creates a consistent shared reference. This helps avoid plugin redefinition errors. - Reason this comment was not posted:
Comment did not seem useful. Confidence is useful =0%<= threshold50%This comment is purely informative and does not provide any actionable feedback or suggestions for improvement. It simply states a positive aspect of the code without prompting any further action or consideration from the PR author.
2. src/index.ts:186
- Draft comment:
Using Object.assign(plugin, { flatConfigs }) for the default export ensures the same plugin reference is used. Note that this mutates the plugin object—if immutability is a concern, consider alternatives. - Reason this comment was not posted:
Comment looked like it was already resolved.
Workflow ID: wflow_l9kKsxQDtPn8cNxz
You can customize 
Coverage summary from CodacySee diff coverage on Codacy
Coverage variation details
Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: Diff coverage details
Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: See your quality gate settings Change summary preferences |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #344 +/- ##
=======================================
Coverage 96.25% 96.25%
=======================================
Files 92 92
Lines 4833 4833
Branches 1823 1822 -1
=======================================
Hits 4652 4652
Misses 180 180
Partials 1 1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Important
Looks good to me! 👍
Reviewed 8925d8b in 1 minute and 36 seconds. Click for details.
- Reviewed
74lines of code in3files - Skipped
0files when reviewing. - Skipped posting
3draft comments. View those below. - Modify your settings and rules to customize what types of comments Ellipsis leaves. And don't forget to react with 👍 or 👎 to teach Ellipsis.
1. .changeset/nasty-dolls-check.md:1
- Draft comment:
The changeset note clearly states the patch and fix. Consider adding a brief rationale if needed. - Reason this comment was not posted:
Confidence changes required:0%<= threshold50%None
2. README.md:101
- Draft comment:
Updated import example uses named export ({ importX }) which aligns with the new plugin export pattern. - Reason this comment was not posted:
Confidence changes required:0%<= threshold50%None
3. src/index.ts:151
- Draft comment:
Merging additional properties into the shared plugin object and exporting it via Object.assign ensures a single plugin reference, avoiding redefinition errors. - Reason this comment was not posted:
Confidence changes required:0%<= threshold50%None
Workflow ID: wflow_rp3xHhHlCHkOV5BG
You can customize
43081j
reviewed
May 26, 2025
| @@ -114,7 +114,7 @@ npm install eslint-import-resolver-typescript --save-dev | |||
|
|
|||
| ```js | |||
| import js from '@eslint/js' | |||
| import * as importX from 'eslint-plugin-import-x' | |||
| import { importX } from 'eslint-plugin-import-x' | |||
There was a problem hiding this comment.
does this now work with the default import too?
i.e. import importX from 'eslint-plugin-import-x'
There was a problem hiding this comment.
Yes and no: #285, and also no-named-as-default.
This was referenced May 26, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Avoid
Cannot redefine plugin "import-x"errorImportant
Fixes plugin redefinition error by ensuring a single reference for default export and updates import syntax in README.
Cannot redefine plugin "import-x"error by ensuring a single plugin reference for default export insrc/index.ts.README.mdto use{ importX }instead of* as importX.pluginobject withflatConfigsusingObject.assign()insrc/index.ts..changeset/nasty-dolls-check.mdto document the patch update.This description was created by
for 8925d8b. You can customize this summary. It will automatically update as commits are pushed.
Summary by CodeRabbit