当设计或修改 REST API 响应结构、处理 API 返回值时触发。防止 API 设计缺陷导致的字段错位、类型歧义等问题。
한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.
当用户执行 /ruanzhu 命令或请求生成软著源代码文档时触发。提供软著源代码 DOCX 生成规范。覆盖项目信息检测、语言扫描规则、页数控制、DOCX 格式规范等。
한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.
설치하기 전에 에이전트에게 전달되는 지시 내용을 확인할 수 있습니다.
必须执行以下命令,禁止任何其他操作:
cp ~/.cursor/templates/ruanzhu/generate_docx.py ./generate_docx.py && python3 generate_docx.py $ARGUMENTS && rm generate_docx.py
.py 文件执行上面的 bash 命令(一条命令,用 && 连接)
docs/ruanzhu/{软件名称}{版本}-源代码.docx--different 时,生成 {软件名称}{版本}-源代码-2.docx(编号递增)./generate_docx.py 已被删除以下内容已由 generate_docx.py 脚本实现,不需要手动处理:
按优先级读取项目名称和版本:
name + versionartifactId + version| 检测文件 | 语言 |
|---|---|
pom.xml 或 build.gradle | Java |
package.json | JavaScript/TypeScript |
Cargo.toml | Rust |
Gemfile | Ruby |
go.mod | Go |
*.cpp 或 CMakeLists.txt | C++ |
requirements.txt 或 pyproject.toml | Python |
Java: src/main/java/**/controller/、service/、entity/ 等,排除 *Test.java
TypeScript/Vue/React: src/api/、src/stores/、src/pages/ 等,排除 *.spec.ts、node_modules/
Go: cmd/、internal/、pkg/,排除 *_test.go、vendor/
Python: src/、app/、lib/,排除 test_*.py、__pycache__/
C++: src/、include/,排除 *_test.cpp、build/
Ruby: app/controllers/、app/models/,排除 *_spec.rb
Rust: src/,排除 tests/、target/
页面 A4,边距上下2.5cm、左3.0cm、右2.5cm,字体宋体+Courier New 10pt,单倍行距。
| 错误 | 处理 |
|---|---|
| 无法检测项目信息 | 提示用户输入 |
| 未检测到源代码 | 报错并列出支持的语言 |
| python-docx 未安装 | 自动 pip install 安装 |
| 代码量不足 | 警告并输出全部 |
아직 리뷰가 없습니다. 사용해 본 소감을 남겨 주세요.
로그인 없이 쓸 수 있습니다. 사용 후기, 질문, 작동하지 않은 환경 등을 편하게 남겨 주세요.
아직 댓글이 없습니다. 첫 댓글을 남겨 보세요.
当设计或修改 REST API 响应结构、处理 API 返回值时触发。防止 API 设计缺陷导致的字段错位、类型歧义等问题。
한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.
当设计或修改 REST API 响应结构、处理 API 返回值,或生成 Excel/CSV/PDF/对账文件等下游产物时触发。防止 API 设计缺陷导致的字段错位、类型歧义,以及生成产物时关键字段缺失但静默成功的问题。
한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.
网关/代理/WAF/CDN 中间件的安全关键词匹配实现规范,防止纯子串匹配误判正常响应内容中的技术术语(如 Cloudflare、502、error)
한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.
当 API/任务可能执行超过 10 秒(批量数据处理、远程 API 批量调用、全表扫描、跨租户聚合)时触发。防止同步接口被网关 30s 超时切断、用户重复点击触发并发、状态缓存内存泄漏等问题。提供异步任务状态机标准模板。
한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.
Bash 脚本与系统命令规范。禁止行尾注释,强制使用 tee/heredoc 写入,提升命令执行的可维护性。
한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.
当用户操作 .sh、Dockerfile、Makefile、.yml、.yaml 文件,或在 Markdown 中编写 bash 代码块时触发。提供 Bash 编写规范。
한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.