feat(diff-previewer): support data prop

bytemain commented 3 months ago

Types

[x] 🎉 New Features

Background or solution

ChangeLog

Summary by CodeRabbit

新功能
- 引入 DiffPreviewer 作为 DiffViewerRenderer 的别名，便于组件的访问与使用。
- DiffViewerRenderer 组件现在支持接收 data 属性，以处理多个 diff 项，提升功能表现。
改进
- 重构了 DiffViewerContribution 类的方法，增强了错误处理和资源管理的清晰度。
接口更新
- 新增 IDiffItem 接口，包含 path、oldCode 和 newCode 属性，用于表示单个 diff 项。

ant-codespaces[bot] commented 3 months ago

Run and Debug this pull request in Codespaces

coderabbitai[bot] commented 3 months ago

Walkthrough

## Walkthrough 此次变更涉及对`DiffViewerRenderer`组件的属性处理方式进行简化，并引入新的`IDiffItem`接口来表示单个差异项。同时，`DiffViewerContribution`类进行了重构，移除了与命令贡献相关的接口，优化了方法的结构和错误处理。这些修改提高了组件的功能性和代码的可维护性。 ## Changes | 文件 | 变更摘要 | |------|----------| | `packages/core/src/api/renderDiffViewer.tsx` | 修改`DiffViewerRenderer`组件以直接接受`props`，引入`DiffPreviewer`作为别名，并在`App`函数中添加`data`属性。 | | `packages/core/src/core/diff-viewer/common.ts` | 新增`IDiffItem`接口，更新`IDiffViewerProps`以包含可选的`data`属性（类型为`IDiffItem[]`）。 | | `packages/core/src/core/diff-viewer/internal/base.ts` | 重构`DiffViewerContribution`类，移除`CommandContribution`接口，优化`initialize`方法及文件打开相关方法的结构。 |

Recent review details

**Configuration used: .coderabbit.yml** **Review profile: CHILL**

Commits

Files that changed from the base of the PR and between 7b8f1b6794cdd06659e4150169312df86a7ace3d and 19a928bc248a70acbf614f3937e4821b35548c3e.

Files selected for processing (4)

* packages/core/src/api/renderDiffViewer.tsx (2 hunks) * packages/core/src/core/diff-viewer/common.ts (1 hunks) * packages/core/src/core/diff-viewer/internal/base.ts (8 hunks) * packages/startup/src/diff-viewer/index.tsx (2 hunks)

Additional comments not posted (17)

packages/core/src/core/diff-viewer/common.ts (2)
`119-123`: **定义正确** `IDiffItem` 接口定义正确，包含 `path`、`oldCode` 和 `newCode` 属性。代码更改已批准。 --- `124-127`: **定义正确** `IDiffViewerProps` 接口中添加了可选属性 `data`，增强了 diff 预览器的功能。代码更改已批准。

packages/core/src/api/renderDiffViewer.tsx (2)
`51-71`: **简化属性处理** `DiffViewerRenderer` 现在直接接受 `props`，并在 `merge` 函数中使用 `props`。此外，检查 `appConfig` 中 `injector` 存在性的逻辑已更新为引用 `mergedProps`。这些更改简化了属性处理，确保了合并属性的一致使用。代码更改已批准。 --- `145-145`: **引入别名** `DiffPreviewer` 被引入作为 `DiffViewerRenderer` 的别名，便于访问和使用 `DiffViewerRenderer` 组件。代码更改已批准。

packages/startup/src/diff-viewer/index.tsx (1)
`59-59`: **简化控制流** 在 `DiffViewerRenderer` 组件中添加了 `data` 属性，并移除了处理 `data` 数组以在标签中打开 diff 的循环。这些更改通过将 diff 渲染逻辑集中在 `DiffViewerRenderer` 中简化了控制流。代码更改已批准。

packages/core/src/core/diff-viewer/internal/base.ts (12)
`80-92`: **代码看起来不错！** 该函数正确地打开了一个标签页中的文件。代码更改已批准。 --- `94-140`: **代码看起来不错！** 该函数正确地实现了打开差异视图的逻辑，并且包含了错误处理和预览器的创建。代码更改已批准。 --- `143-145`: **代码看起来不错！** 该函数使用了 `sequencer` 来确保操作按顺序执行。代码更改已批准。 --- `147-202`: **代码看起来不错！** 该函数正确地实现了通过流打开差异视图的逻辑，并且包含了错误处理和预览器的创建。代码更改已批准。 --- `204-205`: **代码看起来不错！** 该函数正确地获取了编辑器的文件路径。代码更改已批准。 --- `208-216`: **代码看起来不错！** 该函数正确地获取了所有标签页。代码更改已批准。 --- `218-221`: **代码看起来不错！** 该函数正确地获取了文件索引。代码更改已批准。 --- `223-246`: **代码看起来不错！** 该函数正确地获取了 URI 的差异信息。代码更改已批准。 --- Line range hint `249-364`: **代码看起来不错！** 该函数正确地实现了初始化逻辑。代码更改已批准。 --- `366-371`: **代码看起来不错！** 该函数正确地实现了启动时的操作。代码更改已批准。 --- Line range hint `373-378`: **代码看起来不错！** 该函数正确地实现了菜单的注册。代码更改已批准。 --- Line range hint `379-381`: **代码看起来不错！** 该函数正确地实现了资源的释放。代码更改已批准。

--- 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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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 as 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

opensumi / codeblitz