https://github.com/task4233/dl
The logger not committed to Git for debug
https://github.com/task4233/dl
debug go golang logger logging
Last synced: 5 months ago
JSON representation
The logger not committed to Git for debug
- Host: GitHub
- URL: https://github.com/task4233/dl
- Owner: task4233
- License: mit
- Created: 2022-03-16T03:51:16.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-06-01T22:45:44.000Z (about 3 years ago)
- Last Synced: 2024-06-20T12:51:50.046Z (almost 2 years ago)
- Topics: debug, go, golang, logger, logging
- Language: Go
- Homepage:
- Size: 3.13 MB
- Stars: 25
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
dl - The logger not committed to Git for debug
======
[](https://pkg.go.dev/github.com/task4233/dl/v2)
[](https://github.com/task4233/dl/actions/workflows/ci.yml)
[](https://goreportcard.com/report/github.com/task4233/dl)
[](https://codecov.io/gh/task4233/dl)
[](LICENSE)
## Description
Who doesn't write wrong codes? No one.
Then, programs don't work well, and developers write logs for debug to understand what happens.
However, some developers forget to delete their logs after resolving the problem and push their codes. In the worse case, the logs might be released.
**dl** is developed to resolve their problems.
## Features
- **Logging package for debug in Go**
- [`dl` provides wrapping function for **logr.Logger**](https://pkg.go.dev/github.com/task4233/dl/v2#NewLogger).
- **Command for parallel Sweeping all functions of this package**
- **Command for installing git hooks and .gitignore**
## Installation
### Go 1.17 or earlier
It doesn't contain a generics feature.
```bash
$ go install github.com/task4233/dl/cmd/dl@v1
```
### Go 1.18
```bash
$ go install github.com/task4233/dl/v2/cmd/dl@main
```
## Usage
1. debug your codes with `dl` package
[Playground](https://go.dev/play/p/Et8JfM-gxZ-)
```go
package main
import (
"os"
"github.com/task4233/dl/v2"
)
type U[T any] []T
func (t U[T]) append(v T) {
t = append(t, v)
// debug
dl.Info(t)
}
func (t U[T]) change(v T) {
t[0] = v
// debug
dl.FInfo(os.Stdout, t)
}
func main() {
t := U[int]([]int{1, 3})
t.append(5)
t.change(5)
}
// Output:
// [DeLog] info: main.U[int]{1, 3, 5} (main.U[int]) prog.go:13
// [DeLog] info: main.U[int]{5, 3} (main.U[int]) prog.go:18
```
2. Install dl
```bash
$ dl init .
```
3. Just commit
- `delog` is used in the file.
```bash
$ cat main.go
package main
import (
"os"
"github.com/task4233/dl/v2"
)
type U[T any] []T
func (t U[T]) append(v T) {
t = append(t, v)
// debug
dl.Info(t)
}
func (t U[T]) change(v T) {
t[0] = v
// debug
dl.FInfo(os.Stdout, t)
}
func main() {
t := U[int]([]int{1, 3})
t.append(5)
t.change(5)
}
```
- invoke `$ git commit`
```bash
$ git add main.go
$ git commit -m "feat: add main.go"
remove dl from main.go # automatically removed
[master 975ecf9] feat: add main.go
1 file changed, 12 insertions(+), 21 deletions(-)
rewrite main.go (91%)
```
- `delog` is removed automatically
```bash
$ git diff HEAD^
diff --git a/main.go b/main.go
index 90a78bd..0e28e8a 100644
--- a/main.go
+++ b/main.go
@@ -0,0 +1,27 @@
+package main
+
+import (
+ "os"
+
+ "github.com/task4233/dl/v2"
+)
+
+type U[T any] []T
+
+func (t U[T]) append(v T) {
+ t = append(t, v)
+ // debug
+
+}
+
+func (t U[T]) change(v T) {
+ t[0] = v
+ // debug
+
+}
+
+func main() {
+ t := U[int]([]int{1, 3})
+ t.append(5)
+ t.change(5)
+}
```
- removed `delog` codes are restored(not commited)
```bash
$ cat main.go
package main
import (
"os"
"github.com/task4233/dl/v2"
)
type U[T any] []T
func (t U[T]) append(v T) {
t = append(t, v)
// debug
dl.Info(t)
}
func (t U[T]) change(v T) {
t[0] = v
// debug
dl.FInfo(os.Stdout, t)
}
func main() {
t := U[int]([]int{1, 3})
t.append(5)
t.change(5)
}
```
### Remove dl from GitHooks
```bash
$ dl remove .
```
## Contribution
Please feel free to make [issues](https://github.com/task4233/dl/issues/new/choose) and pull requests.
## Author
[task4233](https://github.com/task4233)