fix: do not consider resolved path in extensions rule #374

dword-design · 2025-06-05T16:48:02Z

I just ran into the following issue:

I'm migrating to TypeScript and I have import foo from './foo.js'; in a file and there is foo.ts. I also have 'import-x/extensions': ['error', 'ignorePackages', { js: 'never', ts: 'never' }] configured so that the dev omits .jsand then the resolver will correctly resolve foo.ts. But this is not the case because eslint-plugin-import-x will only suggest to omit the extension if the extension of the import statement is equal to the resolved path.

My suggestion is to not || the paths but the extensions. So, if the import path has an extension, take this, otherwise take the one from the resolved path.

Yeah, I think the solution isn't ideal yet, there are failing tests. Maybe someone can help with it.

EDIT: Closed in favor of extensionAlias option from eslint-import-resolver-typescript which prevents the case where import path and resolved path are not aligned.

Important

Change extension determination in extensions.ts to use importPath directly, affecting ESLint extension rules in TypeScript projects.

Behavior:
- In extensions.ts, change extension determination to use importPath directly instead of resolvedPath.
- Affects ESLint rule for extensions, particularly in TypeScript projects where import and resolved paths differ.
Functions:
- Modify createRule in extensions.ts to use path.extname(importPath).slice(1) for extension extraction.
Misc:
- Remove unused resolvedPath variable in extensions.ts.

^{This description was created by}^{for 5a078d5. You can customize this summary. It will automatically update as commits are pushed.}

Summary by CodeRabbit

Refactor
- Simplified the process for extracting file extensions from import paths, improving efficiency.

coderabbitai · 2025-06-05T16:48:09Z

Walkthrough

The change reverses the priority for extracting file extensions from import paths. It now first attempts to get the extension from the original import path string, and only if that fails, it falls back to using the resolved import path.

Changes

Files	Change Summary
src/rules/extensions.ts	Reversed priority for extracting file extensions: now tries original import path first, then resolved path.

Possibly related PRs

feat: add suggestions support for extensions unexpected case #329: Improves suggestions and autofixes for unexpected extensions in the same extensions.ts file, related to import path extension handling.

Suggested labels

bug

Suggested reviewers

JounQin

Poem

A hop and a skip, the code's now more neat,
No more resolving paths before finding the treat.
Extensions are plucked right from the vine,
Simpler and clearer—oh, how divine!
🐇✨

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

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

src/rules/extensions.ts

Oops! Something went wrong! :(

ESLint: 9.28.0

Error [ERR_MODULE_NOT_FOUND]: Cannot find module '/lib/index.js' imported from /eslint.config.js
at finalizeResolution (node:internal/modules/esm/resolve:274:11)
at moduleResolve (node:internal/modules/esm/resolve:859:10)
at defaultResolve (node:internal/modules/esm/resolve:983:11)
at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:799:12)
at #cachedDefaultResolve (node:internal/modules/esm/loader:723:25)
at ModuleLoader.resolve (node:internal/modules/esm/loader:706:38)
at ModuleLoader.getModuleJobForImport (node:internal/modules/esm/loader:307:38)
at #link (node:internal/modules/esm/module_job:170:49)

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between bed3350 and e6f8e88.

📒 Files selected for processing (1)

src/rules/extensions.ts (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

src/rules/extensions.ts

⏰ Context from checks skipped due to timeout of 90000ms (1)

GitHub Check: Codacy Static Code Analysis

✨ Finishing Touches

📝 Generate Docstrings

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.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need 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)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

codesandbox-ci · 2025-06-05T16:48:31Z

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.

pkg-pr-new · 2025-06-05T16:48:50Z

Open in StackBlitz

npm i https://pkg.pr.new/eslint-plugin-import-x@374

commit: 5a078d5

ellipsis-dev

Important

Looks good to me! 👍

Reviewed everything up to 5a078d5 in 49 seconds. Click for details.

Reviewed 17 lines of code in 1 files
Skipped 0 files when reviewing.
Skipped posting 1 draft 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/rules/extensions.ts:326

Draft comment:
Using the raw importPath to extract the extension now aligns with the intended behavior described in the PR. Verify that this change correctly handles edge cases (e.g. TS files resolved from .js imports) and that tests are updated accordingly.
Reason this comment was not posted:
Confidence changes required: 0% <= threshold 50% None

Workflow ID: wflow_5f04JNX6JDw7WJ5U

^{You can customize}^{by changing your verbosity settings, reacting with 👍 or 👎, replying to comments, or adding code review rules.}

JounQin · 2025-06-05T16:51:08Z

Tests are failing, or maybe you can raise a new issue or a PR with failing test case first.

changeset-bot · 2025-06-05T17:01:08Z

⚠️ No Changeset found

Latest commit: e6f8e88

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

JounQin · 2025-06-05T17:06:16Z

src/rules/extensions.ts

@@ -328,9 +328,9 @@ export default createRule<Options, MessageId>({

        const resolvedPath = resolve(importPath, context)

-        // get extension from resolved path, if possible.
-        // for unresolved, use source value.
-        const extension = path.extname(resolvedPath || importPath).slice(1)


This change is incorrect for resolving .xyz but ./abc.js or ./abc is imported.

coderabbitai

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5a078d5 and bed3350.

📒 Files selected for processing (1)

src/rules/extensions.ts (1 hunks)

🧰 Additional context used

🪛 GitHub Check: Lint and Test with Node.js lts/* and ESLint 9 on ubuntu-latest

src/rules/extensions.ts