Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

feat: support copy relative path from link files #4367

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

Merged
merged 5 commits into from
Feb 17, 2025

Conversation

erha19
Copy link
Member

@erha19 erha19 commented Feb 13, 2025

Types

  • 🎉 New Features
  • 🐛 Bug Fixes

Background or solution

软链接路径不能直接通过 URI 进行相对路径解析,增加兜底方案

Changelog

support copy relative path from link files

Summary by CodeRabbit

  • 重构
    • 简化了节点路径构建逻辑,采用直接字符串拼接代替了原有复杂的方式。
    • 修改了 EditorFile 类构造函数中的名称属性获取方式,从通用 URI 表示改为更具体的文件系统路径表示。
    • 更新了 OpenedEditorService 中的 URI 处理逻辑,确保使用文件系统路径的一致性。
  • 新功能
    • 在复制相对路径的操作中加入了对符号链接的支持,确保在符号目录下能正确生成目标路径。
  • 依赖更新
    • devDependencies 中新增了 @opensumi/ide-utils 依赖。

@erha19 erha19 requested review from hacke2, Aaaaash and Ricbet February 13, 2025 06:57
@opensumi opensumi bot added the 🎨 feature feature required label Feb 13, 2025
@erha19 erha19 force-pushed the fix/support-copy-relative-path-on-link-files branch from b1a1d5d to 74f14de Compare February 13, 2025 06:59
@erha19
Copy link
Member Author

erha19 commented Feb 13, 2025

/next

Copy link
Contributor

coderabbitai bot commented Feb 13, 2025

"""

Walkthrough

本次变更涉及多个文件。首先,在 TreeNode.ts 中,将原先通过 Path 类实例化和调用 .toString() 构造路径的逻辑,替换为直接的字符串拼接方式,从而简化了路径构造过程。其次,在 file-tree-contribution.ts 文件中,新增了对符号链接的处理逻辑,添加了对 Path 模块的引入,并在 COPY_RELATIVE_PATH 命令的 execute 方法中,通过调用文件树服务以获取符号链接节点后构造相对路径。此外,package.json 文件中新增了对 @opensumi/ide-utils 的依赖,最后,jest.config.js 文件中对测试覆盖率和匹配模式进行了注释和排除模式的调整。

Changes

文件 变更描述
packages/components/.../TreeNode.ts 修改 path getter,使用字符串拼接替换 Path 对象生成路径。
packages/file-tree-next/.../file-tree-contribution.ts 新增 Path 模块导入,并在 COPY_RELATIVE_PATH 命令中添加符号链接处理逻辑。
packages/file-tree-next/.../package.json devDependencies 中新增依赖 @opensumi/ide-utils
jest.config.js 更新 collectCoverageFromtestMatch 的注释及排除模式。

Sequence Diagram(s)

sequenceDiagram
    participant U as 用户
    participant F as FileTreeContribution
    participant S as FileTreeService
    participant P as Path 模块

    U->>F: 调用 COPY_RELATIVE_PATH 命令的 execute(uri)
    alt 检测到符号链接
        F->>S: getNodeByPathOrUri(uri)
        S-->>F: 返回符号链接节点
        F->>P: 分割并拼接路径字符串
        P-->>F: 返回处理后的相对路径
    else 非符号链接处理
        F->>P: 正常构造相对路径
        P-->>F: 返回相对路径
    end
    F-->>U: 返回相对路径结果
Loading

Suggested reviewers

  • hacke2
  • Ricbet
  • ensorrow
    """

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.

yarn install v1.22.22
[1/4] Resolving packages...
warning eslint@8.57.1: This version is no longer supported. Please see https://eslint.org/version-support for other options.
warning eslint > @humanwhocodes/config-array@0.13.0: Use @eslint/config-array instead
warning eslint > @humanwhocodes/config-array > @humanwhocodes/object-schema@2.0.3: Use @eslint/object-schema instead
warning eslint > file-entry-cache > flat-cache > rimraf@3.0.2: Rimraf versions prior to v4 are no longer supported
warning eslint > file-entry-cache > flat-cache > rimraf > glob@7.2.3: Glob versions prior to v9 are no longer supported
warning eslint > file-entry-cache > flat-cache > rimraf > glob > inflight@1.0.6: This module is not supported, and leaks memory. Do not use it. Check out lru-cache if you want a good and tested way to coalesce async requests by a key value, which is much more comprehensive and powerful.
warning eslint-import-resolver-typescript > glob@7.2.3: Glob versions prior to v9 are no longer supported
error Couldn't find any versions for "@opensumi/ide-dev-tool" that matches "workspace:*"
info Visit https://yarnpkg.com/en/docs/cli/install for documentation about this command.

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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
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: 0

🧹 Nitpick comments (2)
packages/file-tree-next/src/browser/file-tree-contribution.ts (1)

784-790: 新增对符号链接文件的支持。

新增了对符号链接文件的相对路径复制支持。通过 filestat.isInSymbolicDirectory 判断文件是否在符号链接目录中,并使用 Path.separator 分割路径以获取相对路径。

建议添加注释说明为什么需要跳过前两个路径段。

 if (node.filestat.isInSymbolicDirectory) {
-  // 软链接文件需要通过直接通过文件树 Path 获取
+  // 软链接文件需要通过文件树 Path 获取
+  // 跳过前两个路径段以获取相对路径,因为...
   return await this.clipboardService.writeText(node.path.split(Path.separator).slice(2).join(Path.separator));
 }
packages/components/src/recycle-tree/tree/TreeNode.ts (1)

239-242: 优化路径构建逻辑。

将原先使用 Path 类实例化和调用 .toString() 的路径构建逻辑,替换为直接的字符串拼接方式,从而简化了路径构造过程。这个改动可以提高性能,因为避免了不必要的对象创建。

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a795630 and 74f14de.

📒 Files selected for processing (2)
  • packages/components/src/recycle-tree/tree/TreeNode.ts (1 hunks)
  • packages/file-tree-next/src/browser/file-tree-contribution.ts (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (9)
  • GitHub Check: 🚀🚀🚀 Next Version for pull request
  • GitHub Check: unittest (ubuntu-latest, 18.x, jsdom)
  • GitHub Check: unittest (ubuntu-latest, 18.x, node)
  • GitHub Check: unittest (macos-latest, 18.x, jsdom)
  • GitHub Check: unittest (macos-latest, 18.x, node)
  • GitHub Check: build (ubuntu-latest, 20.x)
  • GitHub Check: build-windows
  • GitHub Check: ubuntu-latest, Node.js 20.x
  • GitHub Check: build (macos-latest, 20.x)
🔇 Additional comments (1)
packages/file-tree-next/src/browser/file-tree-contribution.ts (1)

53-53: 导入 Path 模块用于路径操作。

导入 Path 模块以支持符号链接文件的路径操作。

@opensumi
Copy link
Contributor

opensumi bot commented Feb 13, 2025

🎉 PR Next publish successful!

3.7.1-next-1739430207.0

Aaaaash
Aaaaash previously approved these changes Feb 17, 2025
Copy link
Member

@Aaaaash Aaaaash left a comment

Choose a reason for hiding this comment

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

LGTM

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: 0

🧹 Nitpick comments (1)
jest.config.js (1)

20-22: 测试覆盖率配置更新已完成

配置更新清晰地表明了 Test 和 Notebook 模块当前不进行测试覆盖率统计。这种明确的排除有助于其他开发者理解当前的测试范围。

建议在后续工作中:

  1. 创建任务追踪这些未覆盖模块的测试计划
  2. 为这些模块逐步添加测试用例
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 4a3ae7d and a53a189.

📒 Files selected for processing (1)
  • jest.config.js (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (8)
  • GitHub Check: unittest (ubuntu-latest, 18.x, jsdom)
  • GitHub Check: unittest (ubuntu-latest, 18.x, node)
  • GitHub Check: unittest (macos-latest, 18.x, jsdom)
  • GitHub Check: unittest (macos-latest, 18.x, node)
  • GitHub Check: build (ubuntu-latest, 20.x)
  • GitHub Check: build (macos-latest, 20.x)
  • GitHub Check: ubuntu-latest, Node.js 20.x
  • GitHub Check: build-windows

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: 0

🧹 Nitpick comments (1)
packages/opened-editor/src/browser/services/opened-editor-tree.service.ts (1)

161-173: 建议增加符号链接文件的相对路径处理

getReadableTooltip 方法目前只处理了 file 协议的 URI,建议增加对符号链接文件的特殊处理,以确保显示的提示信息更加友好。

建议添加以下处理逻辑:

 public async getReadableTooltip(path: URI) {
   if (path.scheme !== Schemes.file) {
     return '';
   }
+  // 如果是符号链接,先解析真实路径
+  const realPath = await this.resourceService.resolve(path);
+  if (realPath && realPath.isSymbolicLink) {
+    path = realPath.targetUri;
+  }
   const roots = await this.workspaceService.roots;
   for (const root of roots) {
     const rootUri = new URI(root.uri);
     if (rootUri.isEqualOrParent(path)) {
       return decodeURIComponent(rootUri.relative(path)?.toString()!);
     }
   }
   return path.toString();
 }
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a53a189 and 478dbe7.

📒 Files selected for processing (3)
  • packages/components/src/recycle-tree/tree/TreeNode.ts (1 hunks)
  • packages/opened-editor/src/browser/opened-editor-node.define.ts (1 hunks)
  • packages/opened-editor/src/browser/services/opened-editor-tree.service.ts (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/components/src/recycle-tree/tree/TreeNode.ts
⏰ Context from checks skipped due to timeout of 90000ms (7)
  • GitHub Check: unittest (ubuntu-latest, 18.x, jsdom)
  • GitHub Check: build (ubuntu-latest, 20.x)
  • GitHub Check: unittest (ubuntu-latest, 18.x, node)
  • GitHub Check: build (macos-latest, 20.x)
  • GitHub Check: build-windows
  • GitHub Check: ubuntu-latest, Node.js 20.x
  • GitHub Check: unittest (macos-latest, 18.x, node)
🔇 Additional comments (3)
packages/opened-editor/src/browser/opened-editor-node.define.ts (1)

73-73: 使用文件系统路径替代 URI 字符串

通过使用 resource.uri.codeUri.fsPath 来获取文件系统路径,可以正确处理符号链接文件的路径。这个改动与 PR 的目标相符,能够确保符号链接文件的相对路径可以被正确复制。

packages/opened-editor/src/browser/services/opened-editor-tree.service.ts (2)

130-131: 使用文件系统路径构建分组树节点路径

在分组树模式下,使用 codeUri.fsPath 来获取文件系统路径,确保符号链接文件的路径能够被正确处理。


138-139: 使用文件系统路径构建非分组树节点路径

在非分组树模式下,同样使用 codeUri.fsPath 来获取文件系统路径,保持了代码的一致性,并支持符号链接文件的路径处理。

Copy link

codecov bot commented Feb 17, 2025

Codecov Report

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

Project coverage is 54.17%. Comparing base (a795630) to head (478dbe7).
Report is 9 commits behind head on main.

Files with missing lines Patch % Lines
...src/browser/services/opened-editor-tree.service.ts 25.00% 3 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4367      +/-   ##
==========================================
- Coverage   54.18%   54.17%   -0.01%     
==========================================
  Files        1639     1621      -18     
  Lines      100306   100268      -38     
  Branches    21761    21783      +22     
==========================================
- Hits        54349    54323      -26     
+ Misses      38188    38153      -35     
- Partials     7769     7792      +23     
Flag Coverage Δ
jsdom 49.65% <66.66%> (-0.01%) ⬇️
node 12.28% <0.00%> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

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

Copy link
Member

@hacke2 hacke2 left a comment

Choose a reason for hiding this comment

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

LGTM

@hacke2 hacke2 merged commit 2aba876 into main Feb 17, 2025
12 checks passed
@hacke2 hacke2 deleted the fix/support-copy-relative-path-on-link-files branch February 17, 2025 06:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🎨 feature feature required
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants
Morty Proxy This is a proxified and sanitized view of the page, visit original site.