chores: maintenance (#90)

* chores: maintenance

- updated release pipeline
- fixed lints (suppresed)
- `make` removed
- readme re-arranged and changed

* fix: updated job name

* fix: error lint

Author: butuzov

.editorconfig

@@ -16,9 +16,6 @@ trim_trailing_whitespace = true            # no extra sapces at the end of lines
 indent_style = tab
 indent_size = 2
 
-[{Makefile,makefile}]                      # CMake
-indent_style = tab
-
 [*.md]                                     # Markdown
 trim_trailing_whitespace = true
 max_line_length = 100

.github/workflows/main.yaml

@@ -25,8 +25,10 @@ jobs:
         with:
           go-version: ${{ matrix.go }}
 
-      - run: make build
-      - run: make tests
+      # ---  🚀 Dev Pipiline -----------------------------------------------------------------------
+      - uses: go-task/setup-task@v2
+      - run: task build
+      - run: task tests
 
       - name: Install goveralls
         if: matrix.go == 'stable'
@@ -38,7 +40,7 @@ jobs:
           COVERALLS_TOKEN: ${{ secrets.github_token }}
         run: goveralls -coverprofile=coverage.cov -service=github
 
-  GolangCILinter:
+  Linter:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v6

.github/workflows/release.yaml

@@ -23,4 +23,4 @@ jobs:
         with:
           args: release --clean
         env:
-          GITHUB_TOKEN: ${{ secrets.GORELEASER_GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Makefile

@@ -1,4 +1,4 @@
-version: '3'
+version: "3"
 
 tasks:
     default: task --list-all
@@ -7,67 +7,81 @@ tasks:
     watcher:
         desc: watcher
         sources:
-        - ./**/*.go
+            - ./**/*.go
         method: timestamp
         cmds:
-        - task: lints
-        - task: test-summary
-        - task: build-race
+            - task: lints
+            - task: test-summary
+            - task: build-race
 
     # Generating assets ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     generate:
         desc: Generate Assets
         sources:
-        - ./checkers_*.go
-        - ./cmd/internal/**/*.go
+            - ./checkers_*.go
+            - ./cmd/internal/**/*.go
         method: timestamp
         cmds:
-        - task generate-mirror-table
-        - task generate-tests
+            - task generate-mirror-table
+            - task generate-tests
 
     generate-mirror-table:
         desc: Generates Assets at testdata
-        cmd: make generate-mirror-table
+        cmd: go run ./cmd/internal/mirror-table/ > ./MIRROR_FUNCS.md
 
     generate-tests:
         desc: Generate Asset MIRROR_FUNCS.md
-        cmd: make generate-tests
+        cmd: go run ./cmd/internal/tests/ ./testdata
 
     # Run Tests ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     tests:
         desc: Run Tests
-        cmd: make tests
+        cmd: |
+            go test -v -count=1 -race \
+                -failfast \
+                -parallel=2 \
+                -timeout=1m \
+                -covermode=atomic \
+                -coverpkg $(go list ./... | grep -v -E "cmd" | tr "\n" ",") \
+                -coverprofile=coverage.cov ./...
+
         ignore_error: true
 
     test-summary:
         desc: Run Tests (Summary)
-        cmd: make tests-summary
+        cmd: |
+            go test -v -count=1 -race \
+                -failfast \
+                -parallel=2 \
+                -timeout=1m \
+                -covermode=atomic \
+                -coverpkg $(go list ./... | grep -v -E "cmd" | tr "\n" ",") \
+                -coverprofile=coverage.cov --json ./... | tparse -all
         ignore_error: true
 
     testcase: go test -v -failfast -count=1 -run "TestAll/{{ .Case }}" ./...
 
     # Build Artifacts ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     build:
         desc: Build binary
-        cmd: make build
+        cmd: go build -trimpath -ldflags="-w -s" -o bin/mirror ./cmd/mirror/
 
     build-race:
         desc: Build binary with race flag
-        cmd: make build-race
+        cmd: go build -race -trimpath -ldflags="-w -s" -o bin/mirror ./cmd/mirror/
 
     install:
         desc: Install binary
-        cmd: make install
+        cmd: go install -trimpath -v -ldflags="-w -s" ./cmd/mirror
 
     # Linter ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-    lints:
-        cmd: make lints
+    lints: golangci-lint run --no-config ./...
 
     # Other
     cover:
         desc: Run Coverage
-        cmd: make cover
+        cmd: go tool cover -html=coverage.cov
 
     test-release:
         desc: Testing Release
-        cmd: make test-release
+        cmd: goreleaser release --snapshot --clean

Taskfile.yml

@@ -106,10 +106,10 @@ func GenerateTestFile(file string, pkgName string, Tests []string) error {
 	if err != nil {
 		return err
 	}
-	defer f.Close()
+	defer func() { _ = f.Close() }()
 
 	w := bufio.NewWriter(f)
-	defer w.Flush()
+	defer func() { _ = w.Flush() }()
 
 	return templates.ExecuteTemplate(w, "file.tmpl", struct {
 		Package string

cmd/internal/tests/main.go

@@ -31,20 +31,6 @@ func variate(variance string, oneIsString bool) []string {
 	for i := 0; i < len(variance); i++ {
 		var input string
 
-		// if out argument is in string we gonna take argument that is
-		if oneIsString {
-			input = `"foobar"`
-		} else {
-			input = `[]byte{'f','o','o','b','a','r'}`
-		}
-
-		if oneIsString && (variance[i] == '1') {
-			input = fmt.Sprintf(`%s(%s)`, "[]byte", input)
-		}
-		if !oneIsString && (variance[i] == '0') {
-			input = fmt.Sprintf(`%s(%s)`, "string", input)
-		}
-
 		if oneIsString {
 			// looking for string
 			if variance[i] == '1' {

cmd/internal/tests/support.go

@@ -141,7 +141,7 @@ func WrapType(info *types.Info) func(node ast.Expr) string {
 func WrapPrint(fSet *token.FileSet) func(ast.Node) []byte {
 	return func(node ast.Node) []byte {
 		var buf bytes.Buffer
-		printer.Fprint(&buf, fSet, node)
+		_ = printer.Fprint(&buf, fSet, node)
 		return buf.Bytes()
 	}
 }

internal/checker/checker.go

@@ -104,9 +104,9 @@ func (v *Violation) suggest(fSet *token.FileSet) []byte {
 	buf.WriteByte('(')
 	for idx := range v.callExpr.Args {
 		if arg, ok := v.arguments[idx]; ok {
-			printer.Fprint(&buf, fSet, arg)
+			_ = printer.Fprint(&buf, fSet, arg)
 		} else {
-			printer.Fprint(&buf, fSet, v.callExpr.Args[idx])
+			_ = printer.Fprint(&buf, fSet, v.callExpr.Args[idx])
 		}
 
 		if idx != len(v.callExpr.Args)-1 {
@@ -126,7 +126,7 @@ func (v *Violation) Diagnostic(fSet *token.FileSet) analysis.Diagnostic {
 	}
 
 	var buf bytes.Buffer
-	printer.Fprint(&buf, fSet, v.callExpr)
+	_ = printer.Fprint(&buf, fSet, v.callExpr)
 	noNl := bytes.IndexByte(buf.Bytes(), '\n') < 0
 
 	// Struct based fix.
@@ -177,7 +177,7 @@ func (v *Violation) Issue(fSet *token.FileSet) GolangIssue {
 
 	// original expression (useful for debug & required for replace)
 	var buf bytes.Buffer
-	printer.Fprint(&buf, fSet, v.callExpr)
+	_ = printer.Fprint(&buf, fSet, v.callExpr)
 	issue.Original = buf.String()
 
 	noNl := strings.IndexByte(issue.Original, '\n') < 0