Support auto translate to english #821
Conversation
概述演练这个拉取请求主要涉及文档翻译工作流程和翻译脚本的改进。GitHub Actions 工作流程文件被修改，增加了一个新的英文文档翻译作业。同时，添加了两个新的翻译脚本： 变更
可能相关的 PR
诗歌
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (8)
bin/doc-translate.js (3)
8-11: 建议重命名变量以避免混淆
这里的命名openai容易让读者误以为调用的是 OpenAI 的服务，实际上却设置了 DeepSeek 的端点。建议使用更贴近服务的名称，例如deepseekClient。
13-22: 在获取completion.choices[0]前添加安全检查
如果接口响应异常或未返回可用结果，completion.choices[0]可能为undefined。为增强健壮性，建议在访问前先判断completion.choices数组是否包含元素，以避免潜在错误。
49-49: 避免硬编码源目录与目标目录
此处直接写死了'docs/zh-cn'到'docs/en'。若将来需要支持其他语言或灵活指定目录，建议将这两个路径做成可配置参数，例如通过命令行或配置文件传入。bin/doc-translate.github-model.js (4)
9-15: 留意dangerouslyAllowBrowser: true配置
在此处设置dangerouslyAllowBrowser: true可能会带来潜在安全风险。如果不必要，建议移除该选项，以减少安全隐患。
16-17: 路径写法可考虑作为参数
docsPath固定为docs/zh-cn，若后续需要多语言或不同目录结构，建议将路径通过函数参数或配置文件进行管理，提升灵活度。
35-47: 考虑大规模文档目录结构时的处理方式
使用递归处理子目录在深层嵌套时依然可行，但若文档量过大，可能会带来性能或堆栈问题。建议酌情考虑异步队列或并发处理，以提高效率和稳定性。
52-52: 可对错误进行更详细记录
translateFiles().catch(console.error)虽能捕获异常，但仅打印错误消息，若在 CI/CD 中出现此错误，可能难以追踪细节。可考虑记录更详细的错误上下文或终止流程以便故障排查。.github/workflows/docs-translate.yaml (1)
51-51: 空行可保留或移除
此处仅是空白行并不影响功能，若无特殊需求可以保持当前状态或干净移除。
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
.github/workflows/docs-translate.yaml(2 hunks)bin/doc-translate.github-model.js(1 hunks)bin/doc-translate.js(1 hunks)docs/zh-cn/components/encryption.md(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- docs/zh-cn/components/encryption.md
🧰 Additional context used
🪛 yamllint (1.35.1)
.github/workflows/docs-translate.yaml
[error] 83-83: no new line character at the end of file
(new-line-at-end-of-file)
🔇 Additional comments (9)
bin/doc-translate.js (3)
2-2: 使用 fs/promises 提升异步可读性
这里使用 fs/promises 替换同步或回调式读写文件，能增强可读性并减少回调嵌套。实现上没有问题，保持现状即可。
5-6: 确保环境变量存在并避免令牌为空时的潜在错误
当前直接从 process.env["DEEPSEEK_API_KEY"] 获取令牌，若该环境变量未设置将导致后续请求失败。建议在使用前校验令牌是否为空，以免在未设置时抛出异常。
24-46: 确认 readdir 中的 { recursive: true } 是否兼容
Node.js 原生的 readdir API 通常不支持直接使用 recursive: true，有时需改成使用 withFileTypes: true 并手动递归。请确认所使用的 Node.js 版本或用自定义方式遍历文件，以避免在较旧运行环境中出现不兼容问题。
bin/doc-translate.github-model.js (4)
1-4: 引入必要的依赖库
导入 OpenAI、fs 与 path 没有显著问题，此处写法清晰明了。
5-8: 请确认环境变量 GITHUB_TOKEN 是否已经正确设置
如若令牌未配置，后续 API 调用会失败。建议对令牌值进行非空校验或在调用前提示用户。
18-34: 在使用 response.choices[0] 前应先检查数组长度
和前面类似，这里也需要关注当 response.choices 为空时如何处理，以免出现访问越界或空引用错误。
49-50: 调用入口处缺少执行完成后的提示
此处只在函数内部打印翻译的文件路径，整体完成后若能日志输出 “翻译完成” 等信息，可进一步提升可读性和可维护性。
.github/workflows/docs-translate.yaml (2)
9-9: 重命名 Job 为 translate-zh
此改动清晰地标识了翻译的目标语言，有助于区分不同翻译流程。
52-83: 新增 translate-en Job
- 已在
env中注入DEEPSEEK_API_KEY，需确保在仓库配置了对应的机密变量。 pnpm run docs:translate将使用新脚本进行英文翻译，流程清晰易懂。- 最后一步自动提交更新，能自动化保存翻译结果。
如需兼顾更多语言或更细化的流程，可继续扩展。整体实现合理。
🧰 Tools
🪛 yamllint (1.35.1)
[error] 83-83: no new line character at the end of file
(new-line-at-end-of-file)
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
.github/workflows/docs-translate.yaml (2)
Line range hint
9-51: 建议优化安装和构建过程工作流程的这一部分功能正常，但可以通过以下方式改进：
- 考虑使用 Docker 容器来预装 OpenCC 和其他依赖，这样可以减少构建时间
- 可以将 OpenCC 的安装步骤抽取到一个复用的复合操作中
81-84: 修复 YAML 格式问题文件末尾缺少换行符，这可能会在某些工具中导致问题。
with: commit_message: Update docs and translate +🧰 Tools
🪛 yamllint (1.35.1)
[error] 84-84: no new line character at the end of file
(new-line-at-end-of-file)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (7)
.github/workflows/docs-translate.yaml(2 hunks)docs/zh-cn/components/cache.md(1 hunks)docs/zh-cn/components/fast-paginate.md(1 hunks)docs/zh-hk/components/cache.md(1 hunks)docs/zh-hk/components/fast-paginate.md(1 hunks)docs/zh-tw/components/cache.md(1 hunks)docs/zh-tw/components/fast-paginate.md(1 hunks)
✅ Files skipped from review due to trivial changes (3)
- docs/zh-cn/components/fast-paginate.md
- docs/zh-hk/components/fast-paginate.md
- docs/zh-tw/components/fast-paginate.md
🚧 Files skipped from review as they are similar to previous changes (3)
- docs/zh-tw/components/cache.md
- docs/zh-cn/components/cache.md
- docs/zh-hk/components/cache.md
🧰 Additional context used
🪛 yamllint (1.35.1)
.github/workflows/docs-translate.yaml
[error] 84-84: no new line character at the end of file
(new-line-at-end-of-file)
🔇 Additional comments (1)
.github/workflows/docs-translate.yaml (1)
52-57: 建议加强密钥安全性和错误处理
环境变量配置需要注意以下几点：
- 建议添加 DEEPSEEK_API_KEY 的密钥轮换机制
- 考虑添加请求速率限制，以防止 API 配额过度使用
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (35)
docs/en/components/pretty-console.md (1)
33-36: 建议保持文档引用的一致性在致谢部分，Laravel 项目的引用格式不一致。建议保持项目名称的大小写一致性，以保持专业性。
建议修改为：
-The idea from pr of laravel +The idea from PR of Laraveldocs/en/components/model-factory.md (2)
Line range hint
26-32: 建议增加更多用户属性示例当前的工厂定义仅包含基本的name和email属性。建议添加更多常见的用户属性示例，如password、created_at等，以便更好地展示工厂的使用方法。
建议添加如下属性：
$factory->define(User::class, function (Faker\Generator $faker) { return [ 'name' => $faker->name, 'email' => $faker->unique()->email, + 'password' => bcrypt('password'), + 'created_at' => $faker->dateTimeThisYear, + 'updated_at' => $faker->dateTimeThisYear, ]; });
60-60: 建议完善批量创建用户的注释说明当前注释简单说明了创建20个随机用户，建议补充说明这些用户的用途，例如用于测试或演示环境。
建议修改注释为：
- // Create 20 random users + // Create 20 random users for testing or demonstration purposesdocs/en/components/fast-paginate.md (2)
Line range hint
13-24: 建议使用相对链接引用源代码当前使用的是绝对 GitHub 链接，如果文件位置发生变化可能会失效。建议改用相对链接以提高文档的可维护性。
🧰 Tools
🪛 LanguageTool
[style] ~42-~42: Using many exclamation marks might seem excessive (in this case: 5 exclamation marks for a text that’s 1861 characters long)
Context: ...ery()->fastPaginate()`! It's that simple! The method signature is the same. Rela...(EN_EXCESSIVE_EXCLAMATION)
42-42: 建议减少感叹号的使用当前行使用了过多的感叹号，建议保留一个感叹号以保持专业的文档风格。
建议修改为：
-Anywhere you would use `Model::query()->paginate()`, you can use `Model::query()->fastPaginate()`! It's that simple! The method signature is the same. +Anywhere you would use `Model::query()->paginate()`, you can use `Model::query()->fastPaginate()`. It's that simple. The method signature is the same.🧰 Tools
🪛 LanguageTool
[style] ~42-~42: Using many exclamation marks might seem excessive (in this case: 5 exclamation marks for a text that’s 1861 characters long)
Context: ...ery()->fastPaginate()`! It's that simple! The method signature is the same. Rela...(EN_EXCESSIVE_EXCLAMATION)
docs/en/components/mysql-grammar-addon.md (1)
3-3: 文档改进显著，建议进一步完善！文档更新很好地改进了属性描述，将占位符替换为有意义的说明。
建议：
- 为保持一致性，可以考虑为
id属性也添加描述- 属性描述的格式建议统一采用标题格式（首字母大写）
Also applies to: 11-11, 29-29, 37-37, 39-39
docs/en/components/confd.md (1)
3-3: 文档结构清晰，内容准确！文档的改进恰当：
- 更准确地描述了组件的定位
- 统一了章节标题的风格
- 明确了支持的功能列表
建议：
- 考虑为未支持的功能（如 Consul）添加计划支持时间或开发状态说明
Also applies to: 16-16, 22-22, 56-56
docs/en/components/model-morph-addon.md (1)
Line range hint
44-90: 代码示例的改进很出色！新的实现方式通过
getActualClassNameForMorph和getMorphClass方法提供了更好的类型映射控制，使得代码结构更加清晰，维护性更强。建议补充一下这种实现方式的优势说明。需要我帮助编写关于新实现方式优势的补充说明吗？
docs/en/components/lock.md (1)
3-3: 建议统一技术术语的翻译以下术语的翻译建议调整：
- "Atomic Lock Component" 建议翻译为 "原子锁组件"
- "Publish Configuration" 建议翻译为 "发布配置"
- "Annotation Method" 建议翻译为 "注解方式"
保持技术术语的一致性有助于文档的理解和维护。
Also applies to: 13-13, 63-63
docs/en/components/sentry.md (2)
3-3: 建议优化章节标题的翻译以下标题的翻译建议调整：
- "Sentry component for Hyperf" 建议翻译为 "Hyperf Sentry 组件"
- "Register LoggerHandler" 建议翻译为 "注册日志处理器"
- "Configure Sentry Runtime Logs" 建议翻译为 "配置 Sentry 运行时日志"
- "Tracing" 建议翻译为 "链路追踪"
保持专业术语的准确性和一致性。
Also applies to: 17-17, 48-48, 79-79
100-101: 外部链接的本地化建议建议为外部文档链接添加中文说明，帮助中文用户更好地理解链接内容：
- "OpenTelemetry 语义约定" [semantic-conventions]
- "Sentry Span 操作命名约定" [span-operations]
bin/doc-translate.js (2)
5-8: 建议将配置参数移至环境变量或配置文件当前的实现中有一些硬编码的值，建议改进：
- endpoint URL 应该可配置
- 最大并发数和重试次数应该通过环境变量配置
建议修改如下：
-const endpoint = "https://api.deepseek.com"; -const MAX_CONCURRENT = 5; // 最大并发数 -const MAX_RETRIES = 3; // 最大重试次数 +const endpoint = process.env.DEEPSEEK_API_ENDPOINT || "https://api.deepseek.com"; +const MAX_CONCURRENT = parseInt(process.env.TRANSLATE_MAX_CONCURRENT || "5"); +const MAX_RETRIES = parseInt(process.env.TRANSLATE_MAX_RETRIES || "3");
15-32: 建议增强错误处理和日志记录翻译重试机制的实现很好，但可以进一步改进错误处理：
- 应该记录具体的错误信息
- 在重试之前应该判断错误类型
建议添加更详细的错误处理：
} catch (error) { + console.error(`翻译失败 (重试 ${retries + 1}/${MAX_RETRIES}):`, error.message); if (retries < MAX_RETRIES) { + // 只对特定类型的错误进行重试 + if (error.status === 429 || error.status >= 500) { await new Promise(resolve => setTimeout(resolve, 1000 * (retries + 1))); return translateWithRetry(content, retries + 1); + } } throw error;docs/en/components/telescope.md (2)
Line range hint
120-127: 建议改进标签示例代码的健壮性当前的标签示例代码可以进行以下改进：
- 添加类型提示
- 增加空值检查
建议修改如下：
// attach your own custom tags -Telescope::tag(function (IncomingEntry $entry) { +Telescope::tag(function (IncomingEntry $entry): array { if ($entry->type === 'request') { + $status = $entry->content['response_status'] ?? 'unknown'; + $uri = $entry->content['uri'] ?? 'unknown'; return [ - 'status:' . $entry->content['response_status'], - 'uri:'. $entry->content['uri'], + 'status:' . $status, + 'uri:' . $uri, ]; } + return []; });
Line range hint
130-137: 建议优化过滤器的条件判断过滤器的实现可以更加简洁和清晰：
- 使用更简洁的条件判断
- 添加适当的注释说明过滤逻辑
建议修改如下：
// filter entry Telescope::filter(function (IncomingEntry $entry): bool { - if ($entry->type === 'request'){ - if ($entry->content['uri'] == 'xxxx') { - return false; - } - } - return true; + // 排除特定 URI 的请求 + if ($entry->type === 'request' && ($entry->content['uri'] ?? '') === 'xxxx') { + return false; + } + return true; });docs/en/components/tcp-sender.md (3)
27-29: 需要优化回调方法的声明格式建议在类名和方法名之间添加空格，以提高代码的可读性。
- Event::ON_CONNECT => [TcpServer::class,'onConnect'], - Event::ON_CLOSE => [TcpServer::class,'onClose'], - Event::ON_RECEIVE => [TcpServer::class,'onReceive'], + Event::ON_CONNECT => [TcpServer::class, 'onConnect'], + Event::ON_CLOSE => [TcpServer::class, 'onClose'], + Event::ON_RECEIVE => [TcpServer::class, 'onReceive'],
51-51: 接口实现声明需要添加空格在实现多个接口时，接口之间应该添加空格，以符合 PSR 编码规范。
-class TcpServer implements OnCloseInterface,OnReceiveInterface +class TcpServer implements OnCloseInterface, OnReceiveInterface
99-100: 需要优化方法参数间的空格在方法调用时，参数之间应该添加空格，以提高代码的可读性。
- $this->sender->setResponse($fd,$connection); + $this->sender->setResponse($fd, $connection); - $this->sender->setResponse($fd,null); + $this->sender->setResponse($fd, null);Also applies to: 106-106
docs/en/components/compoships.md (2)
36-36: 文档格式需要统一建议保持文档格式的一致性，特别是在描述类和特性的使用时。同时，建议在重要概念前后添加空行以提高可读性。
Also applies to: 40-40
84-90: 列表项重复和格式问题
- 列表中出现了重复的短语 "A team"
- 建议在列表前后添加空行以提高可读性
建议修改为：
As an example, let's assume we have a task list with categories, managed by multiple user teams, where: - A task belongs to a category - A task is assigned to a team - Teams have many users - A user belongs to a team - A user is responsible for tasks in a category🧰 Tools
🪛 LanguageTool
[grammar] ~87-~87: This phrase is duplicated. You should probably use “a team” only once.
Context: ...s to a category - A task is assigned to a team - A team has many users - A user belongs to a te...(PHRASE_REPETITION)
docs/en/components/model-hashids.md (2)
67-70: 注释格式不一致建议统一注释中的术语使用，保持一致的大小写规范。
-// Decoding a hashid to its equivalent id +// Decoding a hashid to its equivalent ID -// Encoding an id to its equivalent hashid +// Encoding an ID to its equivalent hashid
171-173: 文档结构建议建议在标题和正文之间添加空行，以提高文档的可读性。同时，确保相关功能说明更加清晰。
docs/en/components/notification.md (3)
11-11: 文档格式需要保持一致性标题中的
Trait大写可能与其他文档的风格不一致。建议检查其他文档中的术语大小写使用规范。
107-108: 示例代码中的输出信息需要统一示例代码中的消息格式和标点符号使用不一致：
- 有的地方使用英文冒号，有的地方没有空格
- 消息内容的格式不统一
建议统一格式：
-$user->notify(new TestNotification('System Notification:xxx')); +$user->notify(new TestNotification('System Notification: xxx')); -$this->output->success('Sent successfully, unread messages count:' . $noReadCount); +$this->output->success('Sent successfully, unread messages count: ' . $noReadCount); -$this->output->success('Message content:' . $notifications->data['message']); +$this->output->success('Message content: ' . $notifications->data['message']); -$this->output->success('Marked as read, unread messages count:' . $noReadCount); +$this->output->success('Marked as read, unread messages count: ' . $noReadCount);Also applies to: 110-110, 112-112, 115-115
244-245: 示例代码格式需要保持一致性为保持与之前示例的一致性，建议：
-$user->notify(new TestNotification('System Notification:xxx')); +$user->notify(new TestNotification('System Notification: xxx'));docs/en/components/tinker.md (2)
3-3: 文档描述更新建议当前描述比较简单，建议补充更多关于该工具用途和特性的说明。
建议添加以下内容：
- 交互式调试功能
- 支持的特性列表
- 使用场景说明
25-25: 文档结构需要统一命令部分的标题格式不一致：
- 有的使用动词开头
- 有的使用名词开头
建议统一使用动词开头的格式：
-Run Commands +Running Commands -View Command Help +Viewing Command Help -Get Environment Variables +Getting Environment Variables -View Documentation +Viewing Documentation -View Source Code +Viewing Source CodeAlso applies to: 40-40, 69-69, 148-148, 160-160
docs/en/components/purifier.md (3)
3-3: 文档语言风格需要统一文档中的描述语言风格不一致，有的使用直接陈述，有的使用被动语态。建议统一使用主动语态，使文档更易读。
-HTML Filter. Derived from [mews/purifier] +An HTML Filter tool derived from [mews/purifier] -Install this component using Composer: +Install the component with Composer: -The service provider will be automatically discovered. +The system automatically discovers the service provider. -Use the following method in a request or middleware to clean HTML: +Clean HTML in your requests or middleware using the following method:Also applies to: 7-7, 13-13, 17-17
67-69: 代码注释的表述需要更准确模型中的 Cast 类说明注释需要更准确地描述其行为：
-'bio' => CleanHtml::class, // Cleans both when getting and setting the value +'bio' => CleanHtml::class, // 在获取和设置值时都进行清理 -'description' => CleanHtmlInput::class, // Cleans when setting the value +'description' => CleanHtmlInput::class, // 仅在设置值时进行清理 -'history' => CleanHtmlOutput::class, // Cleans when getting the value +'history' => CleanHtmlOutput::class, // 仅在获取值时进行清理
82-82: 配置文件说明需要更详细建议为配置文件添加更详细的说明，包括各个配置项的用途和可选值。
建议在配置文件示例前添加：
- 配置项说明
- 默认值说明
- 常见配置场景示例
docs/en/components/validated-dto.md (4)
25-25: 建议添加更详细的验证规则说明建议在这里补充一些常用验证规则的具体示例，以帮助开发者更好地理解如何使用验证规则。
86-86: 建议补充隐藏字段的具体示例为了让开发者更好地理解模型隐藏字段的影响，建议添加一个具体的代码示例来说明。
Line range hint
208-236: 建议完善默认值示例说明当前的默认值示例很好，但建议：
- 添加更多实际应用场景的示例
- 说明默认值的计算时机
- 解释与验证规则的关系
Line range hint
331-345: 建议增加类型转换的注意事项建议在类型转换部分补充：
- 类型转换失败时的异常处理
- 自定义转换器的最佳实践
- 性能相关的考虑因素
docs/en/guide/start/components.md (1)
5-34: 建议优化表格格式表格格式存在以下问题需要修正：
- 部分行缺少尾部分隔符
- 建议统一表格的对齐方式，提高可读性
建议应用以下修改：
- 确保每行都以
|结尾- 使用左对齐方式统一所有列：
| Repository | Stable Version | Total Downloads | Monthly Downloads | |:--|:--|:--|:--|🧰 Tools
🪛 Markdownlint (0.37.0)
34-34: Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
Table pipe style(MD055, table-pipe-style)
🪛 LanguageTool
[style] ~7-~7: Using many exclamation marks might seem excessive (in this case: 84 exclamation marks for a text that’s 14062 characters long)
Context: .../github.com/friendsofhyperf/amqp-job) ||
|
| | cache |
|
|
| | command-signals |
|
|
| | command-validation |
|
|
| | compoships |
|
|
| | confd |
|
|
| | config-consul |
|
|
| | console-spinner |
|
|
| | di-plus |
|
|
| | elasticsearch |
|
|
| | encryption |
|
|
| | exception-event |
|
|
| | facade |
|
|
| | fast-paginate |
|
|
| | grpc-validation |
|
|
| | helpers |
|
|
| | http-client |
|
|
| | http-logger |
|
|
| | ide-helper |
|
|
| | ipc-broadcaster |
|
|
| | lock |
|
|
| | macros |
|
|
| | mail |
|
|
| | middleware-plus |
|
|
| | model-factory |
|
|
| | model-hashids |
|
|
| | model-morph-addon |
|
|
| | model-observer |
|
| [
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (53)
.github/workflows/docs-translate.yaml(2 hunks)bin/doc-translate.js(1 hunks)docs/en/components/amqp-job.md(1 hunks)docs/en/components/cache.md(4 hunks)docs/en/components/command-signals.md(2 hunks)docs/en/components/command-validation.md(2 hunks)docs/en/components/compoships.md(6 hunks)docs/en/components/confd.md(3 hunks)docs/en/components/config-consul.md(1 hunks)docs/en/components/console-spinner.md(2 hunks)docs/en/components/di-plus.md(2 hunks)docs/en/components/elasticsearch.md(1 hunks)docs/en/components/fast-paginate.md(2 hunks)docs/en/components/grpc-validation.md(1 hunks)docs/en/components/http-client.md(1 hunks)docs/en/components/http-logger.md(1 hunks)docs/en/components/ide-helper.md(2 hunks)docs/en/components/index.md(1 hunks)docs/en/components/ipc-broadcaster.md(1 hunks)docs/en/components/lock.md(5 hunks)docs/en/components/mail.md(5 hunks)docs/en/components/middleware-plus.md(2 hunks)docs/en/components/model-factory.md(3 hunks)docs/en/components/model-hashids.md(4 hunks)docs/en/components/model-morph-addon.md(1 hunks)docs/en/components/model-observer.md(3 hunks)docs/en/components/model-scope.md(3 hunks)docs/en/components/mysql-grammar-addon.md(2 hunks)docs/en/components/notification-easysms.md(2 hunks)docs/en/components/notification-mail.md(2 hunks)docs/en/components/notification.md(3 hunks)docs/en/components/openai-client.md(5 hunks)docs/en/components/pest-plugin-hyperf.md(1 hunks)docs/en/components/pretty-console.md(2 hunks)docs/en/components/purifier.md(5 hunks)docs/en/components/recaptcha.md(3 hunks)docs/en/components/redis-subscriber.md(3 hunks)docs/en/components/sentry.md(5 hunks)docs/en/components/tcp-sender.md(7 hunks)docs/en/components/telescope-elasticsearch.md(1 hunks)docs/en/components/telescope.md(7 hunks)docs/en/components/tinker.md(6 hunks)docs/en/components/trigger.md(3 hunks)docs/en/components/validated-dto.md(15 hunks)docs/en/components/web-tinker.md(1 hunks)docs/en/faq/index.md(1 hunks)docs/en/guide/index.md(1 hunks)docs/en/guide/introduce/about.md(1 hunks)docs/en/guide/start/components.md(1 hunks)docs/en/index.md(4 hunks)docs/zh-cn/components/cache.md(3 hunks)docs/zh-hk/components/cache.md(3 hunks)docs/zh-tw/components/cache.md(3 hunks)
✅ Files skipped from review due to trivial changes (27)
- docs/en/faq/index.md
- docs/en/guide/introduce/about.md
- docs/en/components/grpc-validation.md
- docs/en/components/config-consul.md
- docs/en/components/ipc-broadcaster.md
- docs/en/guide/index.md
- docs/en/components/elasticsearch.md
- docs/en/components/index.md
- docs/en/components/web-tinker.md
- docs/en/components/http-client.md
- docs/en/components/notification-mail.md
- docs/en/components/http-logger.md
- docs/en/components/amqp-job.md
- docs/en/components/pest-plugin-hyperf.md
- docs/en/components/telescope-elasticsearch.md
- docs/en/components/command-signals.md
- docs/en/components/console-spinner.md
- docs/en/components/ide-helper.md
- docs/en/components/model-observer.md
- docs/en/components/mail.md
- docs/en/components/trigger.md
- docs/en/components/cache.md
- docs/en/components/di-plus.md
- docs/en/components/model-scope.md
- docs/en/components/notification-easysms.md
- docs/en/components/openai-client.md
- docs/en/components/recaptcha.md
🚧 Files skipped from review as they are similar to previous changes (3)
- docs/zh-tw/components/cache.md
- docs/zh-hk/components/cache.md
- docs/zh-cn/components/cache.md
🧰 Additional context used
🪛 LanguageTool
docs/en/components/validated-dto.md
[style] ~460-~460: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ollectionCastconstructor. Suppose you want to cast all items in theCollection` to i...
(REP_WANT_TO_VB)
[style] ~480-~480: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ValidatedDTO\Exception\CastException. If the class passed to the DTOCast` const...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
docs/en/components/fast-paginate.md
[style] ~42-~42: Using many exclamation marks might seem excessive (in this case: 5 exclamation marks for a text that’s 1861 characters long)
Context: ...ery()->fastPaginate()`! It's that simple! The method signature is the same. Rela...
(EN_EXCESSIVE_EXCLAMATION)
docs/en/components/telescope.md
[style] ~95-~95: Consider a more expressive alternative.
Context: ...ach your own custom tags to entries. To do this, you may use the **`Telescope::tag...
(DO_ACHIEVE)
[style] ~99-~99: Consider a more expressive alternative.
Context: ...ly under certain special conditions. To do this, you may use the **`Telescope::fil...
(DO_ACHIEVE)
docs/en/components/compoships.md
[typographical] ~40-~40: Consider wrapping this idiom with two commas if you want to put a strong emphasize on it.
Context: ...fHyperf\Compoships\ComposhipsTrait If for some reason you cannot extend your model fromFrie...
(FOR_WHATEVER_REASON_COMMA)
[grammar] ~87-~87: This phrase is duplicated. You should probably use “a team” only once.
Context: ...s to a category - A task is assigned to a team - A team has many users - A user belongs to a te...
(PHRASE_REPETITION)
docs/en/guide/start/components.md
[style] ~7-~7: Using many exclamation marks might seem excessive (in this case: 84 exclamation marks for a text that’s 14062 characters long)
Context: .../github.com/friendsofhyperf/amqp-job) | |
|
| | cache |
|
|
| | command-signals |
|
|
| | command-validation |
|
|
| | compoships |
|
|
| | confd |
|
|
| | config-consul |
|
|
| | console-spinner |
|
|
| | di-plus |
|
|
| | elasticsearch |
|
|
| | encryption |
|
|
| | exception-event |
|
|
| | facade |
|
|
| | fast-paginate |
|
|
| | grpc-validation |
|
|
| | helpers |
|
|
| | http-client |
|
|
| | http-logger |
|
|
| | ide-helper |
|
|
| | ipc-broadcaster |
|
|
| | lock |
|
|
| | macros |
|
|
| | mail |
|
|
| | middleware-plus |
|
|
| | model-factory |
|
|
| | model-hashids |
|
|
| | model-morph-addon |
|
|
| | model-observer |
|
| [
🪛 Markdownlint (0.37.0)
docs/en/guide/start/components.md
34-34: Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
Table pipe style
(MD055, table-pipe-style)
🔇 Additional comments (13)
docs/en/components/pretty-console.md (1)
3-3: 标题描述修改恰当！
新的描述更加准确地表达了组件的特性。
docs/en/components/model-factory.md (1)
9-9: 文档措辞更准确！
将"configuration files"改为单数形式更准确，因为通常只需要发布一个配置文件。
docs/en/components/fast-paginate.md (2)
7-11: 文档介绍部分清晰准确！
技术概念解释准确，实现原理描述清晰。
26-28: 性能说明部分平衡得当！
既说明了性能优势，也提醒用户在实际数据上进行测试，很好地平衡了文档的客观性。
docs/en/components/command-validation.md (1)
3-3: 文档更新清晰且准确！
文档的措辞修改提高了可读性，同时保持了技术内容的准确性。修改包括：
- 更准确地描述了组件的用途
- 改进了命令行属性的描述
Also applies to: 30-30
docs/en/components/middleware-plus.md (1)
Line range hint 55-65: 文档更新清晰且准确！
中间件别名的文档说明和示例代码都很清晰，能够帮助用户正确理解和使用该功能。
docs/en/components/model-morph-addon.md (1)
3-3: 文档描述更加清晰简洁！
组件描述更改为直接说明其支持多态关系的功能，这样的表述更加准确和易于理解。
docs/en/index.md (2)
7-9: 品牌标识更新恰当！
"Hyperf Fans" 的命名更能体现社区特性，标语传达了正确的项目愿景。
Line range hint 20-47: 特性描述更新准确且统一！
- Sentry SDK 描述更正确
- 功能描述更加统一和专业
- 措辞更加简洁明了
.github/workflows/docs-translate.yaml (2)
17-28: Node.js 环境配置看起来不错！
pnpm 和 Node.js 的设置步骤配置合理，版本选择适当。
10-11: 建议增加 API 密钥验证
在使用 DEEPSEEK_API_KEY 之前，建议添加验证步骤以确保密钥存在且有效。
docs/en/components/lock.md (1)
27-27: 代码注释翻译准确性良好
代码示例中的注释翻译准确，清晰地表达了功能含义。
Also applies to: 37-37, 51-51, 53-53, 59-59, 77-77
docs/en/components/redis-subscriber.md (1)
3-9: 文档改进清晰且准确！
文档的修改提高了可读性，并且更准确地描述了组件的功能和优势。特别是：
- 明确说明了基于 Swoole 协程的实现
- 清楚地解释了不依赖 phpredis 扩展的优势
- 准确描述了主要特性
| @@ -23,14 +23,14 @@ class FooCommand extends HyperfCommand | |||
| { | |||
| use Prettyable; | |||
|
|
|||
| public function handle() | |||
| public function function handle() | |||
There was a problem hiding this comment.
修复方法声明中的语法错误
方法声明中出现了重复的 function 关键字，这会导致 PHP 语法错误。
请应用以下修复：
- public function function handle()
+ public function handle()📝 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.
| public function function handle() | |
| public function handle() |
| - name: Start Translate ZH | ||
| run: | | ||
| cp docs/index.md docs/zh-cn/index.md | ||
| php bin/doc-translate | ||
|
|
||
| - name: Start Translate EN | ||
| run: | | ||
| pnpm run docs:translate | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
建议增加翻译步骤的错误处理
翻译步骤需要增加错误处理机制，确保翻译失败时能够及时发现并处理。
建议修改如下：
- name: Start Translate ZH
run: |
+ set -e
cp docs/index.md docs/zh-cn/index.md
+ if ! php bin/doc-translate; then
+ echo "中文文档翻译失败"
+ exit 1
+ fi
- name: Start Translate EN
run: |
+ set -e
+ if ! pnpm run docs:translate; then
+ echo "英文文档翻译失败"
+ exit 1
+ fi📝 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.
| - name: Start Translate ZH | |
| run: | | |
| cp docs/index.md docs/zh-cn/index.md | |
| php bin/doc-translate | |
| - name: Start Translate EN | |
| run: | | |
| pnpm run docs:translate | |
| - name: Start Translate ZH | |
| run: | | |
| set -e | |
| cp docs/index.md docs/zh-cn/index.md | |
| if ! php bin/doc-translate; then | |
| echo "中文文档翻译失败" | |
| exit 1 | |
| fi | |
| - name: Start Translate EN | |
| run: | | |
| set -e | |
| if ! pnpm run docs:translate; then | |
| echo "英文文档翻译失败" | |
| exit 1 | |
| fi |
| use Hyperf\Database\Model\Model; | ||
| use FriendsOfHyperf\ModelHashids\Concerns\HasHashid; | ||
| use FriendsOfHyperf\ModelHashids\Concerns\HashidRouting; | ||
|
|
||
| class Item extends Model | ||
| Class Item extends Model |
There was a problem hiding this comment.
类声明关键字大小写问题
Class 关键字应该使用小写 class，这是 PHP 的标准编码规范。
-Class Item extends Model
+class Item extends Model📝 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.
| Class Item extends Model | |
| class Item extends Model |
Summary by CodeRabbit
新功能
文档
friendsofhyperf/cache组件文档中的引用语言，增强了清晰度fast-paginate组件文档中的错误消息格式工作流程
translate-zhtranslate-en