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

feat: auto resolve entry file extension #1718

Merged
merged 2 commits into from
Dec 12, 2024
Merged

Conversation

xusd320
Copy link
Contributor

@xusd320 xusd320 commented Dec 11, 2024

Close #924

Summary by CodeRabbit

  • 新特性

    • 更新配置模块以支持新的 JavaScript 文件扩展名,改进入口文件路径解析。
    • 在配置中新增了两个条目 "soo": "src/soo""yoo": "src/yoo"
    • 添加了新的控制台日志功能,输出字符串 'bar'。
  • 测试

    • 在测试套件中增加了对新文件 soo.jsyoo.js 的存在性检查。

@xusd320 xusd320 requested a review from sorrycc December 11, 2024 08:20
Copy link
Contributor

coderabbitai bot commented Dec 11, 2024

Walkthrough

此次变更涉及对 mako 配置模块中 Config 结构及其相关方法的多项修改。新增了从 crate::build::load 导入的 JS_EXTENSIONS,并更新了入口文件路径的逻辑,以遍历预定义的基本文件名列表并检查文件的存在性。入口路径的标准化方法进行了重构,错误处理逻辑得以保留,同时简化了别名解析逻辑。测试文件也增加了对新文件的存在性检查,配置文件中新增了两个条目。

Changes

文件路径 变更摘要
crates/mako/src/config.rs 修改 Config 结构,新增 JS_EXTENSIONS 导入,更新入口文件路径逻辑,重构入口路径标准化方法,简化别名解析逻辑,保留错误处理。
e2e/fixtures/config.entry/expect.js 在测试中新增对 soo.jsyoo.js 的存在性检查。
e2e/fixtures/config.entry/mako.config.json entry 对象中新增 "soo": "src/soo""yoo": "src/yoo" 条目。
e2e/fixtures/config.entry/src/soo.ts soo.ts 中新增控制台日志输出 'bar'。
e2e/fixtures/config.entry/src/yoo/index.ts index.ts 中新增控制台日志输出 'bar'。

Assessment against linked issues

Objective Addressed Explanation
必须写明文件后缀 (Issue #924)

Possibly related PRs

Suggested reviewers

  • sorrycc
  • stormslowly
  • Jinbao1001

🐰 在代码的田野间,
新增条目如春花鲜。
日志响亮声声传,
配置更清晰,真可喜!
让我们一起欢庆这变化,
兔子跳跃,乐无边! 🌼✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between c2bae12 and e491471.

📒 Files selected for processing (1)
  • crates/mako/src/config.rs (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • crates/mako/src/config.rs

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

Walkthrough

This pull request introduces a feature to automatically resolve entry file extensions in the configuration. It modifies the logic to dynamically check for JavaScript extensions when determining entry files, enhancing flexibility and reducing the need for hardcoded paths.

Changes

File Summary
crates/mako/src/config.rs Refactored entry file resolution to dynamically check for JavaScript extensions, improving flexibility in entry file configuration.
e2e/fixtures/config.entry/expect.js Added assertions to test new entry file resolution logic.
e2e/fixtures/config.entry/mako.config.json Updated configuration to align with new entry resolution logic.
e2e/fixtures/config.entry/src/soo.ts Added a new test file for entry resolution.
e2e/fixtures/config.entry/src/yoo/index.ts Added a new test file for entry resolution.

Copy link
Contributor

@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: 1

🧹 Outside diff range and nitpick comments (1)
crates/mako/src/config.rs (1)

337-344: 建议优化默认入口文件的查找逻辑

当前实现是可行的,但可以通过以下方式优化:

  1. 使用 find_map 替代嵌套循环
  2. 提取路径数组为常量

建议重构为:

-let file_paths = ["src/index", "index"];
-'outer: for file_path in file_paths {
-    for ext in JS_EXTENSIONS {
-        let file_path = root.join(file_path).with_extension(ext);
-        if file_path.exists() {
-            config.entry.insert("index".to_string(), file_path);
-            break 'outer;
-        }
-    }
-}
+const DEFAULT_ENTRY_PATHS: &[&str] = &["src/index", "index"];
+if let Some(file_path) = DEFAULT_ENTRY_PATHS
+    .iter()
+    .find_map(|path| {
+        JS_EXTENSIONS.iter().find_map(|ext| {
+            let file_path = root.join(path).with_extension(ext);
+            file_path.exists().then_some(file_path)
+        })
+    })
+{
+    config.entry.insert("index".to_string(), file_path);
+}
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 6bee118 and c2bae12.

📒 Files selected for processing (5)
  • crates/mako/src/config.rs (3 hunks)
  • e2e/fixtures/config.entry/expect.js (1 hunks)
  • e2e/fixtures/config.entry/mako.config.json (1 hunks)
  • e2e/fixtures/config.entry/src/soo.ts (1 hunks)
  • e2e/fixtures/config.entry/src/yoo/index.ts (1 hunks)
✅ Files skipped from review due to trivial changes (2)
  • e2e/fixtures/config.entry/src/soo.ts
  • e2e/fixtures/config.entry/src/yoo/index.ts
🔇 Additional comments (4)
e2e/fixtures/config.entry/mako.config.json (1)

5-7: 配置更改展示了新的文件扩展名自动解析功能!

配置文件很好地展示了新旧两种入口配置方式的兼容性:

  • hoo/hoo 保持了显式的 .ts 扩展名
  • sooyoo 使用了新的无扩展名方式
e2e/fixtures/config.entry/expect.js (1)

12-13: 测试用例完整覆盖了新功能!

新增的断言验证了构建系统能够:

  1. 正确解析无扩展名的入口文件
  2. 在输出中生成正确的 .js 文件
crates/mako/src/config.rs (2)

77-77: 复用现有常量是个好选择!

build::load 模块导入 JS_EXTENSIONS 常量,避免了重复定义支持的文件扩展名列表。


386-393: 别名解析逻辑简化得很好!

使用 iter_mut 进行原地更新是个很好的选择,代码简洁且高效。

@xusd320 xusd320 requested a review from PeachScript December 11, 2024 08:25
Copy link

codecov bot commented Dec 11, 2024

Codecov Report

Attention: Patch coverage is 42.42424% with 19 lines in your changes missing coverage. Please review.

Project coverage is 54.90%. Comparing base (6bee118) to head (e491471).
Report is 1 commits behind head on master.

Files with missing lines Patch % Lines
crates/mako/src/config.rs 42.42% 19 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1718      +/-   ##
==========================================
- Coverage   54.92%   54.90%   -0.03%     
==========================================
  Files         178      178              
  Lines       17843    17856      +13     
==========================================
+ Hits         9800     9803       +3     
- Misses       8043     8053      +10     

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

@stormslowly stormslowly merged commit 75c356d into master Dec 12, 2024
19 of 21 checks passed
@stormslowly stormslowly deleted the feat/entry-file-extension branch December 12, 2024 03:02
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.

[BUG] entry 配置必须写明文件后缀
2 participants