feat(cli): expose description property in Check construct API#1272
Merged
feat(cli): expose description property in Check construct API#1272
Conversation
pmallol
force-pushed
the
paula/add-check-description-prop
branch
from
8b1a0c3 to
b687acc
Compare
1 task
Pad continuation lines in renderDetailFields so multi-line values align with the first line. Only include description in synthesize payload when explicitly set, preventing API rejection.
thebiglabasky
previously approved these changes
Apr 3, 2026
Contributor
thebiglabasky
left a comment
thebiglabasky
left a comment
There was a problem hiding this comment.
Looks good though couldn't test since on the go, but that looks harmless 👍
Escape pipe characters and newlines in markdown table cells to prevent broken output. Use nullish checks instead of falsy checks so empty-string descriptions are preserved rather than collapsed to hidden/dash.
thebiglabasky
approved these changes
Apr 3, 2026
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
2 participants
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.
Affected Components
Notes for the Reviewer
Adds the
descriptionproperty to theCheckPropsinterface,Checkclass, andCheckResourcecodegen interface so users can set a check description via the Checkly CLI construct API. Also surfaces the description inchecks getandchecks listCLI output.Changes:
Construct API:
check.ts: Addeddescription?: string | nulltoCheckPropsinterface with JSDoc, class field, constructor assignment, andsynthesize()outputcheck-codegen.ts: AddeddescriptiontoCheckResourceinterface andbuildCheckPropscode generationCLI output:
rest/checks.ts: Addeddescriptionto theCheckinterfaceformatters/checks.ts: AddedDescriptionfield tochecks getdetail view (hidden when null in terminal, shows-in markdown). AddedDescriptioncolumn tochecks listmarkdown tableScreenshots
checks get [id]checks listchecks list --output md