Fix code formatting issues from PR #12

.github/workflows/README.md

@@ -0,0 +1,55 @@
+# CI/CD Workflows
+
+This directory contains GitHub Actions workflows for the go-syspkg project.
+
+## Workflows
+
+### 1. Lint and Format (`lint.yml`)
+Runs on every push and pull request to ensure code quality:
+- **gofmt**: Checks code formatting
+- **go vet**: Reports suspicious constructs
+- **golangci-lint**: Comprehensive linting with multiple linters
+- **go mod tidy**: Ensures go.mod and go.sum are up to date
+
+### 2. Test (`test.yml`)
+Runs comprehensive tests across multiple platforms:
+- **OS Matrix**: Ubuntu and macOS
+- **Go Versions**: 1.21, 1.22, 1.23
+- **Coverage**: Uploads test coverage to Codecov
+- **Race Detection**: Runs tests with race detector enabled
+
+## Local Development
+
+### Running Checks Locally
+```bash
+# Format code
+make format
+
+# Check formatting and run linters
+make check
+
+# Run specific checks
+gofmt -l .                    # List files that need formatting
+go vet ./...                  # Run go vet
+golangci-lint run            # Run all linters
+```
+
+### Pre-commit Hooks
+Install pre-commit to run checks automatically before commits:
+```bash
+pip install pre-commit
+pre-commit install
+```
+
+## Configuration Files
+
+- `.golangci.yml`: Configures golangci-lint with enabled/disabled linters
+- `.pre-commit-config.yaml`: Defines pre-commit hooks
+- `Makefile`: Contains format and check targets
+
+## Adding New Checks
+
+To add new linting rules:
+1. Update `.golangci.yml` to enable/disable linters
+2. Update the `lint.yml` workflow if needed
+3. Test locally with `make check`

.github/workflows/lint.yml

@@ -0,0 +1,58 @@
+name: Lint and Format
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+permissions:
+  contents: read
+
+jobs:
+  lint:
+    name: Lint and Format Check
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Set up Go
+      uses: actions/setup-go@v5
+      with:
+        go-version: '1.21'
+        cache: true
+
+    - name: Install dependencies
+      run: |
+        go mod download
+        go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest
+
+    - name: Run gofmt
+      run: |
+        # Check if gofmt reports any formatting issues
+        if [ -n "$(gofmt -l .)" ]; then
+          echo "The following files need formatting:"
+          gofmt -l .
+          echo ""
+          echo "Please run 'gofmt -w .' to format your code"
+          exit 1
+        fi
+
+    - name: Run go vet
+      run: go vet ./...
+
+    - name: Run golangci-lint
+      run: golangci-lint run --timeout=5m
+
+    - name: Run go mod tidy check
+      run: |
+        go mod tidy
+        if [ -n "$(git status --porcelain)" ]; then
+          echo "go mod tidy produced changes:"
+          git diff
+          echo ""
+          echo "Please run 'go mod tidy' and commit the changes"
+          exit 1
+        fi

.github/workflows/test.yml

@@ -0,0 +1,44 @@
+name: Test
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    name: Test
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        go-version: ['1.21', '1.22', '1.23']
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Set up Go
+      uses: actions/setup-go@v5
+      with:
+        go-version: ${{ matrix.go-version }}
+        cache: true
+
+    - name: Install dependencies
+      run: go mod download
+
+    - name: Run tests
+      run: |
+        go test -v -race -coverprofile=coverage.txt -covermode=atomic ./...
+
+    - name: Upload coverage to Codecov
+      if: matrix.os == 'ubuntu-latest' && matrix.go-version == '1.21'
+      uses: codecov/codecov-action@v4
+      with:
+        file: ./coverage.txt
+        flags: unittests
+        name: codecov-umbrella

.gitignore

@@ -50,4 +50,4 @@ go.work
 
 bin/
 tmp/
-**/*.log
+**/*.log.dccache

.golangci.yml

@@ -0,0 +1,102 @@
+# golangci-lint configuration
+# https://golangci-lint.run/usage/configuration/
+
+run:
+  timeout: 5m
+  tests: true
+  exclude-dirs:
+    - vendor
+    - testdata
+    - testing
+
+linters:
+  enable:
+    # Default linters
+    - errcheck
+    - gosimple
+    - govet
+    - ineffassign
+    - staticcheck
+    - typecheck
+    - unused
+    # Additional linters
+    - gofmt
+    - goimports
+    - misspell
+    - unconvert
+    - gocyclo
+    - goprintffuncname
+    - gosec
+    - nakedret
+    - noctx
+    - nolintlint
+    - predeclared
+    - thelper
+    - tparallel
+    - unparam
+
+  disable:
+    - depguard
+    - dogsled
+    - dupl
+    - funlen
+    - gochecknoinits
+    - goconst
+    - gocritic
+    - gocognit
+    - lll
+    - nestif
+    - testpackage
+    - wrapcheck
+    - exhaustive
+    - exhaustruct
+    - nlreturn
+
+linters-settings:
+  gofmt:
+    simplify: true
+  goimports:
+    local-prefixes: github.com/bluet/syspkg
+  govet:
+    enable:
+      - shadow
+  misspell:
+    locale: US
+  gocyclo:
+    min-complexity: 20
+
+issues:
+  exclude-rules:
+    # Exclude some linters from running on tests files
+    - path: _test\.go
+      linters:
+        - gosec
+        - gocyclo
+
+    # Exclude shadow warning for common patterns
+    - linters:
+        - govet
+      text: "shadow: declaration of \"err\""
+
+    # Exclude misspelling in specific cases
+    - linters:
+        - misspell
+      text: "cancelled"
+
+    # Exclude unnecessary conversion in utils (string([]byte) is explicit)
+    - path: utils\.go
+      linters:
+        - unconvert
+      text: "unnecessary conversion"
+
+    # Exclude high cyclomatic complexity for main function
+    - path: cmd/syspkg/main\.go
+      linters:
+        - gocyclo
+      text: "cyclomatic complexity.*of func `main`"
+
+  # Maximum issues count per one linter
+  max-issues-per-linter: 50
+
+  # Maximum count of issues with the same text
+  max-same-issues: 10

.pre-commit-config.yaml

@@ -0,0 +1,21 @@
+# See https://pre-commit.com for more information
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-added-large-files
+      - id: check-merge-conflict
+
+  - repo: https://github.com/dnephin/pre-commit-golang
+    rev: v0.5.1
+    hooks:
+      - id: go-fmt
+      - id: go-vet
+      - id: go-imports
+      - id: go-cyclo
+        args: [-over=15]
+      - id: go-mod-tidy
+      - id: golangci-lint

Makefile

@@ -1,4 +1,4 @@
-.PHONY: all build build-all-arch test lint install-tools
+.PHONY: all build build-all-arch test lint format fmt check install-tools
 
 # Go parameters
 GOCMD=go
@@ -50,5 +50,38 @@ lint:
 	golangci-lint run
 	gofmt -s -w .
 
+format fmt:
+	@echo "Running gofmt..."
+	@gofmt -s -w .
+	@echo "Running goimports..."
+	@go install golang.org/x/tools/cmd/goimports@latest
+	@goimports -w -local github.com/bluet/syspkg .
+	@echo "Formatting complete!"
+
+check:
+	@echo "Checking code formatting..."
+	@if [ -n "$$(gofmt -l .)" ]; then \
+		echo "The following files need formatting:"; \
+		gofmt -l .; \
+		echo ""; \
+		echo "Run 'make format' to fix formatting"; \
+		exit 1; \
+	fi
+	@echo "Checking go mod tidy..."
+	@go mod tidy
+	@if [ -n "$$(git status --porcelain go.mod go.sum)" ]; then \
+		echo "go.mod or go.sum needs updating"; \
+		echo "Run 'go mod tidy' and commit the changes"; \
+		exit 1; \
+	fi
+	@echo "Running go vet..."
+	@go vet ./...
+	@echo "Running golangci-lint..."
+	@golangci-lint run
+	@echo "All checks passed!"
+
 install-tools:
 	$(GOINSTALL) github.com/golangci/golangci-lint/cmd/golangci-lint@latest
+
+# TODO: Add Docker testing targets when Dockerfiles are implemented
+# TODO: Add unit/integration test targets when build tags are added to test files

cmd/syspkg/main.go

@@ -22,11 +22,9 @@ func main() {
 	}
 
 	// Initialize syspkg and find available package managers.
-	s, err := syspkg.New(
-		syspkg.IncludeOptions(syspkg.IncludeOptions{
-			AllAvailable: true,
-		}),
-	)
+	s, err := syspkg.New(syspkg.IncludeOptions{
+		AllAvailable: true,
+	})
 	if err != nil {
 		fmt.Printf("Error while initializing syspkg: %+v\n", err)
 		os.Exit(1)