mirror of
https://github.com/ivuorinen/gibidify.git
synced 2026-01-26 11:34:03 +00:00
286 lines
8.4 KiB
Go
286 lines
8.4 KiB
Go
package cli
|
|
|
|
import (
|
|
"errors"
|
|
"os"
|
|
"path/filepath"
|
|
"strings"
|
|
|
|
"github.com/ivuorinen/gibidify/utils"
|
|
)
|
|
|
|
// ErrorFormatter handles CLI-friendly error formatting with suggestions.
|
|
type ErrorFormatter struct {
|
|
ui *UIManager
|
|
}
|
|
|
|
// NewErrorFormatter creates a new error formatter.
|
|
func NewErrorFormatter(ui *UIManager) *ErrorFormatter {
|
|
return &ErrorFormatter{ui: ui}
|
|
}
|
|
|
|
// FormatError formats an error with context and suggestions.
|
|
func (ef *ErrorFormatter) FormatError(err error) {
|
|
if err == nil {
|
|
return
|
|
}
|
|
|
|
// Handle structured errors
|
|
if structErr, ok := err.(*utils.StructuredError); ok {
|
|
ef.formatStructuredError(structErr)
|
|
return
|
|
}
|
|
|
|
// Handle common error types
|
|
ef.formatGenericError(err)
|
|
}
|
|
|
|
// formatStructuredError formats a structured error with context and suggestions.
|
|
func (ef *ErrorFormatter) formatStructuredError(err *utils.StructuredError) {
|
|
// Print main error
|
|
ef.ui.PrintError("Error: %s", err.Message)
|
|
|
|
// Print error type and code
|
|
if err.Type != utils.ErrorTypeUnknown || err.Code != "" {
|
|
ef.ui.PrintInfo("Type: %s, Code: %s", err.Type.String(), err.Code)
|
|
}
|
|
|
|
// Print file path if available
|
|
if err.FilePath != "" {
|
|
ef.ui.PrintInfo("File: %s", err.FilePath)
|
|
}
|
|
|
|
// Print context if available
|
|
if len(err.Context) > 0 {
|
|
ef.ui.PrintInfo("Context:")
|
|
for key, value := range err.Context {
|
|
ef.ui.printf(" %s: %v\n", key, value)
|
|
}
|
|
}
|
|
|
|
// Provide suggestions based on error type
|
|
ef.provideSuggestions(err)
|
|
}
|
|
|
|
// formatGenericError formats a generic error.
|
|
func (ef *ErrorFormatter) formatGenericError(err error) {
|
|
ef.ui.PrintError("Error: %s", err.Error())
|
|
ef.provideGenericSuggestions(err)
|
|
}
|
|
|
|
// provideSuggestions provides helpful suggestions based on the error.
|
|
func (ef *ErrorFormatter) provideSuggestions(err *utils.StructuredError) {
|
|
switch err.Type {
|
|
case utils.ErrorTypeFileSystem:
|
|
ef.provideFileSystemSuggestions(err)
|
|
case utils.ErrorTypeValidation:
|
|
ef.provideValidationSuggestions(err)
|
|
case utils.ErrorTypeProcessing:
|
|
ef.provideProcessingSuggestions(err)
|
|
case utils.ErrorTypeIO:
|
|
ef.provideIOSuggestions(err)
|
|
default:
|
|
ef.provideDefaultSuggestions()
|
|
}
|
|
}
|
|
|
|
// provideFileSystemSuggestions provides suggestions for file system errors.
|
|
func (ef *ErrorFormatter) provideFileSystemSuggestions(err *utils.StructuredError) {
|
|
filePath := err.FilePath
|
|
|
|
ef.ui.PrintWarning("Suggestions:")
|
|
|
|
switch err.Code {
|
|
case utils.CodeFSAccess:
|
|
ef.suggestFileAccess(filePath)
|
|
case utils.CodeFSPathResolution:
|
|
ef.suggestPathResolution(filePath)
|
|
case utils.CodeFSNotFound:
|
|
ef.suggestFileNotFound(filePath)
|
|
default:
|
|
ef.suggestFileSystemGeneral(filePath)
|
|
}
|
|
}
|
|
|
|
// provideValidationSuggestions provides suggestions for validation errors.
|
|
func (ef *ErrorFormatter) provideValidationSuggestions(err *utils.StructuredError) {
|
|
ef.ui.PrintWarning("Suggestions:")
|
|
|
|
switch err.Code {
|
|
case utils.CodeValidationFormat:
|
|
ef.ui.printf(" • Use a supported format: markdown, json, yaml\n")
|
|
ef.ui.printf(" • Example: -format markdown\n")
|
|
case utils.CodeValidationSize:
|
|
ef.ui.printf(" • Increase file size limit in config.yaml\n")
|
|
ef.ui.printf(" • Use smaller files or exclude large files\n")
|
|
default:
|
|
ef.ui.printf(" • Check your command line arguments\n")
|
|
ef.ui.printf(" • Run with --help for usage information\n")
|
|
}
|
|
}
|
|
|
|
// provideProcessingSuggestions provides suggestions for processing errors.
|
|
func (ef *ErrorFormatter) provideProcessingSuggestions(err *utils.StructuredError) {
|
|
ef.ui.PrintWarning("Suggestions:")
|
|
|
|
switch err.Code {
|
|
case utils.CodeProcessingCollection:
|
|
ef.ui.printf(" • Check if the source directory exists and is readable\n")
|
|
ef.ui.printf(" • Verify directory permissions\n")
|
|
case utils.CodeProcessingFileRead:
|
|
ef.ui.printf(" • Check file permissions\n")
|
|
ef.ui.printf(" • Verify the file is not corrupted\n")
|
|
default:
|
|
ef.ui.printf(" • Try reducing concurrency: -concurrency 1\n")
|
|
ef.ui.printf(" • Check available system resources\n")
|
|
}
|
|
}
|
|
|
|
// provideIOSuggestions provides suggestions for I/O errors.
|
|
func (ef *ErrorFormatter) provideIOSuggestions(err *utils.StructuredError) {
|
|
ef.ui.PrintWarning("Suggestions:")
|
|
|
|
switch err.Code {
|
|
case utils.CodeIOFileCreate:
|
|
ef.ui.printf(" • Check if the destination directory exists\n")
|
|
ef.ui.printf(" • Verify write permissions for the output file\n")
|
|
ef.ui.printf(" • Ensure sufficient disk space\n")
|
|
case utils.CodeIOWrite:
|
|
ef.ui.printf(" • Check available disk space\n")
|
|
ef.ui.printf(" • Verify write permissions\n")
|
|
default:
|
|
ef.ui.printf(" • Check file/directory permissions\n")
|
|
ef.ui.printf(" • Verify available disk space\n")
|
|
}
|
|
}
|
|
|
|
// Helper methods for specific suggestions
|
|
func (ef *ErrorFormatter) suggestFileAccess(filePath string) {
|
|
ef.ui.printf(" • Check if the path exists: %s\n", filePath)
|
|
ef.ui.printf(" • Verify read permissions\n")
|
|
if filePath != "" {
|
|
if stat, err := os.Stat(filePath); err == nil {
|
|
ef.ui.printf(" • Path exists but may not be accessible\n")
|
|
ef.ui.printf(" • Mode: %s\n", stat.Mode())
|
|
}
|
|
}
|
|
}
|
|
|
|
func (ef *ErrorFormatter) suggestPathResolution(filePath string) {
|
|
ef.ui.printf(" • Use an absolute path instead of relative\n")
|
|
if filePath != "" {
|
|
if abs, err := filepath.Abs(filePath); err == nil {
|
|
ef.ui.printf(" • Try: %s\n", abs)
|
|
}
|
|
}
|
|
}
|
|
|
|
func (ef *ErrorFormatter) suggestFileNotFound(filePath string) {
|
|
ef.ui.printf(" • Check if the file/directory exists: %s\n", filePath)
|
|
if filePath != "" {
|
|
dir := filepath.Dir(filePath)
|
|
if entries, err := os.ReadDir(dir); err == nil {
|
|
ef.ui.printf(" • Similar files in %s:\n", dir)
|
|
count := 0
|
|
for _, entry := range entries {
|
|
if count >= 3 {
|
|
break
|
|
}
|
|
if strings.Contains(entry.Name(), filepath.Base(filePath)) {
|
|
ef.ui.printf(" - %s\n", entry.Name())
|
|
count++
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
func (ef *ErrorFormatter) suggestFileSystemGeneral(filePath string) {
|
|
ef.ui.printf(" • Check file/directory permissions\n")
|
|
ef.ui.printf(" • Verify the path is correct\n")
|
|
if filePath != "" {
|
|
ef.ui.printf(" • Path: %s\n", filePath)
|
|
}
|
|
}
|
|
|
|
// provideDefaultSuggestions provides general suggestions.
|
|
func (ef *ErrorFormatter) provideDefaultSuggestions() {
|
|
ef.ui.printf(" • Check your command line arguments\n")
|
|
ef.ui.printf(" • Run with --help for usage information\n")
|
|
ef.ui.printf(" • Try with -concurrency 1 to reduce resource usage\n")
|
|
}
|
|
|
|
// provideGenericSuggestions provides suggestions for generic errors.
|
|
func (ef *ErrorFormatter) provideGenericSuggestions(err error) {
|
|
errorMsg := err.Error()
|
|
|
|
ef.ui.PrintWarning("Suggestions:")
|
|
|
|
// Pattern matching for common errors
|
|
switch {
|
|
case strings.Contains(errorMsg, "permission denied"):
|
|
ef.ui.printf(" • Check file/directory permissions\n")
|
|
ef.ui.printf(" • Try running with appropriate privileges\n")
|
|
case strings.Contains(errorMsg, "no such file or directory"):
|
|
ef.ui.printf(" • Verify the file/directory path is correct\n")
|
|
ef.ui.printf(" • Check if the file exists\n")
|
|
case strings.Contains(errorMsg, "flag") && strings.Contains(errorMsg, "redefined"):
|
|
ef.ui.printf(" • This is likely a test environment issue\n")
|
|
ef.ui.printf(" • Try running the command directly instead of in tests\n")
|
|
default:
|
|
ef.provideDefaultSuggestions()
|
|
}
|
|
}
|
|
|
|
// CLI-specific error types
|
|
|
|
// CLIMissingSourceError represents a missing source directory error.
|
|
type CLIMissingSourceError struct{}
|
|
|
|
func (e CLIMissingSourceError) Error() string {
|
|
return "source directory is required"
|
|
}
|
|
|
|
// NewCLIMissingSourceError creates a new CLI missing source error with suggestions.
|
|
func NewCLIMissingSourceError() error {
|
|
return &CLIMissingSourceError{}
|
|
}
|
|
|
|
// IsUserError checks if an error is a user input error that should be handled gracefully.
|
|
func IsUserError(err error) bool {
|
|
if err == nil {
|
|
return false
|
|
}
|
|
|
|
// Check for specific user error types
|
|
var cliErr *CLIMissingSourceError
|
|
if errors.As(err, &cliErr) {
|
|
return true
|
|
}
|
|
|
|
// Check for structured errors that are user-facing
|
|
if structErr, ok := err.(*utils.StructuredError); ok {
|
|
return structErr.Type == utils.ErrorTypeValidation ||
|
|
structErr.Code == utils.CodeValidationFormat ||
|
|
structErr.Code == utils.CodeValidationSize
|
|
}
|
|
|
|
// Check error message patterns
|
|
errMsg := err.Error()
|
|
userErrorPatterns := []string{
|
|
"flag",
|
|
"usage",
|
|
"invalid argument",
|
|
"file not found",
|
|
"permission denied",
|
|
}
|
|
|
|
for _, pattern := range userErrorPatterns {
|
|
if strings.Contains(strings.ToLower(errMsg), pattern) {
|
|
return true
|
|
}
|
|
}
|
|
|
|
return false
|
|
}
|