feat: [#495] Centralize Error Messages in Framework (PR#1)

contracts/errors/errors.go

@@ -0,0 +1,13 @@
+package errors
+
+// Error is the interface that wraps the basic error methods
+type Error interface {
+	// Args allows setting arguments for the placeholders in the text
+	Args(...any) Error
+	// Error implements the error interface and formats the error string
+	Error() string
+	// Location explicitly sets the location in the error message
+	Location(string) Error
+	// WithLocation enables or disables the inclusion of the location in the error message
+	WithLocation(bool) Error
+}

errors/errors.go

@@ -0,0 +1,70 @@
+package errors
+
+import (
+	"errors"
+	"fmt"
+
+	errorscontracts "github.com/goravel/framework/contracts/errors"
+)
+
+type errorString struct {
+	text         string
+	location     string
+	args         []any
+	withLocation bool
+}
+
+// New creates a new error with the provided text and optional location
+func New(text string, location ...string) errorscontracts.Error {
+	err := &errorString{
+		text:         text,
+		withLocation: true,
+	}
+
+	if len(location) > 0 {
+		err.location = location[0]
+	}
+
+	return err
+}
+
+func (e *errorString) Args(args ...any) errorscontracts.Error {
+	e.args = args
+	return e
+}
+
+func (e *errorString) Error() string {
+	formattedText := e.text
+
+	if len(e.args) > 0 {
+		formattedText = fmt.Sprintf(e.text, e.args...)
+	}
+
+	if e.withLocation && e.location != "" {
+		formattedText = fmt.Sprintf("[%s] %s", e.location, formattedText)
+	}
+
+	return formattedText
+}
+
+func (e *errorString) Location(location string) errorscontracts.Error {
+	e.location = location
+	return e
+}
+
+func (e *errorString) WithLocation(flag bool) errorscontracts.Error {
+	e.withLocation = flag
+	return e
+}
+
+func Is(err, target error) bool {
+	return errors.Is(err, target)
+}
+
+func As(err error, target any) bool {
+	return errors.As(err, &target)
+}
+
+func Unwrap(err error) error {
+	return errors.Unwrap(err)
+}