fix(cli): correct three descriptions the CLI publishes, and restore --no-recursive - #7093
Merged
Conversation
…-no-recursive Follow-ups from review of the v0.8.12 release PR, all on surfaces the CLI audit touched. - `credentialId` was one shared schema across PATCH and DELETE, so the disconnect reference offered "update or disconnect" for an operation that cannot update. Split into two, matching the two components OpenAPI already publishes for them. - A boolean query param documents the spellings an HTTP caller may send and closes by calling them the whole accepted set. The CLI renders those fields as bare flags that take no value, leaving the sentence pointing at a list neither `--help` nor the reference ever prints. Stripped for bare flags only; the REST prose and OpenAPI specs are unchanged. - `files list --recursive` became a bare switch in the audit, which removed the only way to send false. The API turns it on by itself as soon as `--search` is set, so a folder search always descended. The twin is back, declared per flag so the one-way toggles do not grow a meaningless negation.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
Greptile SummaryThe PR corrects operation-specific credential descriptions and restores explicit recursive control for folder searches.
Confidence Score: 5/5The PR appears safe to merge, with the restored negated flag, request serialization, generated interfaces, and documentation remaining aligned. The positive and negative recursive flags resolve to the intended booleans, omission preserves the API’s conditional default, and the credential schema split changes only operation-specific descriptions.
|
| Filename | Overview |
|---|---|
| packages/sim-cli/src/runtime/options.ts | Adds targeted boolean-help normalization and opt-in negated options while preserving required-valued boolean handling. |
| packages/sim-cli/src/contract/commands.ts | Marks only the files-list recursive flag as negatable, restoring explicit false behavior without affecting one-way toggles. |
| packages/sim-cli/src/contract/types.ts | Extends flag metadata with an optional negatable marker and documents its intended narrow use. |
| apps/sim/lib/api/contracts/v2/credentials.ts | Separates update and delete path schemas so operation-specific descriptions propagate correctly. |
| packages/sim-cli/src/runtime/options.test.ts | Covers help-text cleanup, both recursive flag spellings, and omission when neither flag is present. |
| packages/sim-cli/src/runtime/request.test.ts | Verifies explicit true and false recursive values survive request construction. |
| packages/sim-cli/src/generated/v2-api.ts | Regenerated projection remains aligned with the updated credential contracts. |
| apps/docs/content/docs/en/cli/reference.mdx | Regenerated reference accurately publishes credential argument descriptions and both recursive flag spellings. |
Reviews (1): Last reviewed commit: "fix(cli): correct three descriptions the..." | Re-trigger Greptile
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Follow-ups from reviewing the v0.8.12 release PR (#7090). Three of its comments land on files the CLI audit (#7083) touched; these are the two that were real, plus a regression that audit introduced on the same flag.
credentialIddescribed an operation it cannot perform.PATCHandDELETEshared one params schema, so the disconnect reference read "Credential to update or disconnect." Split into two schemas — the OpenAPI document already publishes them as two components (UpdateCredentialParams,DeleteCredentialParams), so this only makes the prose match what the spec already claims.--helpand the generated reference. Stripped at the CLI layer only — the contract prose and the OpenAPI specs still document the spellings, which REST callers can act on.files list --recursivelost its false spelling. The audit made it a bare switch, which dropped--recursive false. The API turnsrecursiveon by itself as soon as--searchis set, so a folder search always descended into subfolders with no way to stop it. The--no-recursivetwin is back, declared per flag so one-way toggles (--async,--select-all, the folder deletes) don't grow a negation that only restates their default.The third review comment — that dropping
organizationIdfrom the audit-log cursor scope lets an org-A cursor be replayed against org B — does not apply; reasoning posted on the thread.membercarriesuniqueIndex('member_user_id_unique'), andresolveEnterpriseAuditAccessrefuses any organization the caller is not a member of, so one caller can never authorize two organizations.Type of Change
Testing
--no-recursivean implicittruedefault, which would otherwise have made every unqualifiedfiles listoverride the API's own conditional default.apps/sim33,272 tests,sim-cli607 tests.bun run lint, all 33 audits (check:audits), andtype-checkin both workspaces pass. All generated artifacts regenerated canonically (generate:cli-api,generate:cli-docs,generate:openapi).Checklist