Use mise

Author: FollowTheProcess

codecov.yml .github/codecov.ymlcodecov.yml renamed to .github/codecov.yml

@@ -34,8 +34,8 @@
 # Typos
 !.typos.toml
 
-# Task
-!Taskfile.yml
+# mise
+!mise.toml
 
 # Copier
 !.copier-answers.yml

.gitignore

@@ -22,7 +22,7 @@ use everywhere across all my Go projects (which are mostly command line applicat
 
 ## Installation
 
-```shell
+```bash
 go get go.followtheprocess.codes/log@latest
 ```
 
@@ -46,6 +46,7 @@ func main() {
     logger.Info(
       "Some information here",
       // Yep! You use slog.Attrs for key value pairs, why reinvent the wheel?
+      // ... says the guy who wrote a new Logger
       slog.Bool("really", true),
     )
     logger.Warn("Uh oh!")

README.md

@@ -40,7 +40,7 @@ const (
 type Logger struct {
 	w          io.Writer        // Where to write logs to
 	timeFunc   func() time.Time // A function to get the current time, defaults to [time.Now] (with UTC)
-	mu         *sync.Mutex      // Protects w
+	mu         *sync.Mutex      // Protects w, pointer so that child loggers share the same mutex
 	timeFormat string           // The time format layout string, defaults to [time.RFC3339]
 	prefix     string           // Optional prefix to prepend to all log messages
 	attrs      []slog.Attr      // Persistent key value pairs
@@ -130,7 +130,8 @@ func (l *Logger) log(level Level, msg string, attrs ...slog.Attr) {
 	buf.WriteString(level.String())
 
 	if l.prefix != "" {
-		buf.WriteString(" " + prefixStyle.Text(l.prefix))
+		buf.WriteString(" ")
+		buf.WriteString(prefixStyle.Text(l.prefix))
 	}
 
 	buf.WriteByte(':')

Taskfile.yml

@@ -0,0 +1,70 @@
+# https://mise.jdx.dev
+[tools]
+golangci-lint = "latest"
+typos = "latest"
+vhs = "latest"
+"go:golang.org/x/pkgsite/cmd/pkgsite" = "latest"
+
+[vars]
+cov_data = "coverage.out"
+
+[tasks.tidy]
+description = "Tidy dependencies in go.mod and go.sum"
+sources = ["**/*.go", "go.mod", "go.sum"]
+run = "go mod tidy"
+
+[tasks.fmt]
+description = "Run go fmt on all source files"
+sources = ["**/*.go", ".golangci.yml"]
+run = "golangci-lint fmt ./..."
+
+[tasks.demo]
+description = "Render the demo gifs"
+sources = ["docs/src/*.tape", "**/*.go"]
+run = 'for file in ./docs/src/*.tape; do vhs "$file"; done'
+
+[tasks.test]
+description = "Run the test suite"
+sources = ["**/*.go", "go.mod", "go.sum", "**/testdata/**/*"]
+# -race needs CGO
+env = { CGO_ENABLED = "1" }
+run = "go test -race ./..."
+
+[tasks.bench]
+description = "Run all project benchmarks"
+sources = ["**/*.go"]
+run = "go test ./... -run None -benchmem -bench ."
+
+[tasks.lint]
+description = "Run linting"
+depends = ["fmt"]
+sources = ["**/*.go", ".golangci.yml"]
+run = ["golangci-lint run ./...", "typos"]
+
+[tasks.doc]
+description = "Render the pkg docs locally"
+run = "pkgsite -open"
+
+[tasks.cov]
+description = "Calculate test coverage and render the html"
+outputs = ["{{vars.cov_data}}"]
+run = [
+  "go test -race -cover -covermode atomic -coverprofile {{vars.cov_data}} ./...",
+  "go tool cover -html {{vars.cov_data}}",
+]
+
+[tasks.check]
+description = "Run tests and linting in one"
+run = ["mise run test", "mise run lint"]
+
+[tasks.sloc]
+description = "Print lines of code"
+run = "fd . -e go | xargs wc -l | sort -nr | head"
+
+[tasks.clean]
+description = "Remove build artifacts and other clutter"
+run = ["go clean ./...", "rm -rf {{vars.cov_data}}"]
+
+[tasks.update]
+description = "Updates dependencies in go.mod and go.sum"
+run = ["go get -u ./...", "go mod tidy"]