fix: 知识库术语统一为 book(repo → book,v1.1.0) - #1
Conversation
Aligns the CLI surface with Yuque terminology (知识库 = book, matching the API's V2Book/book_id and yuque-mcp-server's yuque_*_book tools): - repo list/get/create/update/delete -> book ...; <repo> args -> <book> - search --type takes doc|book (repo kept as a compatibility alias; wire value unchanged) - HTTP paths (/repos/...), YUQUE_E2E_REPO env vars, and the vendored spec stay as-is — they are wire/config contracts, not surface terminology - version 2.0.0 (breaking command rename) Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: b9ad5be659
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| create | ||
| .description('Create a doc in a repo') | ||
| .argument('<repo>', REPO_ARG_HELP) | ||
| .argument('<book>', BOOK_ARG_HELP) |
There was a problem hiding this comment.
Replace stale repo terminology in document help
Changing this argument to <book> leaves the same command described as “Create a doc in a repo,” while doc get --help and its validation errors still instruct users to pass <repo> <doc>. Consequently, the 2.0 CLI help contradicts the renamed command surface and the updated READMEs; update the remaining user-facing strings in this command module to use book consistently.
Useful? React with 👍 / 👎.
…nd comments Addresses the Codex review note on PR #1: doc get/create help and usage errors, search --scope help, internal params/labels — all now say book. The wire enum comment in search.ts is intentional and stays. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
变更
知识库在 CLI 面上统一称
book,与语雀官方术语(知识库 = Book)、OpenAPI 的V2Book/book_id以及 yuque-mcp-server 的yuque_*_book工具命名对齐:repo list/get/create/update/delete→book list/get/create/update/delete;各命令的<repo>位置参数改为<book>search --type取值改为doc|book(repo保留为兼容别名,线上请求值不变仍为repo)/repos/...(线上契约)、YUQUE_E2E_REPO等环境变量(配置契约)、vendored spec1.1.0(与 1.0.0 同日发布的命名修复,遵从语义化版本不滥用 major)验证
本地
npm run check全绿(170 单测 + 31 mock e2e + dist 冒烟)。本 PR 同时用于演练 CI 的真实 API e2e 流程——Node 22 腿将以专用测试账号真实调用语雀 API 验证改名后的读路径。🤖 Generated with Claude Code