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: import resolve find in paths's node_modules #35

Merged
merged 1 commit into from
Dec 30, 2024
Merged

Conversation

fengmk2
Copy link
Member

@fengmk2 fengmk2 commented Dec 30, 2024

Summary by CodeRabbit

  • New Features

    • Enhanced module resolution to search for modules within the node_modules directory
    • Added support for resolving both CommonJS and ECMAScript (ESM) packages
  • Tests

    • Expanded test coverage for package resolution in different module systems

Copy link

vercel bot commented Dec 30, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
egg-utils ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 30, 2024 9:22am

Copy link

coderabbitai bot commented Dec 30, 2024

Walkthrough

The pull request introduces an enhancement to the importResolve function in the module resolution system. The changes focus on expanding the module resolution capabilities by adding support for searching modules within the node_modules directory. The implementation iterates through provided paths, constructs paths to node_modules, and attempts to resolve module files, while maintaining the existing resolution logic for absolute and relative paths.

Changes

File Change Summary
src/import.ts Added module resolution logic to search for modules in node_modules directory
test/import.test.ts Added two new test cases for CommonJS and ESM package resolution from node_modules

Sequence Diagram

sequenceDiagram
    participant Resolver as Module Resolver
    participant NodeModules as node_modules Directory
    participant DebugLogger as Debug Logger

    Resolver->>NodeModules: Attempt to resolve module path
    alt Module Found
        NodeModules-->>Resolver: Return module file path
        Resolver->>DebugLogger: Log resolution details
    else Module Not Found
        Resolver->>Resolver: Continue with existing resolution logic
    end
Loading

Possibly related PRs

Poem

🐰 In node_modules, a treasure trove so bright,
Modules dancing with resolving might.
Paths explored, dependencies unfurled,
A rabbit's quest through the coding world!
Resolve and conquer, with logic so keen! 🔍


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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. (Beta)
  • @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.

Copy link

pkg-pr-new bot commented Dec 30, 2024

Open in Stackblitz

npm i https://pkg.pr.new/eggjs/utils/@eggjs/utils@35

commit: a65897f

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (2)
src/import.ts (1)

205-215: Well-structured extension for node_modules resolution
The loop correctly attempts to resolve the requested module from node_modules paths. It short-circuits once a valid file is found, meeting the PR objective of enhanced import resolution.

You might also consider gracefully handling cases where node_modules may not exist or be inaccessible, e.g., checking its presence before attempting resolution, to optimize performance and error handling further.

test/import.test.ts (1)

30-34: Test coverage for CommonJS module resolution
This test case effectively verifies loading a CommonJS package from {paths}/node_modules.

A negative test scenario (e.g., module not found in node_modules) could further strengthen test coverage.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 72b4e9e and a65897f.

⛔ Files ignored due to path filters (4)
  • test/fixtures/cjs/node_modules/inject/index.js is excluded by !**/node_modules/**
  • test/fixtures/cjs/node_modules/inject/package.json is excluded by !**/node_modules/**
  • test/fixtures/esm/node_modules/inject/index.js is excluded by !**/node_modules/**
  • test/fixtures/esm/node_modules/inject/package.json is excluded by !**/node_modules/**
📒 Files selected for processing (2)
  • src/import.ts (1 hunks)
  • test/import.test.ts (2 hunks)
🔇 Additional comments (1)
test/import.test.ts (1)

58-62: Test coverage for ESM module resolution
This test ensures that an ESM package can also be successfully resolved from {paths}/node_modules, paralleling the CommonJS flow.

Copy link

codecov bot commented Dec 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.50%. Comparing base (42afd2a) to head (a65897f).
Report is 2 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master      #35      +/-   ##
==========================================
- Coverage   89.78%   87.50%   -2.29%     
==========================================
  Files           6        6              
  Lines         685      696      +11     
  Branches      120      120              
==========================================
- Hits          615      609       -6     
- Misses         70       87      +17     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@fengmk2 fengmk2 merged commit bd772af into master Dec 30, 2024
24 of 25 checks passed
@fengmk2 fengmk2 deleted the fix-require-pkg branch December 30, 2024 09:51
fengmk2 pushed a commit that referenced this pull request Dec 30, 2024
[skip ci]

## [4.2.2](v4.2.1...v4.2.2) (2024-12-30)

### Bug Fixes

* import resolve find in paths's node_modules ([#35](#35)) ([bd772af](bd772af))
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