Skip to content

[Code Quality] Improve error messages with typo detection in engine validation #14087

Closed as not planned

Description

@github-actions

Description

When users specify an invalid engine name, they receive a generic error listing valid options. However, common typos like "co-pilot" (instead of "copilot") or "claude-3" (instead of "claude") could be detected and corrected immediately, reducing troubleshooting time.

Suggested Changes

Enhance pkg/workflow/engine_validation.go (lines 68-71) to detect common typos and provide specific "Did you mean?" suggestions:

  1. Add pattern matching for common typos:

    • "co-pilot" or "co pilot" → suggest "copilot"
    • "claude-3" or "claude3" → suggest "claude"
    • "gpt" or "openai" → suggest "codex"
  2. Include suggestion in error message when pattern matches

  3. Maintain existing error format with valid engine list

Files Affected

  • pkg/workflow/engine_validation.go (lines 68-71)

Success Criteria

  • At least 3 common typo patterns detected
  • Error messages provide specific "Did you mean?" suggestions
  • Existing error format preserved with added suggestion
  • Reduces troubleshooting time from 2-3 minutes to immediate resolution
  • No other files need changes

Source

Extracted from User Experience Analysis discussion #13994

Original recommendation:

Opportunity 2: Enhance Error Message Clarity in Engine Validation

  • Issue: Error message provides valid options but doesn't help users understand common mistakes
  • User Impact: When users mistype an engine name, they receive a generic invalid engine message requiring careful comparison
  • Design Principle: "Clear error messages with actionable solutions"

Priority

Medium - Improves error message quality and reduces user frustration

AI generated by Discussion Task Miner - Code Quality Improvement Agent

  • expires on Feb 7, 2026, 9:12 AM UTC

Activity

  1. github-actions commented on Feb 7, 2026

    @github-actions
    ContributorAuthor

    This issue was automatically closed because it expired on 2026-02-07T09:12:12.930Z.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions