Repository navigation
docs(error-reference): name each CLI command with its group - #30527
Conversation
The error reference named several commands without their group, so a reader who typed them got the top-level help or a different command: `ref set`, `ref list`, and `ref` (now `migration ref ...`), `migrate` (now `db migrate`), `format` (now `contract format`), and bare `init` where the entry means `orm init`. Two entries named internal operations as if they were commands: `inspect-live-schema` is now `db schema`, and `db run` is now `db init`, `db update`, the two commands it backs. Signed-off-by: willbot <w.a.madden+machine@gmail.com> Signed-off-by: Will Madden <madden@prisma.io> Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
Navigate logical layers of code changes, visualize relationships, and explore their blast radius. No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository: prisma/orm/.coderabbit.yml Review profile: CHILL Plan: Advanced Run ID: 📒 Files selected for processing (1)
Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 8 remain after this review. 📝 WalkthroughWalkthroughThe error reference updates command names for CLI, contract, and migration errors. It also clarifies documented init error codes and exit codes. Existing error handling descriptions remain unchanged. ChangesError reference updates
Priority: ⬇️ Low Estimated code review effort: 2 (Simple) | ~8 minutes Change: Other Suggested reviewers: Merge Risk: ⚪ Minimal · up to This documentation-only change uses current CLI names and supported init outcomes, with no actionable user-facing or operational regression identified. It is ready to merge after normal checks. Architecture SummaryArchitecture risk: 🔵 Low · up to The change affects 1 system. Changed systems: Architecture concerns Review detailsSystems and components
Before / after behavior
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Section E is in review as #8348, the error reference command names as prisma/orm#30527, and the docs change prisma/orm#30475 needs as draft #8349. The slice's plan, the facts run on rc.19, and the four reviews are kept beside its spec. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Signed-off-by: willbot <w.a.madden+machine@gmail.com> Signed-off-by: Will Madden <madden@prisma.io>
At a glance
MIGRATION.UNKNOWN_REFindocs/reference/error-reference.md, before:After:
prisma ref setdoes not exist: in8.0.0-rc.19it prints the top-level help. The command isprisma migration ref set.Linked issue
n/a — small docs change.
Summary
The error reference named some CLI commands without their group, or by the name of an internal operation. A reader who types one of these names gets the top-level help or a different command. The prisma.io docs site renders its ORM error reference page from this file, so the wrong names show there too.
This PR changes only the command names. The rest of each entry is unchanged.
ref set,ref list,refmigration ref set,migration ref list,migration refCLI.FILE_NOT_FOUND,MIGRATION.CHECK_DANGLING_REF,MIGRATION.CONTRACT_SNAPSHOT_CONTENT_MISMATCH,MIGRATION.HASH_NOT_IN_GRAPH,MIGRATION.INVALID_REF_NAME,MIGRATION.INVALID_REF_VALUE,MIGRATION.MARKER_MISMATCH,MIGRATION.REF_NOT_RESOLVABLE,MIGRATION.REF_SET_BUNDLE_NOT_FOUND,MIGRATION.REF_SET_EMPTY_SENTINEL,MIGRATION.UNKNOWN_REFmigratedb migrateCONFIG.DB_CONNECTION_REQUIRED,CONFIG.DRIVER_REQUIRED,CLI.FILE_NOT_FOUND,CONTRACT.TYPES_RENDER_FAILED,MIGRATION.DESTINATION_CONTRACT_MISMATCH,MIGRATION.EXECUTION_FAILED,MIGRATION.NO_INVARIANT_PATH,MIGRATION.PATH_UNREACHABLE,MIGRATION.RUNNER_FAILED,MIGRATION.SCHEMA_VERIFY_FAILEDformatcontract formatCLI.FILE_WRITE_FAILED,CONTRACT.SOURCE_LOAD_FAILED,PSL.PARSE_FAILEDinit, where the entry meansprisma orm initorm initCLI.INIT_EMIT_FAILED,CLI.INIT_INSTALL_FAILED,CLI.INIT_INVALID_OUTPUT_DOCUMENT,CLI.INIT_REINIT_NEEDS_FORCE,CLI.INIT_USER_ABORTEDinspect-live-schemadb schemaCONFIG.DB_CONNECTION_REQUIRED,CONFIG.DRIVER_REQUIREDdb rundb init,db updateMIGRATION.CONTRACT_SPACE_VIOLATIONinspect-live-schemais not a command and does not appear anywhere in the source;db schemaraises both codes.db runis the internal operation incontrol-api/operations/db-run.tsthat backsdb initanddb update.Testing performed
check:error-reference(node scripts/list-error-codes.mjs --verify docs/reference/error-reference.md): passed, "Error-reference lists all 360 known codes."lint:docs,lint:legacy-name, andcheck:release-notes --mode pr --prev origin/main, run the same way withnode scripts/…: passed.8.0.0-rc.19CLI help:prisma --help,prisma db --help,prisma contract --help,prisma migration --help,prisma migration ref --help, andprisma migration ref set --help.packages/for messages that name a bareref set,ref list, orref deletecommand. There are none, so no source change is needed.git merge-treeagainst Contract references list only the forms each command accepts; migration status and db migrate resolve @contract and @db #30475, which also edits this file (MIGRATION.REF_WRONG_GRAMMAR): merges without conflict.Skill update
n/a: docs only. The CLI surface does not change.
Checklist
git commit -s) per the DCO.TML-NNNN: <sentence-case title>form: no Linear ticket exists for this work.Notes for the reviewer
Left unchanged on purpose:
refandformatwhere they are payload field names (MIGRATION.AMBIGUOUS_MIGRATION_REF,MIGRATION.MISSING_INVARIANTS,CLI.JSON_FORMAT_UNSUPPORTED).ref-based resolution" inMIGRATION.CONTRACT_SNAPSHOT_MISSING, which names a kind of resolution, not a command.prisma initinCLI.INIT_SKILL_INSTALL_FAILED, which is the real top-level command and is named there to contrast it withorm init.<hash>,<valid-hash>,<markerHash>):migration ref setaccepts a hash as its contract argument.Agent: columbo-92
🤖 Generated with Claude Code
Summary by CodeRabbit