Extract error formatting helper in compiler.go to reduce duplication

[Copilot]

✅ Completed: Extract Error Formatting Helper in compiler.go

• Create helper function formatCompilerError() in compiler.go
• Replace 24 instances of repetitive error formatting with helper function
• Create focused unit tests for the helper function
• Run unit tests to validate changes
• Run fmt and lint to ensure code quality
• Verify error message output format remains unchanged
• Address code review feedback
• Apply formatting and linting (requested by @pelikhan)

Summary

Successfully extracted error formatting logic into helper functions, reducing code duplication:

Code Changes:

• Added formatCompilerError() helper for error returns
• Added formatCompilerMessage() helper for warning strings
• Replaced 24 repetitive error formatting blocks
• Net reduction: 180 lines (240 deleted, 60 added) - 27% reduction in duplication
• Added clarifying comments for cases where errors are stored before returning

Testing:

• Added comprehensive unit tests for both helpers
• All existing compiler tests pass (except 2 pre-existing failures unrelated to this change)
• Linting and formatting checks pass (0 issues)
• Manual testing confirms error format unchanged

Code Review:

• Addressed feedback about error variable storage pattern
• Added clarifying comments explaining why some cases store error before returning
• Pattern is consistent: errors stored only when additional operations (file writes) needed before return

Files Changed:

• pkg/workflow/compiler.go - Added helper functions and replaced 24 instances
• pkg/workflow/compiler_error_formatting_test.go - New test file with comprehensive coverage
• pkg/workflow/action_pins_test.go - Formatting alignment

Impact:

• ✅ Improved code maintainability
• ✅ Reduced technical debt by ~200 lines
• ✅ No behavior changes - error format remains identical
• ✅ No breaking changes
• ✅ All success criteria met

Original prompt

---

This section details on the original issue you should resolve

<issue_title>[Code Quality] Extract error formatting helper in compiler.go to reduce duplication</issue_title>
<issue_description>## Description

The compiler.go file contains 20+ repetitive blocks of error formatting code that follow the same pattern. Extracting this into a helper function would reduce approximately 200 lines of code duplication and improve maintainability.

Current Pattern (Repeated ~20 times)

formattedErr := console.FormatError(console.CompilerError{
    Position: console.ErrorPosition{
        File:   markdownPath,
        Line:   1,
        Column: 1,
    },
    Type:    "error",
    Message: err.Error(),
})
return errors.New(formattedErr)

Proposed Solution

Extract into a helper function:

func formatCompilerError(markdownPath string, err error) error {
    formattedErr := console.FormatError(console.CompilerError{
        Position: console.ErrorPosition{
            File:   markdownPath,
            Line:   1,
            Column: 1,
        },
        Type:    "error",
        Message: err.Error(),
    })
    return errors.New(formattedErr)
}

Usage: Replace 20+ repetitive blocks with return formatCompilerError(markdownPath, err)

Files Affected

• pkg/workflow/compiler.go (20+ instances of repetitive error formatting)

Success Criteria

• Helper function formatCompilerError() created
• All 20+ repetitive blocks replaced with helper function call
• Code reduction of ~200 lines achieved
• All existing tests pass
• No change to error message output format

Impact

• Severity: Medium - Improves code maintainability
• Effort: Low - Estimated 30 minutes
• Lines Reduced: ~200 lines
• Risk: Minimal - Simple refactoring with no behavior change

Source

Extracted from Daily Compiler Code Quality Report - 2026-01-28

Priority

Medium-High - Reduces technical debt and improves code readability

AI generated by Discussion Task Miner - Code Quality Improvement Agent

• expires on Feb 11, 2026, 9:11 AM UTC

Comments on the Issue (you are @copilot in this section)

• Fixes [Code Quality] Extract error formatting helper in compiler.go to reduce duplication #12221

---

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

[pelikhan]

@copilot format, lint go

[Copilot]

@copilot format, lint go

Formatting and linting completed successfully. Both make fmt and make lint pass with 0 issues. The only change was a formatting alignment in action_pins_test.go (commit 5d1ab0b).

@copilot format, lint go

Formatting and linting completed successfully. Both make fmt and make lint pass with 0 issues. Applied formatting alignment in action_pins_test.go (commit e377493).

[github-actions]

🔍 PR Triage Results

Category: bug | Risk: low | Priority: 60/100

Scores Breakdown

• Impact: 35/50 - Bug fix has moderate impact on code quality
• Urgency: 15/30 - Standard bug fix urgency
• Quality: 10/20 - Has description and pending CI validation

📋 Recommended Action: batch_review

This PR should be reviewed as part of a batch of similar bug fixes and refactoring work. The low risk and moderate priority make it suitable for coordinated review.

---

Triaged by PR Triage Agent on 2026-01-28T18:16:26Z

AI generated by PR Triage Agent