Merge pull request #134 from essentialkaos/develop

Version 1.2.7

.github/dependabot.yml

@@ -14,6 +14,12 @@ updates:
       - "andyone"
     reviewers:
       - "andyone"
+    groups:
+      all:
+        applies-to: version-updates
+        update-types:
+          - "minor"
+          - "patch"
 
   - package-ecosystem: "github-actions"
     directory: "/"

Makefile

@@ -1,39 +1,40 @@
 ################################################################################
 
-# This Makefile generated by GoMakeGen 2.3.0 using next command:
+# This Makefile generated by GoMakeGen 3.0.2 using next command:
 # gomakegen --mod .
 #
 # More info: https://kaos.sh/gomakegen
 
 ################################################################################
 
-export GO111MODULE=on
-
 ifdef VERBOSE ## Print verbose information (Flag)
 VERBOSE_FLAG = -v
 endif
 
-COMPAT ?= 1.18
+COMPAT ?= 1.19
 MAKEDIR = $(dir $(realpath $(firstword $(MAKEFILE_LIST))))
 GITREV ?= $(shell test -s $(MAKEDIR)/.git && git rev-parse --short HEAD)
 
 ################################################################################
 
 .DEFAULT_GOAL := help
-.PHONY = fmt vet all clean deps update init vendor mod-init mod-update mod-download mod-vendor help
+.PHONY = fmt vet all install uninstall clean deps update init vendor mod-init mod-update mod-download mod-vendor help
 
 ################################################################################
 
 all: mdtoc ## Build all binaries
 
 mdtoc:
-	go build $(VERBOSE_FLAG) -ldflags="-X main.gitrev=$(GITREV)" mdtoc.go
+	@echo "Building mdtoc…"
+	@go build $(VERBOSE_FLAG) -ldflags="-X main.gitrev=$(GITREV)" mdtoc.go
 
 install: ## Install all binaries
-	cp mdtoc /usr/bin/mdtoc
+	@echo "Installing binaries…"
+	@cp mdtoc /usr/bin/mdtoc
 
 uninstall: ## Uninstall all binaries
-	rm -f /usr/bin/mdtoc
+	@echo "Removing installed binaries…"
+	@rm -f /usr/bin/mdtoc
 
 init: mod-init ## Initialize new module
 
@@ -44,57 +45,70 @@ update: mod-update ## Update dependencies to the latest versions
 vendor: mod-vendor ## Make vendored copy of dependencies
 
 mod-init:
+	@echo "[1/2] Modules initialization…"
 ifdef MODULE_PATH ## Module path for initialization (String)
-	go mod init $(MODULE_PATH)
+	@go mod init $(MODULE_PATH)
 else
-	go mod init
+	@go mod init
 endif
 
+	@echo "[2/2] Dependencies cleanup…"
 ifdef COMPAT ## Compatible Go version (String)
-	go mod tidy $(VERBOSE_FLAG) -compat=$(COMPAT) -go=$(COMPAT)
+	@go mod tidy $(VERBOSE_FLAG) -compat=$(COMPAT) -go=$(COMPAT)
 else
-	go mod tidy $(VERBOSE_FLAG)
+	@go mod tidy $(VERBOSE_FLAG)
 endif
 
 mod-update:
+	@echo "[1/4] Updating dependencies…"
 ifdef UPDATE_ALL ## Update all dependencies (Flag)
-	go get -u $(VERBOSE_FLAG) all
+	@go get -u $(VERBOSE_FLAG) all
 else
-	go get -u $(VERBOSE_FLAG) ./...
+	@go get -u $(VERBOSE_FLAG) ./...
 endif
 
+	@echo "[2/4] Stripping toolchain info…"
+	@grep -q 'toolchain ' go.mod && go mod edit -toolchain=none || :
+
+	@echo "[3/4] Dependencies cleanup…"
 ifdef COMPAT
-	go mod tidy $(VERBOSE_FLAG) -compat=$(COMPAT)
+	@go mod tidy $(VERBOSE_FLAG) -compat=$(COMPAT)
 else
-	go mod tidy $(VERBOSE_FLAG)
+	@go mod tidy $(VERBOSE_FLAG)
 endif
 
-	test -d vendor && rm -rf vendor && go mod vendor $(VERBOSE_FLAG) || :
+	@echo "[4/4] Updating vendored dependencies…"
+	@test -d vendor && rm -rf vendor && go mod vendor $(VERBOSE_FLAG) || :
 
 mod-download:
-	go mod download
+	@echo "Downloading dependencies…"
+	@go mod download
 
 mod-vendor:
-	rm -rf vendor && go mod vendor $(VERBOSE_FLAG)
+	@echo "Vendoring dependencies…"
+	@rm -rf vendor && go mod vendor $(VERBOSE_FLAG) || :
 
 fmt: ## Format source code with gofmt
-	find . -name "*.go" -exec gofmt -s -w {} \;
+	@echo "Formatting sources…"
+	@find . -name "*.go" -exec gofmt -s -w {} \;
 
 vet: ## Runs 'go vet' over sources
-	go vet -composites=false -printfuncs=LPrintf,TLPrintf,TPrintf,log.Debug,log.Info,log.Warn,log.Error,log.Critical,log.Print ./...
+	@echo "Running 'go vet' over sources…"
+	@go vet -composites=false -printfuncs=LPrintf,TLPrintf,TPrintf,log.Debug,log.Info,log.Warn,log.Error,log.Critical,log.Print ./...
 
 clean: ## Remove generated files
-	rm -f mdtoc
+	@echo "Removing built binaries…"
+	@rm -f mdtoc
 
 help: ## Show this info
 	@echo -e '\n\033[1mTargets:\033[0m\n'
 	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) \
-		| awk 'BEGIN {FS = ":.*?## "}; {printf "  \033[33m%-14s\033[0m %s\n", $$1, $$2}'
+		| awk 'BEGIN {FS = ":.*?## "}; {printf "  \033[33m%-9s\033[0m  %s\n", $$1, $$2}'
 	@echo -e '\n\033[1mVariables:\033[0m\n'
 	@grep -E '^ifdef [A-Z_]+ .*?## .*$$' $(abspath $(lastword $(MAKEFILE_LIST))) \
 		| sed 's/ifdef //' \
-		| awk 'BEGIN {FS = " .*?## "}; {printf "  \033[32m%-14s\033[0m %s\n", $$1, $$2}'
+		| awk 'BEGIN {FS = " .*?## "}; {printf "  \033[32m%-11s\033[0m  %s\n", $$1, $$2}'
 	@echo -e ''
-	@echo -e '\033[90mGenerated by GoMakeGen 2.3.0\033[0m\n'
+	@echo -e '\033[90mGenerated by GoMakeGen 3.0.2\033[0m\n'
 
 ################################################################################

README.md

@@ -1,14 +1,13 @@
-<p align="center"><a href="#readme"><img src="https://gh.kaos.st/mdtoc.svg"/></a></p>
+<p align="center"><a href="#readme"><img src=".github/images/card.svg"/></a></p>
 
 <p align="center">
   <a href="https://kaos.sh/w/mdtoc/ci"><img src="https://kaos.sh/w/mdtoc/ci.svg" alt="GitHub Actions CI Status" /></a>
   <a href="https://kaos.sh/w/mdtoc/codeql"><img src="https://kaos.sh/w/mdtoc/codeql.svg" alt="GitHub Actions CodeQL Status" /></a>
-  <a href="https://kaos.sh/r/mdtoc"><img src="https://kaos.sh/r/mdtoc.svg" alt="GoReportCard" /></a>
   <a href="https://kaos.sh/b/mdtoc"><img src="https://kaos.sh/b/196d721e-00ad-4dff-9032-9b5bbd11b723.svg" alt="Codebeat badge" /></a>
-  <a href="#license"><img src="https://gh.kaos.st/apache2.svg"></a>
+  <a href="#license"><img src=".github/images/license.svg"/></a>
 </p>
 
-<p align="center"><a href="#installation">Installation</a> • <a href="#usage">Usage</a> • <a href="#build-status">Build Status</a> • <a href="#contributing">Contributing</a> • <a href="#license">License</a></p>
+<p align="center"><a href="#installation">Installation</a> • <a href="#usage">Usage</a> • <a href="#ci-status">CI Status</a> • <a href="#contributing">Contributing</a> • <a href="#license">License</a></p>
 
 <br/>
 
@@ -18,10 +17,10 @@
 
 #### From source
 
-To build the MDToc from scratch, make sure you have a working Go 1.18+ workspace ([instructions](https://go.dev/doc/install)), then:
+To build the MDToc from scratch, make sure you have a working Go 1.21+ workspace ([instructions](https://go.dev/doc/install)), then:
 
 ```
-go install github.com/essentialkaos/mdtoc
+go install github.com/essentialkaos/mdtoc@latest
 ```
 
 #### Prebuilt binaries
@@ -34,30 +33,9 @@ bash <(curl -fsSL https://apps.kaos.st/get) mdtoc
 
 ### Usage
 
-```
-Usage: mdtoc {options} file
-
-Options
-
-  --flat, -f             Print flat (horizontal) ToC
-  --html, -H             Render HTML ToC instead Markdown (works with --flat)
-  --min-level, -m 1-6    Minimal header level
-  --max-level, -M 1-6    Maximum header level
-  --no-color, -nc        Disable colors in output
-  --help, -h             Show this help message
-  --version, -v          Show version
-
-Examples
-
-  mdtoc readme.md
-  Generate table of contents for readme.md
-
-  mdtoc -m 2 -M 4 readme.md
-  Generate table of contents for readme.md with 2-4 level headers
-
-```
+<img src=".github/images/usage.svg"/>
 
-### Build Status
+### CI Status
 
 | Branch | Status |
 |------------|--------|