style: Add newline between error context string and error (#347)

* Add newline between error context string and error

* update scenario snapshot and coding conventions

* add one more instance of newline before %w

Author: Binu Jose Philip

.github/instructions/go.instructions.md

@@ -28,14 +28,17 @@ applyTo: "**/*.go"
   - Interface Segregation - Prefer small, specific interfaces over large, general-purpose ones
   - Programming for interfaces, not implementations - Use interfaces to define behavior and allow for flexible implementations
 - Stick strictly to the existing coding conventions in this repository
-- For error handling we like to wrap errors: `return fmt.Errorf("context: %w", err)`. Define global errors where it makes sense: `var ErrName = errors.New("...")`
+- For error handling we like to wrap errors: `return fmt.Errorf("context:\n%w", err)`. Define global errors where it makes sense: `var ErrName = errors.New("...")`
+- For error messages with context, add a newline after the context message, before the error format specifier. Examples:
+  - `fmt.Errorf("This is an error context with wrapped error:\n%w")`
+  - `fmt.Errorf("This is a regular error with context string:\n%v")`
 - Follow established Go language practices and conventions:
   - Follow Go naming conventions (e.g., CamelCase for exported names)
   - Write concise, readable code with appropriate comments
   - Use Go idioms and standard library functions where appropriate
 - In formatted strings enclose string types in quotes. For that purpose use the `%#q` format verb unless the message already encloses the string in quotes. Examples:
-  - `return fmt.Errorf("failed to open %#q: %w", filename, err)`
-  - `return fmt.Errorf("failed to run command 'go %s': %w", strings.Join(args, " "), err)`
+  - `return fmt.Errorf("failed to open %#q:\n%w", filename, err)`
+  - `return fmt.Errorf("failed to run command 'go %s':\n%w", strings.Join(args, " "), err)`
 - Comments referring to types should encapsulate the type name in square brackets. Example: `// [packagename.MyType] is a custom type`
 - Use structured logging with slog
 - Ensure code passes golangci-lint checks

internal/app/azldev/app.go

@@ -317,7 +317,7 @@ func (a *App) Execute(args []string) int {
 func (*App) setCmdFactory(envOptions *EnvOptions) error {
 	cmdFactory, err := DefaultCmdFactory(envOptions.DryRunnable, envOptions.EventListener)
 	if err != nil {
-		return fmt.Errorf("error creating command factory: %w", err)
+		return fmt.Errorf("error creating command factory:\n%w", err)
 	}
 
 	envOptions.Interfaces.CmdFactory = cmdFactory
@@ -334,12 +334,12 @@ func (a *App) reInitLoggingWithLogFile(envOptions *EnvOptions) error {
 
 	logger, err := a.initFileLogging(envOptions.Config.Project.LogDir)
 	if err != nil {
-		return fmt.Errorf("error re-initializing file logging: %w", err)
+		return fmt.Errorf("error re-initializing file logging:\n%w", err)
 	}
 
 	err = setEventListener(logger, envOptions)
 	if err != nil {
-		return fmt.Errorf("error re-setting event listener: %w", err)
+		return fmt.Errorf("error re-setting event listener:\n%w", err)
 	}
 
 	return nil
@@ -365,7 +365,7 @@ func (a *App) initializeProjectConfig(envOptions *EnvOptions, earlyTempDirPath s
 		// Notify the user, but move on.
 		slog.Info("No Azure Linux project found; some commands will not be available.")
 	} else if err != nil {
-		return fmt.Errorf("error loading project configuration: %w", err)
+		return fmt.Errorf("error loading project configuration:\n%w", err)
 	}
 
 	envOptions.ProjectDir = projectDir
@@ -394,7 +394,7 @@ func (a *App) handlePostInitCallbacks(env *Env) error {
 
 	err := a.callPostInitCallbacks(env)
 	if err != nil {
-		return fmt.Errorf("error during post-config initialization: %w", err)
+		return fmt.Errorf("error during post-config initialization:\n%w", err)
 	}
 
 	return nil
@@ -403,7 +403,7 @@ func (a *App) handlePostInitCallbacks(env *Env) error {
 func setEventListener(stdioLogger *slog.Logger, envOptions *EnvOptions) error {
 	eventListener, err := NewEventListener(stdioLogger)
 	if err != nil {
-		return fmt.Errorf("error initializing event listener: %w", err)
+		return fmt.Errorf("error initializing event listener:\n%w", err)
 	}
 
 	envOptions.EventListener = eventListener
@@ -462,7 +462,7 @@ func (a *App) findAndLoadConfig(dryRunnable opctx.DryRunnable, tempDirPath strin
 	if referenceDir == "" {
 		referenceDir, err = a.osEnvFactory.OSEnv().Getwd()
 		if err != nil {
-			return projectDir, config, fmt.Errorf("failed to get working directory: %w", err)
+			return projectDir, config, fmt.Errorf("failed to get working directory:\n%w", err)
 		}
 	}
 
@@ -476,7 +476,7 @@ func (a *App) findAndLoadConfig(dryRunnable opctx.DryRunnable, tempDirPath strin
 		tempDirPath,
 	)
 	if err != nil {
-		return projectDir, config, fmt.Errorf("failed to load project configuration: %w", err)
+		return projectDir, config, fmt.Errorf("failed to load project configuration:\n%w", err)
 	}
 
 	return projectDir, config, nil
@@ -537,15 +537,15 @@ func (a *App) initFileLogging(logDir string) (*slog.Logger, error) {
 
 	err := fileutils.MkdirAll(fs, logDir)
 	if err != nil {
-		return nil, fmt.Errorf("failed to ensure log dir %#q exists: %w", logDir, err)
+		return nil, fmt.Errorf("failed to ensure log dir %#q exists:\n%w", logDir, err)
 	}
 
 	// Create the log file anew.
 	logFilePath := filepath.Join(logDir, defaultLogFilename)
 
 	logFile, err := fs.Create(logFilePath)
 	if err != nil {
-		return nil, fmt.Errorf("failed to create log file at %#q: %w", logFilePath, err)
+		return nil, fmt.Errorf("failed to create log file at %#q:\n%w", logFilePath, err)
 	}
 
 	// We log with the configured verbosity level to

internal/app/azldev/cmds/advanced/mcp.go

@@ -24,7 +24,7 @@ func NewMCPCmd() *cobra.Command {
 		RunE: (func(cmd *cobra.Command, args []string) error {
 			env, err := azldev.GetEnvFromCommand(cmd)
 			if err != nil {
-				return fmt.Errorf("failed to get command environment: %w", err)
+				return fmt.Errorf("failed to get command environment:\n%w", err)
 			}
 
 			return mcp.RunMCPServer(env, cmd)

internal/app/azldev/cmds/advanced/wget.go

@@ -47,12 +47,12 @@ func NewWgetCmd() *cobra.Command {
 func Download(env *azldev.Env, options *DownloadOptions) error {
 	httpDownloader, err := downloader.NewHTTPDownloader(env, env, env.FS())
 	if err != nil {
-		return fmt.Errorf("failed to create downloader: %w", err)
+		return fmt.Errorf("failed to create downloader:\n%w", err)
 	}
 
 	err = httpDownloader.Download(env, options.uri, options.outputFilePath)
 	if err != nil {
-		return fmt.Errorf("failed to download '%s' to '%s': %w", options.uri, options.outputFilePath, err)
+		return fmt.Errorf("failed to download '%s' to '%s':\n%w", options.uri, options.outputFilePath, err)
 	}
 
 	return nil

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

@@ -78,7 +78,7 @@ func AddComponentsToConfig(
 
 	err = updateConfigFileFromDoc(fs, config.RootConfigFilePath, doc)
 	if err != nil {
-		return fmt.Errorf("failed to update project config file %q: %w", config.RootConfigFilePath, err)
+		return fmt.Errorf("failed to update project config file %q:\n%w", config.RootConfigFilePath, err)
 	}
 
 	return nil
@@ -90,14 +90,14 @@ func AddComponentsToConfig(
 func parseConfigFileForEditing(fs opctx.FS, configFilePath string) (*tomledit.Document, error) {
 	configFileBytes, err := fileutils.ReadFile(fs, configFilePath)
 	if err != nil {
-		return nil, fmt.Errorf("failed to read project config file %q: %w", configFilePath, err)
+		return nil, fmt.Errorf("failed to read project config file %q:\n%w", configFilePath, err)
 	}
 
 	configFileReader := bytes.NewReader(configFileBytes)
 
 	doc, err := tomledit.Parse(configFileReader)
 	if err != nil {
-		return nil, fmt.Errorf("failed to parse project config file %q: %w", configFilePath, err)
+		return nil, fmt.Errorf("failed to parse project config file %q:\n%w", configFilePath, err)
 	}
 
 	return doc, nil
@@ -112,18 +112,18 @@ func updateConfigFileFromDoc(fs opctx.FS, configFilePath string, doc *tomledit.D
 
 	updateWriter, err := fileutils.NewFileUpdateWriter(fs, configFilePath)
 	if err != nil {
-		return fmt.Errorf("failed to create file update writer for %q: %w", configFilePath, err)
+		return fmt.Errorf("failed to create file update writer for %q:\n%w", configFilePath, err)
 	}
 
 	err = formatter.Format(updateWriter, doc)
 	if err != nil {
-		return fmt.Errorf("failed to update project config file %q: %w", configFilePath, err)
+		return fmt.Errorf("failed to update project config file %q:\n%w", configFilePath, err)
 	}
 
 	// Commit!
 	err = updateWriter.Commit()
 	if err != nil {
-		return fmt.Errorf("failed to commit updates to project config file %q: %w", configFilePath, err)
+		return fmt.Errorf("failed to commit updates to project config file %q:\n%w", configFilePath, err)
 	}
 
 	return nil

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

@@ -86,7 +86,7 @@ func SelectAndBuildComponents(env *azldev.Env, options *ComponentBuildOptions,
 
 	comps, err := resolver.FindComponents(&options.ComponentFilter)
 	if err != nil {
-		return nil, fmt.Errorf("failed to resolve components: %w", err)
+		return nil, fmt.Errorf("failed to resolve components:\n%w", err)
 	}
 
 	if comps.Len() == 0 {
@@ -112,23 +112,23 @@ func buildComponents(
 
 	workDirFactory, err := workdir.NewFactory(env.FS(), env.WorkDir(), env.ConstructionTime())
 	if err != nil {
-		return nil, fmt.Errorf("failed to create work dir factory: %w", err)
+		return nil, fmt.Errorf("failed to create work dir factory:\n%w", err)
 	}
 
 	orchestrator, err := orchestrator.NewOrchestrator(env.FS(),
 		orchestrator.WithBuildDir(env.WorkDir()),
 		orchestrator.WithOutputDir(env.OutputDir()),
 	)
 	if err != nil {
-		return nil, fmt.Errorf("failed to create orchestrator: %w", err)
+		return nil, fmt.Errorf("failed to create orchestrator:\n%w", err)
 	}
 
 	results := make([]ComponentBuildResults, 0, components.Len())
 
 	for _, component := range components.Components() {
 		componentResults, buildErr := BuildComponent(env, orchestrator, component, workDirFactory, options)
 		if buildErr != nil {
-			buildErr = fmt.Errorf("failed to build %q: %w", component.GetName(), buildErr)
+			buildErr = fmt.Errorf("failed to build %q:\n%w", component.GetName(), buildErr)
 		}
 
 		err = errors.Join(err, buildErr)
@@ -156,7 +156,7 @@ func BuildComponent(
 	if component.GetConfig().Spec.SourceType == projectconfig.SpecSourceTypeUpstream {
 		rpmContentsProvider, err = buildRPMContentsProvider(env, component)
 		if err != nil {
-			return ComponentBuildResults{}, fmt.Errorf("failed to create RPM contents provider: %w", err)
+			return ComponentBuildResults{}, fmt.Errorf("failed to create RPM contents provider:\n%w", err)
 		}
 	}
 
@@ -165,7 +165,7 @@ func BuildComponent(
 	buildEnv, err = workdir.MkComponentBuildEnvironment(env, workDirFactory, component.GetConfig(), "build")
 	if err != nil {
 		return ComponentBuildResults{},
-			fmt.Errorf("failed to create build environment for component %q: %w", component.GetName(), err)
+			fmt.Errorf("failed to create build environment for component %q:\n%w", component.GetName(), err)
 	}
 
 	// Clean up the build environment before we return (unless we were asked not to do so).
@@ -201,7 +201,7 @@ func buildComponentUsingBuilder(
 
 	srpmPath, err := buildSRPM(env.Context(), builder, component, orchestrator)
 	if err != nil {
-		return results, fmt.Errorf("failed to build SRPM for %q: %w", component.GetName(), err)
+		return results, fmt.Errorf("failed to build SRPM for %q:\n%w", component.GetName(), err)
 	}
 
 	results.SRPMPaths = []string{srpmPath}
@@ -213,7 +213,7 @@ func buildComponentUsingBuilder(
 
 	rpmPaths, err := buildRPMs(env.Context(), builder, component, srpmPath, runChecks, orchestrator)
 	if err != nil {
-		return results, fmt.Errorf("failed to build RPMs for %q: %w", component.GetName(), err)
+		return results, fmt.Errorf("failed to build RPMs for %q:\n%w", component.GetName(), err)
 	}
 
 	results.RPMPaths = rpmPaths
@@ -229,27 +229,27 @@ func buildRPMs(
 	// and move creation of subtasks into the orchestrator and task factories.
 	binaryTaskBuilder, err := NewBinaryPackageTaskBuilder(builder, component, srpmPath, runChecks)
 	if err != nil {
-		return nil, fmt.Errorf("failed to create binary package task builder: %w", err)
+		return nil, fmt.Errorf("failed to create binary package task builder:\n%w", err)
 	}
 
 	err = orchestrator.AssignTaskServices(binaryTaskBuilder)
 	if err != nil {
-		return nil, fmt.Errorf("failed to assign task services for binary package task: %w", err)
+		return nil, fmt.Errorf("failed to assign task services for binary package task:\n%w", err)
 	}
 
 	binaryTask, err := binaryTaskBuilder.Build()
 	if err != nil {
-		return nil, fmt.Errorf("failed to build binary package task: %w", err)
+		return nil, fmt.Errorf("failed to build binary package task:\n%w", err)
 	}
 
 	rawBinaryArtifacts, err := orchestrator.RunTask(ctx, binaryTask)
 	if err != nil {
-		return nil, fmt.Errorf("failed to run binary package task: %w", err)
+		return nil, fmt.Errorf("failed to run binary package task:\n%w", err)
 	}
 
 	typedBinaryArtifacts, err := artifacts.Cast[*FileArtifact](rawBinaryArtifacts...)
 	if err != nil {
-		return nil, fmt.Errorf("failed to cast binary artifacts: %w", err)
+		return nil, fmt.Errorf("failed to cast binary artifacts:\n%w", err)
 	}
 
 	// Extract RPM paths from artifacts
@@ -266,22 +266,22 @@ func buildSRPM(
 	// and move creation of subtasks into the orchestrator and task factories.
 	sourceTaskBuilder, err := NewSourcesTaskBuilder(builder, component)
 	if err != nil {
-		return "", fmt.Errorf("failed to create sources task builder: %w", err)
+		return "", fmt.Errorf("failed to create sources task builder:\n%w", err)
 	}
 
 	err = orchestrator.AssignTaskServices(sourceTaskBuilder)
 	if err != nil {
-		return "", fmt.Errorf("failed to assign task services for sources task: %w", err)
+		return "", fmt.Errorf("failed to assign task services for sources task:\n%w", err)
 	}
 
 	sourcesTask, err := sourceTaskBuilder.Build()
 	if err != nil {
-		return "", fmt.Errorf("failed to build sources task: %w", err)
+		return "", fmt.Errorf("failed to build sources task:\n%w", err)
 	}
 
 	rawArtifacts, err := orchestrator.RunTask(ctx, sourcesTask)
 	if err != nil {
-		return "", fmt.Errorf("failed to run sources task: %w", err)
+		return "", fmt.Errorf("failed to run sources task:\n%w", err)
 	}
 
 	if len(rawArtifacts) != 1 {
@@ -291,7 +291,7 @@ func buildSRPM(
 
 	typedArtifacts, err := artifacts.Cast[*FileArtifact](rawArtifacts...)
 	if err != nil {
-		return "", fmt.Errorf("failed to cast artifact: %w", err)
+		return "", fmt.Errorf("failed to cast artifact:\n%w", err)
 	}
 
 	return typedArtifacts[0].Path, nil

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

@@ -59,12 +59,12 @@ func newSourcesTask(
 
 	taskID, err := orchestration.NewTaskID[sourcesTask](component.GetName())
 	if err != nil {
-		return nil, fmt.Errorf("failed to create task ID for component %q: %w", component.GetName(), err)
+		return nil, fmt.Errorf("failed to create task ID for component %q:\n%w", component.GetName(), err)
 	}
 
 	baseTask, err := orchestration.NewBaseTask(taskID)
 	if err != nil {
-		return nil, fmt.Errorf("failed to create base task for component %q: %w", component.GetName(), err)
+		return nil, fmt.Errorf("failed to create base task for component %q:\n%w", component.GetName(), err)
 	}
 
 	// Create a new task for the component.
@@ -82,7 +82,7 @@ func (t *sourcesTask) Run(ctx context.Context) ([]artifacts.Artifact, error) {
 
 	outputSourcePackagePath, err := t.componentBuilder.BuildSourcePackage(ctx, t.component, outputDir)
 	if err != nil {
-		return nil, fmt.Errorf("failed to build SRPM for %#q: %w", t.component.GetName(), err)
+		return nil, fmt.Errorf("failed to build SRPM for %#q:\n%w", t.component.GetName(), err)
 	}
 
 	if outputSourcePackagePath == "" {
@@ -107,7 +107,7 @@ func NewSourcesTaskBuilder(
 ) (*sourcesTaskBuilder, error) {
 	builtTask, err := newSourcesTask(componentBuilder, component)
 	if err != nil {
-		return nil, fmt.Errorf("failed to create sources task: %w", err)
+		return nil, fmt.Errorf("failed to create sources task:\n%w", err)
 	}
 
 	return &sourcesTaskBuilder{
@@ -164,12 +164,12 @@ func newBinaryPackageTask(
 
 	taskID, err := orchestration.NewTaskID[binaryPackageTask](component.GetName())
 	if err != nil {
-		return nil, fmt.Errorf("failed to create task ID for component %q: %w", component.GetName(), err)
+		return nil, fmt.Errorf("failed to create task ID for component %q:\n%w", component.GetName(), err)
 	}
 
 	baseTask, err := orchestration.NewBaseTask(taskID)
 	if err != nil {
-		return nil, fmt.Errorf("failed to create base task for component %q: %w", component.GetName(), err)
+		return nil, fmt.Errorf("failed to create base task for component %q:\n%w", component.GetName(), err)
 	}
 
 	return &binaryPackageTask{
@@ -186,7 +186,7 @@ func (t *binaryPackageTask) Run(ctx context.Context) ([]artifacts.Artifact, erro
 
 	rpmPaths, err := t.componentBuilder.BuildBinaryPackage(ctx, t.component, t.sourcePackagePath, outputDir, t.runChecks)
 	if err != nil {
-		return nil, fmt.Errorf("failed to build RPM for %#q: %w", t.component.GetName(), err)
+		return nil, fmt.Errorf("failed to build RPM for %#q:\n%w", t.component.GetName(), err)
 	}
 
 	if len(rpmPaths) == 0 {
@@ -215,7 +215,7 @@ func NewBinaryPackageTaskBuilder(
 ) (*binaryPackageTaskBuilder, error) {
 	builtTask, err := newBinaryPackageTask(componentBuilder, component, sourcePackagePath, runChecks)
 	if err != nil {
-		return nil, fmt.Errorf("failed to create binary package task: %w", err)
+		return nil, fmt.Errorf("failed to create binary package task:\n%w", err)
 	}
 
 	return &binaryPackageTaskBuilder{

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

@@ -55,7 +55,7 @@ func ListComponentConfigs(
 
 	comps, err = resolver.FindComponents(&options.ComponentFilter)
 	if err != nil {
-		return results, fmt.Errorf("failed to resolve components: %w", err)
+		return results, fmt.Errorf("failed to resolve components:\n%w", err)
 	}
 
 	// Extract the component configs from the resolved components, and return them in a slice.