SP-397: include description in asset-registry list output#356
Open
Kastriot Salihu (ksalihu) wants to merge 1 commit into
Open
SP-397: include description in asset-registry list output#356Kastriot Salihu (ksalihu) wants to merge 1 commit into
Kastriot Salihu (ksalihu) wants to merge 1 commit into
Conversation
`asset-registry list` previously rendered each entry as `<assetType> - <displayName> [<group>]`, dropping the descriptor's `description` field. Append ` - <description>` when a description is present and leave the line unchanged for descriptors with `null` descriptions. Update the user-guide example output (also drops a stale `(basePath: ...)` suffix the docs claimed but the code never produced) and refresh the unit test to cover both the with-description and no-description branches. Includes-AI-Code: true Co-authored-by: Cursor <cursoragent@cursor.com>
| }; | ||
|
|
||
| it("Should list all asset types", async () => { | ||
| it("Should list all asset types with description when present", async () => { |
Contributor
There was a problem hiding this comment.
We should test cases when description is present and not present.
|
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.
asset-registry listpreviously rendered each entry as<assetType> - <displayName> [<group>], dropping the descriptor'sdescriptionfield. Append- <description>when a description is present and leave the line unchanged for descriptors withnulldescriptions. Update the user-guide example output (also drops a stale(basePath: ...)suffix the docs claimed but the code never produced) and refresh the unit test to cover both the with-description and no-description branches.Changed files:
src/commands/asset-registry/asset-registry.service.ts—logDescriptorSummarynow conditionally appends the description.tests/commands/asset-registry/asset-registry-list.spec.ts— covers both the with-description and no-description branches (asserts no trailing-and nonullliteral when the descriptor has no description).docs/user-guide/asset-registry-commands.md— example output refreshed and a one-liner added explaining the format. Also drops a stale(basePath: ...)suffix the docs claimed but the code never produced.Testing
npx jest --testPathPattern="asset-registry/asset-registry-list"— 3/3 passingasset-registrysuite — 36/36 passingasset-registry listagainst develop; all 8 registered asset types now show their description after the group.Relevant links
Checklist
Includes-AI-Code: true