feat: add { isEntry } for resolve_id plugin hook

[sorrycc]

Summary by CodeRabbit

• 新功能

  • 更新了 resolve_id 方法，新增了 isEntry 参数，增强了插件解析能力。

• 文档

  • 更新了配置文档中的 resolveId 方法签名，以反映新参数的添加。

[coderabbitai]

Walkthrough

该拉取请求对多个文件进行了修改，主要涉及 resolve_id 方法及其参数的更新。关键更改包括在 JsHooks 和 TsFnHooks 结构中更新 resolve_id 字段的类型，以支持额外的参数。还引入了新的结构 ResolveIdParams，并在相关方法中更新了其签名，以包含新的参数。最后，配置文档中的方法签名也进行了相应更新，以反映这些更改。

Changes

文件路径	更改摘要
crates/binding/src/js_hook.rs	更新 JsHooks 中 resolve_id 字段类型，添加 ResolveIdParams 结构。
crates/binding/src/js_plugin.rs	更新 JsPlugin 中 resolve_id 方法签名，包含新的 PluginResolveIdParams 参数。
crates/mako/src/plugin.rs	更新 Plugin trait 和 PluginDriver 中的 resolve_id 方法签名，添加新参数。
crates/mako/src/resolve.rs	修改 resolve 函数以传递新的 PluginResolveIdParams 参数。
packages/mako/binding.d.ts	更新 TypeScript 接口 ResolveIdParams，添加 isEntry 字段。
crates/binding/src/js_hook.rs,	添加新的 ResolveIdParams 结构。
crates/mako/src/plugin.rs	添加新的 PluginResolveIdParams 结构。
配置文档	更新 resolveId 方法签名以反映 isEntry 参数的添加。

Possibly related PRs

• feat: add resolve_id plugin hook #1625: 本PR引入了新的 resolve_id 插件钩子，与主要PR中关于 JsHooks、TsFnHooks 和 JsPlugin 结构的 resolve_id 方法及其参数的修改直接相关。

Poem

在草地上跳跃，兔子欢快舞，
新的参数加入，功能更丰富。
解析ID的旅程，愉快又轻松，
代码如春风，温暖又融融。
让我们一起庆祝，代码的美好，
兔子在此祝福，愿你们都快乐！ 🐰✨

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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 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.

[coderabbitai]

Actionable comments posted: 3

🧹 Outside diff range and nitpick comments (8)

e2e/fixtures/plugins/plugins.config.js (1)

25-26: 更新了 resolveId 方法，新增了 options 参数

这个变更符合 PR 的目标，为 resolve_id 插件钩子添加了 { isEntry } 功能。

几点建议：

1. 如果 console.log 语句仅用于调试，建议在生产环境中移除它。
2. 请确保更新了相关文档，以反映 resolveId 方法签名的这一变化。

如果 console.log 语句不需要保留到生产环境，可以应用以下更改：

 async resolveId(source, importer, options) {
-  console.log('resolveId', source, importer, options);
   if (source === 'resolve_id') {
     return { id: require('path').join(__dirname, 'resolve_id_mock.js'), external: false };
   }

packages/mako/binding.d.ts (1)

73-75: 新增 ResolveIdParams 接口

新增的 ResolveIdParams 接口为 resolveId 方法的参数提供了清晰的结构，这有助于提高代码的可读性和类型安全性。这是一个很好的添加。

为了进一步提高代码的一致性和可维护性，建议在 JsHooks 接口中使用这个新接口。

考虑在 JsHooks 接口中应用以下更改：

 resolveId?: (
   source: string,
   importer: string,
-  { isEntry: bool },
+  params: ResolveIdParams,
 ) => Promise<{ id: string }>;

这样可以确保参数结构在整个代码库中保持一致，并且更容易在将来扩展 ResolveIdParams 接口。

crates/mako/src/plugin.rs (4)

26-29: 建议为新结构体添加文档注释

新添加的 PluginResolveIdParams 结构体缺少文档注释。建议添加注释来解释该结构体的用途，特别是 is_entry 字段的含义和使用场景。这将有助于其他开发者理解和正确使用这个新的参数结构。

建议添加类似以下的文档注释：

/// 用于 `resolve_id` 方法的参数
pub struct PluginResolveIdParams {
    /// 表示当前解析的模块是否为入口模块
    pub is_entry: bool,
}

---

64-67: 方法签名更新正确，建议更新文档

resolve_id 方法的签名更新正确地包含了新的 PluginResolveIdParams 参数。这个改动与之前添加的新结构体保持一致。

建议同时更新该方法的文档注释，解释新参数的用途和影响。例如：

/// 解析模块 ID
///
/// # 参数
/// * `_source` - 源模块路径
/// * `_importer` - 导入者模块路径
/// * `_params` - 包含额外解析信息的参数，如是否为入口模块
/// * `_context` - 编译上下文
///
/// # 返回值
/// 返回解析后的资源，如果无法解析则返回 None
fn resolve_id(
    &self,
    _source: &str,
    _importer: &str,
    _params: &PluginResolveIdParams,
    _context: &Arc<Context>,
) -> Result<Option<ResolverResource>> {
    Ok(None)
}

---

264-269: PluginDriver 中的 resolve_id 方法更新正确

PluginDriver 结构体中 resolve_id 方法的更新与 Plugin trait 的变更保持一致。新的 params 参数被正确地传递给了每个插件的 resolve_id 方法。

建议更新该方法的文档注释，以反映新增的参数：

/// 调用所有插件的 resolve_id 方法
///
/// # 参数
/// * `source` - 源模块路径
/// * `importer` - 导入者模块路径
/// * `params` - 包含额外解析信息的参数，如是否为入口模块
/// * `context` - 编译上下文
///
/// # 返回值
/// 返回第一个成功解析的结果，如果所有插件都无法解析则返回 None
pub fn resolve_id(
    &self,
    source: &str,
    importer: &str,
    params: &PluginResolveIdParams,
    context: &Arc<Context>,
) -> Result<Option<ResolverResource>> {
    // ... 方法实现 ...
}

---

Line range hint 1-390: 总体评价：功能改进合理，建议完善文档

本次更改通过引入 PluginResolveIdParams 结构体和更新 resolve_id 方法的签名，增强了插件系统在 ID 解析过程中的上下文传递能力。这些修改有助于提供更灵活和强大的插件机制，特别是在处理入口模块时。

主要改进点：

1. 新增 PluginResolveIdParams 结构体，用于传递额外的解析参数。
2. 在 Plugin trait 和 PluginDriver 结构体中更新了 resolve_id 方法的签名。
3. 正确实现了新参数在插件系统中的传递。

建议进一步完善以下方面：

1. 为新增的 PluginResolveIdParams 结构体添加详细的文档注释。
2. 更新 Plugin trait 和 PluginDriver 结构体中 resolve_id 方法的文档，解释新参数的用途和影响。
3. 考虑在项目的开发文档中说明这个变更对现有插件的影响，以及如何更新现有插件以适应新的 API。

这些文档改进将有助于其他开发者理解和正确使用更新后的插件系统。

docs/config.zh-CN.md (1)

548-548: 配置文档更新正确，建议稍作改进

文档中正确更新了 resolveId 方法的签名，添加了 isEntry 参数。这与PR的目标一致，允许插件区分入口点和其他导入。

为了进一步提高文档的清晰度，建议添加一个简短的说明来解释 isEntry 参数的作用。例如：

- resolveId?: (id: string, importer: string, { isEntry: bool }) => Promise<{ id: string, external: bool }>;
+ resolveId?: (id: string, importer: string, { isEntry: bool }) => Promise<{ id: string, external: bool }>;
+   // isEntry: 表示当前解析的模块是否为入口模块

这样的补充说明将帮助开发者更好地理解和使用这个新参数。

crates/mako/src/resolve.rs (1)

56-64: resolve_id 调用更新得当，建议稍微调整注释

context.plugin_driver.resolve_id 调用的更新很好地增加了解析上下文，明确指出当前解析不是针对入口文件的。这个改动提高了与 unplugin hooks 的兼容性。

建议稍微调整注释，使其更加清晰：

- // it's a compatibility feature for unplugin hooks
- // is_entry is always false for dependencies
- // since entry file does not need be be resolved
+ // 这是为了兼容 unplugin hooks 的特性
+ // 对于依赖项，is_entry 始终为 false
+ // 因为入口文件不需要被解析

这样的注释更容易理解，特别是对于中文开发者来说。

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between bcdb3c4 and 719b6d9.

📒 Files selected for processing (9)

• crates/binding/src/js_hook.rs (3 hunks)
• crates/binding/src/js_plugin.rs (2 hunks)
• crates/mako/src/build/analyze_deps.rs (0 hunks)
• crates/mako/src/plugin.rs (3 hunks)
• crates/mako/src/resolve.rs (2 hunks)
• docs/config.md (1 hunks)
• docs/config.zh-CN.md (1 hunks)
• e2e/fixtures/plugins/plugins.config.js (1 hunks)
• packages/mako/binding.d.ts (2 hunks)

💤 Files with no reviewable changes (1)

• crates/mako/src/build/analyze_deps.rs

🧰 Additional context used

🔇 Additional comments (6)

packages/mako/binding.d.ts (1)

55-59: ⚠️ Potential issue

更新 resolveId 方法签名并修正类型

resolveId 方法的签名已更新，包含了一个新的参数来区分入口和非入口模块。这是一个有用的添加，但需要注意以下几点：

1. 这个变更可能会影响现有的 resolveId 钩子实现。请确保更新所有相关的插件或使用此接口的代码。

2. 使用 bool 类型不符合 TypeScript 的惯例。建议将其改为 boolean。

建议应用以下更改：

 resolveId?: (
   source: string,
   importer: string,
-  { isEntry: bool },
+  { isEntry: boolean },
 ) => Promise<{ id: string }>;

请运行以下脚本来验证 resolveId 方法的使用情况：

这将帮助我们确认是否所有的 resolveId 实现都需要更新。

✅ Verification successful

验证通过：无需更改resolveId的使用

经过检查，resolveId方法在代码库中没有发现任何使用实例，因此更新类型为boolean是安全的，不会影响现有实现。

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# 描述：查找 resolveId 方法的所有使用情况
rg --type typescript -e 'resolveId.*=.*\(' -A 5

Length of output: 84

---

Script:

#!/bin/bash
# 描述：查找 resolveId 方法的所有使用情况
rg -g "*.ts" -g "*.tsx" 'resolveId\s*\('

Length of output: 42

docs/config.zh-CN.md (1)

Line range hint 1-1000: 文档更新总体评估

本次更新准确地反映了 resolveId 方法签名的变化，这与PR的目标完全一致。该变更使得插件能够区分入口模块和其他导入，这对于某些高级用例可能很有价值。

文档的其他部分保持不变，这是合适的，因为当前的PR范围仅限于 resolveId 方法的更新。

总的来说，这次文档更新质量良好，为Mako用户提供了最新的配置信息。

docs/config.md (1)

548-548: 更新了 resolveId 钩子的签名

resolveId 钩子现在接受一个额外的参数 { isEntry: bool }。这个新参数允许插件在解析模块 ID 时区分入口点和其他模块。

这个变更增强了插件的功能，使其能够根据模块是否为入口点来执行不同的逻辑。建议更新相关文档和示例，以反映这个新参数的用法。

crates/mako/src/resolve.rs (1)

26-26: 导入语句添加正确

新增的 PluginResolveIdParams 导入语句位置恰当，与其他来自 crate::plugin 模块的导入保持一致。这个改动为后续的函数参数修改做好了准备。

crates/binding/src/js_plugin.rs (1)

67-67: 确保 resolve_id 方法的签名与 Trait 定义一致

在第 67 行，resolve_id 方法增加了参数 params: &PluginResolveIdParams。请确认该方法的签名与 Plugin Trait 的定义保持一致，避免因签名不匹配导致的潜在问题。

crates/binding/src/js_hook.rs (1)

74-75: 新增参数的类型传递正确

更新了 resolve_id 的函数签名，正确地添加了新的参数 ResolveIdParams，类型定义符合预期，实现符合逻辑。

[coderabbitai]

🛠️ Refactor suggestion

优化类型使用以提升代码可读性

在第 74-76 行，创建了一个新的 ResolveIdParams 实例，其值直接来自于传入的 params。由于 ResolveIdParams 与 PluginResolveIdParams 类型名称相似，可能导致混淆。建议考虑以下优化：

• 直接传递 params：如果 ResolveIdParams 与 PluginResolveIdParams 的结构相同，可以直接传递 params，避免冗余的类型转换。
• 重命名类型：如果必须区分这两个类型，考虑重命名其中一个，以更清晰地反映其用途，减少混淆。

[coderabbitai]

⚠️ Potential issue

TypeScript 类型中的 bool 应该为 boolean

在 TypeScript 中，使用 boolean 表示布尔类型，而非 bool。请将类型定义中的 { isEntry: bool } 修改为 { isEntry: boolean }，以确保类型正确。

建议将代码修改如下：

 #[napi(
-    ts_type = "(source: string, importer: string, { isEntry: bool }) => Promise<{ id: string }>;"
+    ts_type = "(source: string, importer: string, { isEntry: boolean }) => Promise<{ id: string }>;"
 )]

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

	#[napi(
	ts_type = "(source: string, importer: string, { isEntry: bool }) => Promise<{ id: string }>;"
	)]
	#[napi(
	ts_type = "(source: string, importer: string, { isEntry: boolean }) => Promise<{ id: string }>;"
	)]

[coderabbitai]

⚠️ Potential issue

确保 ResolveIdParams 结构的字段名在 JavaScript 中正确映射

在 Rust 中，字段名 is_entry 将在 JavaScript 中映射为 is_entry，而 TypeScript 类型定义中使用的是 isEntry。为了保持一致性，建议在字段上添加 #[napi(js_name = "isEntry")] 注解，以将字段名映射为 isEntry。

建议将代码修改如下：

 #[napi(object)]
 pub struct ResolveIdParams {
+    #[napi(js_name = "isEntry")]
     pub is_entry: bool,
 }

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

	pub struct ResolveIdParams {
	pub is_entry: bool,
	}
	#[napi(object)]
	pub struct ResolveIdParams {
	#[napi(js_name = "isEntry")]
	pub is_entry: bool,
	}

[codecov]

Codecov Report

Attention: Patch coverage is 50.00000% with 3 lines in your changes missing coverage. Please review.

Project coverage is 61.97%. Comparing base (bcdb3c4) to head (719b6d9).
Report is 1 commits behind head on master.

Files with missing lines	Patch %	Lines
crates/mako/src/plugin.rs	33.33%	2 Missing ⚠️
crates/mako/src/resolve.rs	66.66%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1631      +/-   ##
==========================================
- Coverage   61.99%   61.97%   -0.02%     
==========================================
  Files         155      155              
  Lines       15462    15465       +3     
==========================================
  Hits         9585     9585              
- Misses       5877     5880       +3     

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