https://github.com/gabrielhcataldo/go-errors

🪳 Lib written in Go, facilitates and improves the visibility of errors that occur in your project, for better bug debugging, we have a robust structure and following the standard error interface, we have message, file, line, stack trace, cause everything for your project.
https://github.com/gabrielhcataldo/go-errors

debug debugging error errors go-debug go-error-handler go-error-handling go-errors

Last synced: 11 months ago
JSON representation

🪳 Lib written in Go, facilitates and improves the visibility of errors that occur in your project, for better bug debugging, we have a robust structure and following the standard error interface, we have message, file, line, stack trace, cause everything for your project.

• Host: GitHub
• URL: https://github.com/gabrielhcataldo/go-errors
• Owner: GabrielHCataldo
• License: mit
• Created: 2024-01-04T10:22:54.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-24T22:48:43.000Z (over 1 year ago)
• Last Synced: 2025-02-07T21:42:45.738Z (about 1 year ago)
• Topics: debug, debugging, error, errors, go-debug, go-error-handler, go-error-handling, go-errors
• Language: Go
• Homepage: https://pkg.go.dev/github.com/GabrielHCataldo/go-errors/errors
• Size: 52.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
Go Errors Detail

=================



[![Project status](https://img.shields.io/badge/version-v1.2.1-vividgreen.svg)](https://github.com/GabrielHCataldo/go-errors/releases/tag/v1.2.1)

[![Go Report Card](https://goreportcard.com/badge/github.com/GabrielHCataldo/go-errors)](https://goreportcard.com/report/github.com/GabrielHCataldo/go-errors)

[![Coverage Status](https://coveralls.io/repos/GabrielHCataldo/go-errors/badge.svg?branch=main&service=github)](https://coveralls.io/github/GabrielHCataldo/go-errors?branch=main)

[![Open Source Helpers](https://www.codetriage.com/gabrielhcataldo/go-errors/badges/users.svg)](https://www.codetriage.com/gabrielhcataldo/go-errors)

[![GoDoc](https://godoc.org/github/GabrielHCataldo/go-errors?status.svg)](https://pkg.go.dev/github.com/GabrielHCataldo/go-errors/errors)

![License](https://img.shields.io/dub/l/vibe-d.svg)

[//]: # ([![build workflow](https://github.com/GabrielHCataldo/go-errors/actions/workflows/go.yml/badge.svg)](https://github.com/GabrielHCataldo/go-errors/actions))

[//]: # ([![Source graph](https://sourcegraph.com/github.com/go-errors/errors/-/badge.svg)](https://sourcegraph.com/github.com/go-errors/errors?badge))

[//]: # ([![TODOs](https://badgen.net/https/api.tickgit.com/badgen/github.com/GabrielHCataldo/go-errors/errors)](https://www.tickgit.com/browse?repo=github.com/GabrielHCataldo/go-errors))

The go-errors project came to clarify the return of errors, which are very common in Golang, thus facilitating the

debugging your projects.

Installation

------------

Use go get.

	go get github.com/GabrielHCataldo/go-errors

Then import the go-errors package into your own code.

```go

import "github.com/GabrielHCataldo/go-errors/errors"

```

Usability and documentation

------------

**IMPORTANT**: Always check the documentation in the structures and functions fields.

For more details on the examples, visit [All examples link](https://github/GabrielHCataldo/go-errors/blob/main/_example/main).

### Simple example

```go

package main

import (

    "github.com/GabrielHCataldo/go-errors/errors"

    "github.com/GabrielHCataldo/go-logger/logger"

)

func main() {

    err := simple()

    logger.Info("simple err:", err)

    logger.Info("simple err msg:", errors.Details(err).GetMessage())

    logger.Info("simple err file:", errors.Details(err).GetFile())

    logger.Info("simple err line:", errors.Details(err).GetLine())

    logger.Info("simple err func:", errors.Details(err).GetFuncName())

    errors.Details(err).PrintCause()

    errors.Details(err).PrintStackTrace()

}

func simple() error {

    return errors.New("error by message with any value", 2, true)

}

```

Output:

    [INFO 2024/01/26 10:16:38] _example/main.go:12: simple err: [CAUSE]: (_example/main.go:25) simple: error by message with any value 2 true [STACK]:

    goroutine 1 [running]:

    runtime/debug.Stack()

        /Users/gabrielcataldo/go/go1.21.3/src/runtime/debug/stack.go:24 +0x64

    github.com/GabrielHCataldo/go-errors/errors.New({0x1400039fd18?, 0x0?, 0x1400039fc38?})

        /Users/gabrielcataldo/Innovfor/GabrielHCataldo/go-errors/errors/errors.go:31 +0xe0

    main.simple(...)

        /Users/gabrielcataldo/Innovfor/GabrielHCataldo/go-errors/_example/main.go:25

    main.main()

        /Users/gabrielcataldo/Innovfor/GabrielHCataldo/go-errors/_example/main.go:11 +0x88

    [INFO 2024/01/26 10:16:38] _example/main.go:12: simple err msg: error by message with any value 2 true

    [INFO 2024/01/26 10:16:38] _example/main.go:13: simple err file: _example/main.go

    [INFO 2024/01/26 10:16:38] _example/main.go:14: simple err line: 25

    [INFO 2024/01/26 10:16:38] _example/main.go:15: simple err func: simple

    [ERROR 2024/01/26 10:16:38] _example/main.go:16: (_example/main.go:25) simple: error by message with any value 2 true

    [ERROR 2024/01/26 10:16:38] _example/main.go:17: goroutine 1 [running]:

How to contribute

------

Make a pull request, or if you find a bug, open it

an Issues.

License

-------

Distributed under MIT license, see the license file within the code for more details.