Repository navigation
refactor(cli): Centralize target syntax and lint free-text help examples - #1652
Merged
Merged
Conversation
Command fullDescription strings carried hand-aligned 'Target patterns:', 'Usage:', 'Pagination:' and similar blocks of indented sentry lines. They restated target syntax per command and duplicated docs.examples in --help. Remove those blocks and move any example they had that docs.examples lacked into docs.examples. Describe [<org>/][<project>] target forms once, in ORG_ALL_TARGET_BRIEF and PROJECT_TARGET_BRIEF, and use them for the list positionals that had drifted. Render positional arguments in the skill references so the target syntax appears in --help, the docs and the skills. Extend no-examples-in-full-description to flag indented sentry lines under any label. Fixes #1649 Co-Authored-By: BYK <burak.kaya@sentry.io>
|
The latest updates on your projects. Learn more about Vercel for GitHub. 1 Skipped Deployment
|
![sentry-warden[bot]](https://avatars.githubusercontent.com/in/2755838?s=60&v=4){kind=small}
The propose-version footer goes to stdout, so an unquoted command substitution passed it to release create as extra arguments. Read the version from --json instead. Update the log list e2e help assertion for the reworded trace-filter text.
…pecs # Conflicts: # packages/cli/src/commands/explore.ts Co-Authored-By: BYK <burak.kaya@sentry.io>
BYK
approved these changes
Oct 24, 2026
This branch was previously deployed
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.
Fixes #1649.
Many command
fullDescriptionstrings still had hand-aligned blocks of indentedsentry …lines (Target patterns:,Target specification:,Usage:,Pagination:,Filtering and output:and others). They restated the target syntax for each command, and they showed up in--helpnext to theExamples:section thatdocs.examplesalready renders.fullDescriptions. If a block had an example thatdocs.examplesdidn't, I moved it intodocs.examples(auto-detect, project search, explicit org/trace, pagination, and a few missing flags). A few one-line hints are now inline prose instead.ORG_ALL_TARGET_BRIEFandPROJECT_TARGET_BRIEFtolist-command.ts. They now describe the target forms for the list positionals, plus the feedback, replay, explore, trace list and project view positionals, whose wording had drifted. The explanation of how the trailing slash works still comes fromtargetPatternExplanation()/TARGET_PATTERN_NOTE.--help, the docs and the skills from that one positional brief.no-examples-in-full-descriptionnow also flags indented lines that start withsentry, whatever label sits above them. The rule tests cover aTarget patterns:block and a template-literal case. Both fail against the old rule.packages/cli/AGENTS.mdto match.via BYK.
--
View Junior Session in Sentry