Version 1.2.6

.github/workflows/ci.yml

@@ -5,9 +5,22 @@ on:
     branches: [master, develop]
   pull_request:
     branches: [master]
-
-env:
-  SRC_DIR: src/github.com/${{ github.repository }}
+  workflow_dispatch:
+    inputs:
+      force_run:
+        description: 'Force workflow run'
+        required: true
+        type: choice
+        options: [yes, no]
+
+permissions:
+  actions: read
+  contents: read
+  statuses: write
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
 
 jobs:
   Go:
@@ -16,23 +29,33 @@ jobs:
 
     strategy:
       matrix:
-        go: [ '1.19.x', '1.20.x' ]
+        go: [ '1.21.x', '1.22.x' ]
 
     steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
       - name: Set up Go
-        uses: actions/setup-go@v3
+        uses: actions/setup-go@v5
         with:
           go-version: ${{ matrix.go }}
 
-      - name: Checkout
-        uses: actions/checkout@v3
-        with:
-          path: ${{env.SRC_DIR}}
-
       - name: Download dependencies
-        working-directory: ${{env.SRC_DIR}}
         run: make deps
 
       - name: Build binary
-        working-directory: ${{env.SRC_DIR}}
         run: make all
+
+  Typos:
+    name: Typos
+    runs-on: ubuntu-latest
+
+    needs: Go
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Check spelling
+        continue-on-error: true
+        uses: crate-ci/typos@master

.github/workflows/codeql.yml

@@ -20,14 +20,14 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
       with:
         fetch-depth: 2
 
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v2
+      uses: github/codeql-action/init@v3
       with:
         languages: go
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v2
+      uses: github/codeql-action/analyze@v3

.typos.toml

@@ -0,0 +1,2 @@
+[files]
+extend-exclude = ["go.sum"]

Makefile

@@ -1,6 +1,6 @@
 ################################################################################
 
-# This Makefile generated by GoMakeGen 2.2.0 using next command:
+# This Makefile generated by GoMakeGen 2.3.0 using next command:
 # gomakegen --mod .
 #
 # More info: https://kaos.sh/gomakegen
@@ -13,6 +13,7 @@ ifdef VERBOSE ## Print verbose information (Flag)
 VERBOSE_FLAG = -v
 endif
 
+COMPAT ?= 1.18
 MAKEDIR = $(dir $(realpath $(firstword $(MAKEFILE_LIST))))
 GITREV ?= $(shell test -s $(MAKEDIR)/.git && git rev-parse --short HEAD)
 
@@ -50,7 +51,7 @@ else
 endif
 
 ifdef COMPAT ## Compatible Go version (String)
-	go mod tidy $(VERBOSE_FLAG) -compat=$(COMPAT)
+	go mod tidy $(VERBOSE_FLAG) -compat=$(COMPAT) -go=$(COMPAT)
 else
 	go mod tidy $(VERBOSE_FLAG)
 endif
@@ -94,6 +95,6 @@ help: ## Show this info
 		| sed 's/ifdef //' \
 		| awk 'BEGIN {FS = " .*?## "}; {printf "  \033[32m%-14s\033[0m %s\n", $$1, $$2}'
 	@echo -e ''
-	@echo -e '\033[90mGenerated by GoMakeGen 2.2.0\033[0m\n'
+	@echo -e '\033[90mGenerated by GoMakeGen 2.3.0\033[0m\n'
 
 ################################################################################

README.md

@@ -18,7 +18,7 @@
 
 #### From source
 
-To build the MDToc from scratch, make sure you have a working Go 1.18+ workspace ([instructions](https://golang.org/doc/install)), then:
+To build the MDToc from scratch, make sure you have a working Go 1.18+ workspace ([instructions](https://go.dev/doc/install)), then:
 
 ```
 go install github.com/essentialkaos/mdtoc

cli/cli.go

@@ -20,22 +20,23 @@ import (
 	"github.com/essentialkaos/ek/v12/mathutil"
 	"github.com/essentialkaos/ek/v12/options"
 	"github.com/essentialkaos/ek/v12/strutil"
+	"github.com/essentialkaos/ek/v12/support"
+	"github.com/essentialkaos/ek/v12/support/deps"
+	"github.com/essentialkaos/ek/v12/terminal/tty"
 	"github.com/essentialkaos/ek/v12/usage"
 	"github.com/essentialkaos/ek/v12/usage/completion/bash"
 	"github.com/essentialkaos/ek/v12/usage/completion/fish"
 	"github.com/essentialkaos/ek/v12/usage/completion/zsh"
 	"github.com/essentialkaos/ek/v12/usage/man"
 	"github.com/essentialkaos/ek/v12/usage/update"
-
-	"github.com/essentialkaos/mdtoc/cli/support"
 )
 
 // ////////////////////////////////////////////////////////////////////////////////// //
 
 // App info
 const (
 	APP  = "MDToc"
-	VER  = "1.2.5"
+	VER  = "1.2.6"
 	DESC = "Utility for generating table of contents for markdown files"
 )
 
@@ -72,7 +73,7 @@ var optMap = options.Map{
 	OPT_HTML:      {Type: options.BOOL},
 	OPT_NO_COLOR:  {Type: options.BOOL},
 	OPT_HELP:      {Type: options.BOOL},
-	OPT_VER:       {Type: options.BOOL},
+	OPT_VER:       {Type: options.MIXED},
 
 	OPT_VERB_VER:     {Type: options.BOOL},
 	OPT_COMPLETION:   {},
@@ -86,6 +87,8 @@ var badgeRegExp = regexp.MustCompile(`\[!\[[^\]]*\]\((.*?)\s*("(?:.*[^"])")?\s*\
 
 // Init is main function
 func Init(gitRev string, gomod []byte) {
+	preConfigureUI()
+
 	args, errs := options.Parse(optMap)
 
 	if len(errs) != 0 {
@@ -100,17 +103,21 @@ func Init(gitRev string, gomod []byte) {
 
 	switch {
 	case options.Has(OPT_COMPLETION):
-		os.Exit(genCompletion())
+		os.Exit(printCompletion())
 	case options.Has(OPT_GENERATE_MAN):
-		os.Exit(genMan())
+		printMan()
+		os.Exit(0)
 	case options.GetB(OPT_VER):
-		showAbout(gitRev)
+		genAbout(gitRev).Print(options.GetS(OPT_VER))
 		os.Exit(0)
 	case options.GetB(OPT_VERB_VER):
-		support.ShowSupportInfo(APP, VER, gitRev, gomod)
+		support.Collect(APP, VER).
+			WithRevision(gitRev).
+			WithDeps(deps.Extract(gomod)).
+			Print()
 		os.Exit(0)
 	case options.GetB(OPT_HELP):
-		showUsage()
+		genUsage().Print()
 		os.Exit(0)
 	}
 
@@ -120,7 +127,7 @@ func Init(gitRev string, gomod []byte) {
 		file = findProperReadme()
 
 		if file == "" {
-			showUsage()
+			genUsage().Print()
 			os.Exit(0)
 		}
 	} else {
@@ -131,6 +138,13 @@ func Init(gitRev string, gomod []byte) {
 	process(file)
 }
 
+// preConfigureUI preconfigures UI based on information about user terminal
+func preConfigureUI() {
+	if !tty.IsTTY() {
+		fmtc.DisableColors = true
+	}
+}
+
 // configureUI configures user interface
 func configureUI() {
 	if options.GetB(OPT_NO_COLOR) {
@@ -150,20 +164,10 @@ func findProperReadme() string {
 
 // checkFile checks markdown file before processing
 func checkFile(file string) {
-	if !fsutil.IsExist(file) {
-		printErrorAndExit("Can't read file %s - file does not exist", file)
-	}
-
-	if !fsutil.IsRegular(file) {
-		printErrorAndExit("Can't read file %s - is not a file", file)
-	}
+	err := fsutil.ValidatePerms("FRS", file)
 
-	if !fsutil.IsReadable(file) {
-		printErrorAndExit("Can't read file %s - file is not readable", file)
-	}
-
-	if !fsutil.IsNonEmpty(file) {
-		printErrorAndExit("Can't read file %s - file is empty", file)
+	if err != nil {
+		printErrorAndExit(err.Error())
 	}
 }
 
@@ -316,7 +320,7 @@ func makeLink(text string) string {
 	result := text
 
 	result = strings.TrimLeft(result, "# ")
-	result = strings.Replace(result, " ", "-", -1)
+	result = strings.ReplaceAll(result, " ", "-")
 	result = strings.ToLower(result)
 	result = strings.Join(anchorRegExp.FindAllString(result, -1), "")
 
@@ -337,7 +341,7 @@ func parseHeaderText(text string) (string, int) {
 func removeMarkdownTags(header string) string {
 	for _, r := range "`_*~" {
 		if strings.Count(header, string(r))%2 == 0 {
-			header = strings.Replace(header, string(r), "", -1)
+			header = strings.ReplaceAll(header, string(r), "")
 		}
 	}
 
@@ -379,52 +383,40 @@ func printWarn(f string, a ...interface{}) {
 	fmtc.Fprintf(os.Stderr, "{y}"+f+"{!}\n", a...)
 }
 
-// printErrorAndExit prints error mesage and exit with exit code 1
+// printErrorAndExit prints error message and exit with exit code 1
 func printErrorAndExit(f string, a ...interface{}) {
 	printError(f, a...)
 	os.Exit(1)
 }
 
 // ////////////////////////////////////////////////////////////////////////////////// //
 
-// showUsage prints usage info
-func showUsage() {
-	genUsage().Render()
-}
-
-// showAbout prints info about version
-func showAbout(gitRev string) {
-	genAbout(gitRev).Render()
-}
-
-// genCompletion generates completion for different shells
-func genCompletion() int {
+// printCompletion prints completion for given shell
+func printCompletion() int {
 	info := genUsage()
 
 	switch options.GetS(OPT_COMPLETION) {
 	case "bash":
-		fmt.Printf(bash.Generate(info, "mdtoc"))
+		fmt.Print(bash.Generate(info, "mdtoc"))
 	case "fish":
-		fmt.Printf(fish.Generate(info, "mdtoc"))
+		fmt.Print(fish.Generate(info, "mdtoc"))
 	case "zsh":
-		fmt.Printf(zsh.Generate(info, optMap, "mdtoc"))
+		fmt.Print(zsh.Generate(info, optMap, "mdtoc"))
 	default:
 		return 1
 	}
 
 	return 0
 }
 
-// genMan generates man page
-func genMan() int {
+// printMan prints man page
+func printMan() {
 	fmt.Println(
 		man.Generate(
 			genUsage(),
 			genAbout(""),
 		),
 	)
-
-	return 0
 }
 
 // genUsage generates usage info
@@ -448,17 +440,17 @@ func genUsage() *usage.Info {
 // genAbout generates info about version
 func genAbout(gitRev string) *usage.About {
 	about := &usage.About{
-		App:           APP,
-		Version:       VER,
-		Desc:          DESC,
-		Year:          2006,
-		Owner:         "ESSENTIAL KAOS",
-		License:       "Apache License, Version 2.0 <https://www.apache.org/licenses/LICENSE-2.0>",
-		UpdateChecker: usage.UpdateChecker{"essentialkaos/mdtoc", update.GitHubChecker},
+		App:     APP,
+		Version: VER,
+		Desc:    DESC,
+		Year:    2006,
+		Owner:   "ESSENTIAL KAOS",
+		License: "Apache License, Version 2.0 <https://www.apache.org/licenses/LICENSE-2.0>",
 	}
 
 	if gitRev != "" {
 		about.Build = "git:" + gitRev
+		about.UpdateChecker = usage.UpdateChecker{"essentialkaos/mdtoc", update.GitHubChecker}
 	}
 
 	return about