feat(cli): select the spec editor

docs/user/reference/config/overlays.md

@@ -10,7 +10,13 @@ Overlays are defined within a component's configuration in your TOML config file
 
 ### Spec Overlays
 
-These overlays modify `.spec` files using the structured spec parser, allowing precise targeting of tags and sections.
+These overlays modify `.spec` files using the component command's `--spec-editor` option. The default `legacy` editor is line-oriented; `--spec-editor experimental` selects the structural editor, which preserves conditional and section structure.
+
+#### Known Limitations
+
+With the structural editor, content after a conditional wrapper's `%endif` cannot always be statically attributed to a section declared inside that wrapper. A scoped overlay may therefore not reach that content; use a narrowly anchored whole-spec `spec-search-replace` overlay instead.
+
+Sections generated by macros are unavailable to both editors because azldev does not evaluate RPM macros while editing specs.
 
 | Type | Description | Required Fields |
 |------|-------------|-----------------|

internal/app/azldev/cmds/component/build.go

@@ -25,6 +25,7 @@ import (
 )
 
 type ComponentBuildOptions struct {
+	componentCommandOptions
 	ComponentFilter components.ComponentFilter
 
 	ContinueOnError   bool
@@ -88,7 +89,9 @@ func NewBuildCmd() *cobra.Command {
 		BuildEnvPolicy: BuildEnvPreserveOnFailure,
 	}
 
-	cmd := &cobra.Command{
+	var cmd *cobra.Command
+
+	cmd = &cobra.Command{
 		Use:   "build",
 		Short: "Build packages for components",
 		Long: `Build RPM packages for one or more components using mock.
@@ -121,6 +124,7 @@ builds can consume.`,
   azldev component build --local-repo-with-publish ./base/out -p liba -p libb`,
 		RunE: azldev.RunFuncWithExtraArgs(func(env *azldev.Env, args []string) (interface{}, error) {
 			options.ComponentFilter.ComponentNamePatterns = append(options.ComponentFilter.ComponentNamePatterns, args...)
+			options.SpecEditor = specEditorFromCommand(cmd)
 
 			return SelectAndBuildComponents(env, options)
 		}),
@@ -280,7 +284,10 @@ func buildComponent(
 
 	preparerOpts = append(preparerOpts, sources.WithMockProcessor(mockProcessor))
 
-	sourcePreparer, err := sources.NewPreparer(sourceManager, env.FS(), env, env, preparerOpts...)
+	sourcePreparer, err := newSourcePreparer(sourceManager, env.FS(), env, env, append(
+		preparerOpts,
+		sources.WithSpecEditor(options.specEditorMode()),
+	)...)
 	if err != nil {
 		return ComponentBuildResults{},
 			fmt.Errorf("failed to create source preparer for component %q:\n%w", component.GetName(), err)

internal/app/azldev/cmds/component/component.go

@@ -10,6 +10,10 @@ import (
 
 // Called once when the app is initialized; registers any commands or callbacks with the app.
 func OnAppInit(app *azldev.App) {
+	app.AddTopLevelCommand(newComponentCmd(app))
+}
+
+func newComponentCmd(app *azldev.App) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:     "component",
 		Aliases: []string{"comp"},
@@ -22,7 +26,7 @@ Use subcommands to add, list, query, build, and prepare sources for
 components defined in the project configuration.`,
 	}
 
-	app.AddTopLevelCommand(cmd)
+	addSpecEditorOption(cmd)
 	addOnAppInit(app, cmd)
 	buildOnAppInit(app, cmd)
 	changedOnAppInit(app, cmd)
@@ -34,4 +38,6 @@ components defined in the project configuration.`,
 	renderOnAppInit(app, cmd)
 	testOnAppInit(app, cmd)
 	updateOnAppInit(app, cmd)
+
+	return cmd
 }

internal/app/azldev/cmds/component/diffsources.go

@@ -23,6 +23,7 @@ import (
 
 // DiffSourcesOptions holds the options for the diff-sources command.
 type DiffSourcesOptions struct {
+	componentCommandOptions
 	ComponentFilter components.ComponentFilter
 
 	OutputFile string
@@ -36,14 +37,17 @@ func diffSourcesOnAppInit(_ *azldev.App, parentCmd *cobra.Command) {
 func NewDiffSourcesCmd() *cobra.Command {
 	var options DiffSourcesOptions
 
-	cmd := &cobra.Command{
+	var cmd *cobra.Command
+
+	cmd = &cobra.Command{
 		Use:   "diff-sources",
 		Short: "Show the diff that overlays apply to a component's sources",
 		Long: `Computes a unified diff showing the changes that overlays apply to a
 component's sources. Fetches the sources once, copies them, then applies
 overlays to the copy and displays the resulting diff between the two trees.`,
 		RunE: azldev.RunFuncWithExtraArgs(func(env *azldev.Env, args []string) (interface{}, error) {
 			options.ComponentFilter.ComponentNamePatterns = append(args, options.ComponentFilter.ComponentNamePatterns...)
+			options.SpecEditor = specEditorFromCommand(cmd)
 
 			return DiffComponentSources(env, &options)
 		}),
@@ -97,8 +101,9 @@ func DiffComponentSources(env *azldev.Env, options *DiffSourcesOptions) (interfa
 		return nil, fmt.Errorf("failed to create source manager:\n%w", err)
 	}
 
-	preparer, err := sources.NewPreparer(sourceManager, env.FS(), env, env,
-		sources.WithUpstreamProvenance(sources.FedoraDistTag(distro.Ref.Name, distro.Version.ReleaseVer)))
+	preparer, err := newSourcePreparer(sourceManager, env.FS(), env, env,
+		sources.WithUpstreamProvenance(sources.FedoraDistTag(distro.Ref.Name, distro.Version.ReleaseVer)),
+		sources.WithSpecEditor(options.specEditorMode()))
 	if err != nil {
 		return nil, fmt.Errorf("failed to create source preparer:\n%w", err)
 	}

internal/app/azldev/cmds/component/preparesources.go

@@ -17,6 +17,7 @@ import (
 )
 
 type PrepareSourcesOptions struct {
+	componentCommandOptions
 	ComponentFilter components.ComponentFilter
 
 	OutputDir      string
@@ -34,7 +35,9 @@ func prepareOnAppInit(_ *azldev.App, sourceCmd *cobra.Command) {
 func NewPrepareSourcesCmd() *cobra.Command {
 	var options PrepareSourcesOptions
 
-	cmd := &cobra.Command{
+	var cmd *cobra.Command
+
+	cmd = &cobra.Command{
 		Use:     "prepare-sources",
 		Aliases: []string{"prep-sources"},
 		Short:   "Prepare buildable sources for components",
@@ -53,6 +56,7 @@ Only one component may be selected at a time.`,
   azldev component prep-sources -p curl -o ./build/work/scratch/curl --skip-overlays --force`,
 		RunE: azldev.RunFuncWithExtraArgs(func(env *azldev.Env, args []string) (interface{}, error) {
 			options.ComponentFilter.ComponentNamePatterns = append(args, options.ComponentFilter.ComponentNamePatterns...)
+			options.SpecEditor = specEditorFromCommand(cmd)
 
 			return nil, PrepareComponentSources(env, &options)
 		}),
@@ -132,7 +136,10 @@ func PrepareComponentSources(env *azldev.Env, options *PrepareSourcesOptions) er
 
 	preparerOpts := buildPreparerOptions(env, distro, options)
 
-	preparer, err := sources.NewPreparer(sourceManager, env.FS(), env, env, preparerOpts...)
+	preparer, err := newSourcePreparer(sourceManager, env.FS(), env, env, append(
+		preparerOpts,
+		sources.WithSpecEditor(options.specEditorMode()),
+	)...)
 	if err != nil {
 		return fmt.Errorf("failed to create source preparer:\n%w", err)
 	}

internal/app/azldev/cmds/component/render.go

@@ -19,6 +19,7 @@ import (
 	"github.com/microsoft/azure-linux-dev-tools/internal/app/azldev/core/sources"
 	"github.com/microsoft/azure-linux-dev-tools/internal/global/opctx"
 	"github.com/microsoft/azure-linux-dev-tools/internal/providers/sourceproviders"
+	"github.com/microsoft/azure-linux-dev-tools/internal/rpm/spec"
 	"github.com/microsoft/azure-linux-dev-tools/internal/utils/dirdiff"
 	"github.com/microsoft/azure-linux-dev-tools/internal/utils/fileperms"
 	"github.com/microsoft/azure-linux-dev-tools/internal/utils/fileutils"
@@ -29,6 +30,7 @@ import (
 
 // RenderOptions holds the options for the render command.
 type RenderOptions struct {
+	componentCommandOptions
 	ComponentFilter   components.ComponentFilter
 	OutputDir         string
 	OutputDirExplicit bool // True when --output-dir was explicitly passed on the CLI.
@@ -88,6 +90,7 @@ valid with -a.`,
 		RunE: azldev.RunFuncWithExtraArgs(func(env *azldev.Env, args []string) (interface{}, error) {
 			options.ComponentFilter.ComponentNamePatterns = append(args, options.ComponentFilter.ComponentNamePatterns...)
 			options.OutputDirExplicit = cmd.Flags().Changed("output-dir")
+			options.SpecEditor = specEditorFromCommand(cmd)
 
 			return RenderComponents(env, &options)
 		}),
@@ -204,7 +207,7 @@ func RenderComponents(env *azldev.Env, options *RenderOptions) ([]*RenderResult,
 	results := make([]*RenderResult, len(componentList))
 
 	// ── Phase 1: Parallel source preparation ──
-	prepared := parallelPrepare(env, mockProcessor, componentList, stagingDir, options.OutputDir, results)
+	prepared := parallelPrepare(env, mockProcessor, componentList, stagingDir, options, results)
 
 	// ── Phase 2: Batch mock processing ──
 	mockResultMap := batchMockProcess(env, mockProcessor, stagingDir, prepared)
@@ -386,7 +389,7 @@ func parallelPrepare(
 	mockProcessor *sources.MockProcessor,
 	comps []components.Component,
 	stagingDir string,
-	outputDir string,
+	options *RenderOptions,
 	results []*RenderResult,
 ) []*preparedComponent {
 	progressEvent := env.StartEvent("Preparing component sources", "count", len(comps))
@@ -406,7 +409,8 @@ func parallelPrepare(
 			// workerEnv (captured) is the effective context for this call chain;
 			// the parmap-supplied ctx is identical and unused here.
 			//nolint:contextcheck // env carries the ctx
-			return prepareOneComponent(workerEnv, mockProcessor, comp, stagingDir, outputDir)
+			return prepareOneComponent(
+				workerEnv, mockProcessor, comp, stagingDir, options.OutputDir, options.specEditorMode())
 		},
 	)
 
@@ -418,7 +422,7 @@ func parallelPrepare(
 			// Worker never started — ctx ended before parmap reached it.
 			compName := comps[idx].GetName()
 
-			compOutputDir, nameErr := components.RenderedSpecDir(outputDir, compName)
+			compOutputDir, nameErr := components.RenderedSpecDir(options.OutputDir, compName)
 			if nameErr != nil {
 				compOutputDir = "(invalid)"
 			}
@@ -453,6 +457,7 @@ func prepareOneComponent(
 	comp components.Component,
 	stagingDir string,
 	outputDir string,
+	specEditor spec.EditorMode,
 ) prepResult {
 	componentName := comp.GetName()
 
@@ -467,7 +472,7 @@ func prepareOneComponent(
 		}}
 	}
 
-	prep, err := prepareComponentSources(env, mockProcessor, comp, stagingDir)
+	prep, err := prepareComponentSources(env, mockProcessor, comp, stagingDir, specEditor)
 	if err != nil {
 		slog.Error("Failed to prepare component sources",
 			"component", componentName, "error", err)
@@ -493,6 +498,7 @@ func prepareComponentSources(
 	mockProcessor *sources.MockProcessor,
 	comp components.Component,
 	stagingDir string,
+	specEditor spec.EditorMode,
 ) (*preparedComponent, error) {
 	componentName := comp.GetName()
 
@@ -531,7 +537,10 @@ func prepareComponentSources(
 		sources.WithMockProcessor(mockProcessor),
 	}
 
-	preparer, err := sources.NewPreparer(sourceManager, env.FS(), env, env, preparerOpts...)
+	preparer, err := newSourcePreparer(sourceManager, env.FS(), env, env, append(
+		preparerOpts,
+		sources.WithSpecEditor(specEditor),
+	)...)
 	if err != nil {
 		return nil, fmt.Errorf("creating source preparer for %#q:\n%w", componentName, err)
 	}

internal/app/azldev/cmds/component/sourcepreparer.go

@@ -0,0 +1,9 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+package component
+
+import "github.com/microsoft/azure-linux-dev-tools/internal/app/azldev/core/sources"
+
+//nolint:gochecknoglobals // Replaced by isolated command tests to observe constructed source preparers.
+var newSourcePreparer = sources.NewPreparer