feat: include rendered spec location in component list output#85
Merged
feat: include rendered spec location in component list output#85
Conversation
Copilot
AI
changed the title
[WIP] Add rendered spec location to component list output
feat: include rendered spec location in component list output
Apr 8, 2026
dmcilvaney
reviewed
Apr 8, 2026
Contributor
Author
|
Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details. Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
dmcilvaney
reviewed
Apr 8, 2026
dmcilvaney
approved these changes
Apr 9, 2026
Contributor
dmcilvaney
left a comment
dmcilvaney
left a comment
There was a problem hiding this comment.
Approve pending scenario test results
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a derived renderedSpecDir field to resolved component configs so azldev component list -O json can include each component’s rendered spec output directory (based on the project’s rendered-specs-dir setting).
Changes:
- Introduce
components.RenderedSpecDir(renderedSpecsDir, componentName)helper to compute{rendered-specs-dir}/{component-name}. - Add
RenderedSpecDirderived field toprojectconfig.ComponentConfigand populate it during component resolution. - Update
component listconfig extraction logic and extend tests for configured/unconfigured rendered-specs-dir behavior.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| internal/projectconfig/component.go | Adds RenderedSpecDir derived field and preserves it through WithAbsolutePaths cloning. |
| internal/app/azldev/core/components/resolver.go | Populates RenderedSpecDir at resolve time for all resolved components. |
| internal/app/azldev/core/components/renderedspecdir.go | New helper that computes the per-component rendered spec output directory. |
| internal/app/azldev/core/components/renderedspecdir_test.go | Unit tests for the helper behavior. |
| internal/app/azldev/cmds/component/list.go | Removes lo.Map usage and returns resolved component configs via a loop. |
| internal/app/azldev/cmds/component/list_test.go | Adds test coverage for rendered-specs-dir propagation into list output. |
dmcilvaney
requested changes
Apr 9, 2026
Add RenderedSpecDir field to component list results, computed from the project's rendered-specs-dir config and component name. The path calculation is extracted into a reusable RenderedSpecDir helper function in the components package for use by future commands (e.g. component render). Agent-Logs-Url: https://github.com/microsoft/azure-linux-dev-tools/sessions/10d51939-dcb0-47d4-bbb0-1ebe7341e052 Co-authored-by: dmcilvaney <23200982+dmcilvaney@users.noreply.github.com>
Agent-Logs-Url: https://github.com/microsoft/azure-linux-dev-tools/sessions/10d51939-dcb0-47d4-bbb0-1ebe7341e052 Co-authored-by: dmcilvaney <23200982+dmcilvaney@users.noreply.github.com>
Move RenderedSpecDir from the ComponentListEntry wrapper into ComponentConfig directly (with toml:"-" to exclude from serialization). The field is now populated by the resolver's createComponentFromConfig, making it available to all consumers of resolved components. Agent-Logs-Url: https://github.com/microsoft/azure-linux-dev-tools/sessions/e7cc285b-04b7-4227-94f2-79231f4455b0 Co-authored-by: dmcilvaney <23200982+dmcilvaney@users.noreply.github.com>
Agent-Logs-Url: https://github.com/microsoft/azure-linux-dev-tools/sessions/7f9228f1-708c-4dd3-92dc-01d73387ae97 Co-authored-by: dmcilvaney <23200982+dmcilvaney@users.noreply.github.com>
dmcilvaney
force-pushed
the
copilot/add-spec-location-to-component-list
branch
from
29edcf5 to
3bd1ac1
Compare
reubeno
reviewed
Apr 9, 2026
Comment on lines
+16
to
+22
| // Returns an error if componentName is unsafe (absolute, contains path separators | ||
| // or traversal sequences). | ||
| func RenderedSpecDir(renderedSpecsDir, componentName string) (string, error) { | ||
| if err := fileutils.ValidateFilename(componentName); err != nil { | ||
| return "", fmt.Errorf("invalid component name for rendered spec dir:\n%w", err) | ||
| } | ||
|
|
There was a problem hiding this comment.
RenderedSpecDir relies on fileutils.ValidateFilename(componentName), but ValidateFilename does not reject Windows volume-qualified names (e.g. "C:tmp"). On Windows, filepath.Join(renderedSpecsDir, "C:tmp") can discard the base directory and produce a path on another volume, undermining the safety guarantee this helper is meant to provide. Consider rejecting componentName values where filepath.VolumeName(componentName) != "" (ideally inside ValidateFilename so all callers benefit).
Suggested change
| // Returns an error if componentName is unsafe (absolute, contains path separators | |
| // or traversal sequences). | |
| func RenderedSpecDir(renderedSpecsDir, componentName string) (string, error) { | |
| if err := fileutils.ValidateFilename(componentName); err != nil { | |
| return "", fmt.Errorf("invalid component name for rendered spec dir:\n%w", err) | |
| } | |
| // Returns an error if componentName is unsafe (absolute, contains path separators, | |
| // traversal sequences, or a platform-specific volume name). | |
| func RenderedSpecDir(renderedSpecsDir, componentName string) (string, error) { | |
| if err := fileutils.ValidateFilename(componentName); err != nil { | |
| return "", fmt.Errorf("invalid component name for rendered spec dir:\n%w", err) | |
| } | |
| if filepath.VolumeName(componentName) != "" { | |
| return "", fmt.Errorf("invalid component name for rendered spec dir:\ncomponent name %#q must not include a volume name", componentName) | |
| } |
reubeno
approved these changes
Apr 9, 2026
dmcilvaney
approved these changes
Apr 9, 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
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.
azldev component listnow includes each component's rendered spec output directory (derived fromrendered-specs-dirconfig). Empty when not configured.internal/app/azldev/core/components/renderedspecdir.go— ReusableRenderedSpecDir(renderedSpecsDir, componentName)helper computing{rendered-specs-dir}/{component-name}. Futurecomponent render(PR feat(render): add azldev component render command #81) and subfolder-split work can use this single calculation point.internal/projectconfig/component.go— AddedRenderedSpecDiras a derived field onComponentConfig(toml:"-"excludes it from serialization;table:"-"hides it from human-readable table output; JSON tag exposes it for programmatic use). Follows the same pattern as other derived fields likeNameandSourceConfigFile.internal/app/azldev/core/components/resolver.go— The resolver'screateComponentFromConfigpopulatesRenderedSpecDirat resolve time, making it available to all consumers of resolved components (not just the list command).Example JSON output when
rendered-specs-dir = "SPECS"is configured:[{"name": "vim", "renderedSpecDir": "/project/SPECS/vim", ...}]When
rendered-specs-diris not set,renderedSpecDiris omitted. The field is only included in JSON output (-O json), not in the default table view.