The highest tagged major version is
README
¶
dl(Debug x Log) - The instant logger package for debug
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
- Command for Sweeping all functions of this package
- Command for installing git hooks and .gitignore
Installation
Go1.18
$ go install github.com/task4233/dl/cmd/dl@latest
Use Case
Debug
package main
import (
"os"
"github.com/task4233/dl"
)
type U[T any] []T
func (t U[T]) append(v T) {
t = append(t, v)
dl.Info(t)
}
func (t U[T]) change(v T) {
t[0] = v
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
Adds dl into Git hooks
- Please run commands below to install dl in your Git repository.
$ dl init .
- Just commit
delogis used in the file.
$ cat main.go
package main
import (
"fmt"
"github.com/task4233/dl"
)
func SayHi[T any](v T) {
dl.Printf("Type: %T, v: %v\n", v, v) // This statement can be removed by `$ dl clean main.go`
fmt.Println("Hi, ", v)
}
func main() {
SayHi("hoge")
}
- invoke
$ git commit
$ 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%)
delogis removed automatically
$ git diff HEAD^
diff --git a/main.go b/main.go
index 90a78bd..0e28e8a 100644
--- a/main.go
+++ b/main.go
@@ -1,21 +1,12 @@
package main
+import (
+ "fmt"
+)
+func SayHi[T any](v T) {
+ fmt.Println("Hi, ", v)
+}
func main() {
+ SayHi("hoge")
}
- removed
delogcodes are restored(not commited)
$ cat main.go
package main
import (
"fmt"
"github.com/task4233/dl"
)
func SayHi[T any](v T) {
dl.Printf("Type: %T, v: %v\n", v, v) // This statement can be removed by `$ dl clean main.go`
fmt.Println("Hi, ", v)
}
func main() {
SayHi("hoge")
}
Remove dl from GitHooks
$ dl remove .
Contribution
Please feel free to make issues and pull requests.
Author
Documentation
¶
Overview ¶
Example ¶
package main
import (
"fmt"
"os"
"github.com/go-logr/logr"
"github.com/go-logr/zapr"
"github.com/task4233/dl"
"go.uber.org/zap"
)
func main() {
num := 123
name := "dl"
type MyInt int
var myNum MyInt = 123
dl.Fprintln(os.Stdout, "num: ", num)
dl.Println("num: ", num)
dl.Fprintf(os.Stdout, "name: %s\n", name)
dl.Printf("name: %s", name)
dl.FInfo(os.Stdout, myNum)
dl.Info(myNum)
zapLog, err := zap.NewDevelopment()
if err != nil {
panic(fmt.Sprintf("who watches the watchmen (%v)?", err))
}
var log logr.Logger = zapr.NewLogger(zapLog)
dlr := dl.NewLogger(&log)
dlr.Info("Info: ", "num", num)
}
Output: num: 123 name: dl [DeLog] info: 123 (dl_test.MyInt) log_example_test.go:23
Index ¶
- func FInfo[T any](w io.Writer, v T) (int, error)
- func Fprintf(w io.Writer, format string, v ...any) (int, error)
- func Fprintln(w io.Writer, v ...any) (int, error)
- func Info[T any](v T) (int, error)
- func Printf(format string, v ...any) (int, error)
- func Println(v ...any) (int, error)
- type Clean
- type Cmd
- type DeLog
- type Init
- type IntHeap
- type Logger
- type Remove
- type Restore
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Fprintf ¶
Fprintf formats according to a format specifier and writes to w. Arguments are handled in the manner of fmt.FPrintf.
func Fprintln ¶
Fprintln formats using the default formats for its operands and writes to w. Spaces are always added between operands and a newline is appended. Arguments are handled in the manner of fmt.FPrintln.
Types ¶
type Clean ¶ added in v0.5.5
type Clean struct {
// contains filtered or unexported fields
}
func (*Clean) Evacuate ¶ added in v0.5.5
Evacuate copies ".go" files to under ".dl" directory. This method requires ".dl" directory to exist. This method doesn't allow to invoke with a file included in `excludeFiles`.
Source Files
Directories