add macos target to Taskfile/makefile

update Logging section in README.

upd CHANGELOG

.github/workflows/golang-ci.yml

@@ -0,0 +1,30 @@
+name: CI
+
+on:
+  push:
+    branches: ['main']
+    paths:
+      - '**.go'
+  pull_request:
+    branches: ['main']
+    paths:
+      - '**.go'
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    if: github.event_name == 'pull_request'
+    timeout-minutes: 3
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 1
+      - name: Setup Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: '1.24'
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v9
+        with:
+          version: v2.6.0
+          args: --config .golangci.yml

.golangci.yml

@@ -0,0 +1,142 @@
+version: '2'
+
+run:
+  timeout: 3m
+  tests: true
+  go: '1.24'
+
+linters:
+  disable: [errcheck, errorlint, godot, revive, staticcheck]
+  enable:
+    # Default enabled linters
+    - errcheck # Check for unchecked errors
+    - govet # Go's built-in vetting tool
+    - ineffassign # Detect ineffectual assignments
+    - staticcheck # Advanced static analysis
+    - unused # Check for unused code
+    # Additional useful linters
+    - misspell # Detect common misspellings
+    - unparam # Check for unused function parameters
+    - gosec # Security checks
+    - asciicheck # Check for non-ASCII characters
+    - errname # Check error variable names
+    - godot # Check for missing periods in comments
+    - revive # Highly configurable linter for style and correctness
+    - gocritic # Detect code issues and suggest improvements
+    - gocyclo # Check for cyclomatic complexity
+    - dupl # Check for code duplication
+    - predeclared # Check for shadowing of predeclared identifiers
+    - copyloopvar # Check for loop variable capture in goroutines
+    - errorlint # Check for common mistakes in error handling
+    - goconst # Check for repeated strings that could be constants
+    - gosmopolitan # Check for non-portable code
+
+  settings:
+    misspell:
+      locale: UK
+
+    errcheck:
+      check-type-assertions: true
+      check-blank: true
+      exclude-functions:
+        - fmt.Fprintf
+        - fmt.Fprintln
+        - fmt.Printf
+        - fmt.Println
+        - fmt.Errorf
+
+    revive:
+      severity: warning
+      rules:
+        # Code quality and style
+        - name: exported
+          arguments:
+            - 'checkPrivateReceivers'
+            - 'sayRepetitiveInsteadOfStutters'
+        - name: var-naming
+        - name: package-comments
+        - name: range-val-in-closure
+        - name: time-naming
+        - name: context-as-argument
+        - name: context-keys-type
+        - name: dot-imports
+        - name: empty-block
+        - name: error-return
+        - name: error-strings
+        - name: error-naming
+        - name: if-return
+        - name: increment-decrement
+        - name: indent-error-flow
+        - name: receiver-naming
+        - name: redefines-builtin-id
+        - name: superfluous-else
+        - name: unexported-return
+        - name: unreachable-code
+        - name: unused-parameter
+        - name: var-declaration
+        - name: blank-imports
+        - name: range
+
+        # Disabled rules (can be enabled if needed)
+        # - name: line-length-limit
+        #   arguments: [120]
+        # - name: function-length
+        #   arguments: [50, 0]
+        # - name: cyclomatic
+        #   arguments: [10]
+
+    gosec:
+      excludes:
+        - G104 # Duplicated errcheck checks
+        - G115 # integer overflow conversion int -> uint32
+
+  exclusions:
+    warn-unused: false
+    rules:
+      # Exclude some linters from running on tests files.
+      - path: _test\.go
+        linters:
+          - gocyclo
+          - errcheck
+          - dupl
+          - gosec
+
+    paths:
+      - vendor
+
+# Formatters configuration
+formatters:
+  # Enable specific formatters
+  enable:
+    - gofumpt # Stricter gofmt alternative
+    - goimports # Organizes imports
+    - gci # Controls import order/grouping
+    - golines # Enforces line length
+
+  # Formatter-specific settings
+  settings:
+    goimports:
+      local-prefixes: [github.com/onyx-and-iris/q3rcon]
+
+    gci:
+      # Define import sections order
+      sections:
+        - standard # Standard library
+        - default # Everything else
+        - prefix(github.com/onyx-and-iris/q3rcon) # Current module
+
+    gofumpt:
+      extra-rules: true # Enable additional formatting rules
+
+  exclusions:
+    warn-unused: true
+
+    paths:
+      - vendor
+
+issues:
+  # Limit the number of same issues reported to avoid spam
+  max-same-issues: 50
+
+  # Limit the number of issues per linter to keep output manageable
+  max-issues-per-linter: 100

.goreleaser.yaml

@@ -46,6 +46,7 @@ changelog:
     exclude:
       - '^docs:'
       - '^test:'
+      - '^chore:'
 
 release:
   footer: >-

CHANGELOG.md

@@ -11,6 +11,19 @@ Before any major/minor/patch bump all unit tests will be run to verify they pass
 
 -   [x]
 
+# [0.3.0] - 2025-04-05
+
+### Changed
+
+-   `-loglevel` flag is now of type string. It accepts any one of trace, debug, info, warn, error, fatal or panic.
+    -   It defaults to warn.
+
+# [0.2.0] - 2025-02-03
+
+### Added
+
+-   If neither the interactive flag is passed or any command line arguments then a *rcon status* command will be run.
+
 # [0.1.0] - 2024-11-29
 
 ### Changed

README.md

@@ -109,7 +109,7 @@ Arguments following the flags will be sent as rcon commands. You may send multip
 
 Pass `interactive (-i shorthand)` flag to enable interactive mode, for example:
 
-```
+```bash
 q3rcon -h=localhost -p=30000 -r="rconpassword" -i
 ```
 
@@ -123,16 +123,31 @@ Since you can include the q3rcon package into your own package you can easily ma
 
 ## Logging
 
-Log level may be set by passing the `-l` flag with a number from 0 up to 6 where
+The `-loglevel` flag allows you to control the verbosity of the application's logging output. 
 
-0 = Panic, 1 = Fatal, 2 = Error, 3 = Warning, 4 = Info, 5 = Debug, 6 = Trace
+Acceptable values for this flag are:
 
-[status]: ./img/status.png
+- `trace`
-[mapname]: ./img/mapname.png
+- `debug`
+- `info`
+- `warn`
+- `error`
+- `fatal`
+- `panic`
+
+For example, to set the log level to `debug`, you can use:
+
+```bash
+q3rcon -p=28960 -r="rconpassword" -loglevel=debug -i
+```
+
+The default log level is `warn` if the flag is not specified.
 
 ## Further Notes
 
 This rcon client is fully compatible with the [Q3 Rcon Proxy][q3rcon-proxy] package.
 
 
+[status]: ./img/status.png
+[mapname]: ./img/mapname.png
 [q3rcon-proxy]: https://github.com/onyx-and-iris/q3rcon-proxy/tree/dev

Taskfile.yml

@@ -7,6 +7,7 @@ vars:
 
   WINDOWS: '{{.BIN_DIR}}/{{.PROGRAM}}_windows_amd64.exe'
   LINUX: '{{.BIN_DIR}}/{{.PROGRAM}}_linux_amd64'
+  MACOS: '{{.BIN_DIR}}/{{.PROGRAM}}_darwin_amd64'
   GIT_COMMIT:
     sh: git log -n 1 --format=%h
 
@@ -22,6 +23,7 @@ tasks:
     cmds:
       - task: build-windows
       - task: build-linux
+      - task: build-macos
 
   vet:
     desc: Vet the code
@@ -38,11 +40,19 @@ tasks:
     desc: Build the q3rcon project for Windows
     cmds:
       - GOOS=windows GOARCH=amd64 go build -o {{.WINDOWS}} -ldflags="-X main.Version={{.GIT_COMMIT}}" ./cmd/{{.PROGRAM}}/
+    internal: true
 
   build-linux:
     desc: Build the q3rcon project for Linux
     cmds:
       - GOOS=linux GOARCH=amd64 go build -o {{.LINUX}} -ldflags="-X main.Version={{.GIT_COMMIT}}" ./cmd/{{.PROGRAM}}/
+    internal: true
+
+  build-macos:
+    desc: Build the q3rcon project for macOS
+    cmds:
+      - GOOS=darwin GOARCH=amd64 go build -o {{.MACOS}} -ldflags="-X main.Version={{.GIT_COMMIT}}" ./cmd/{{.PROGRAM}}/
+    internal: true
 
   test:
     desc: Run tests

cmd/q3rcon/main.go

@@ -6,7 +6,6 @@ import (
 	"fmt"
 	"io"
 	"os"
-	"slices"
 	"strings"
 
 	"github.com/onyx-and-iris/q3rcon"
@@ -25,7 +24,7 @@ func main() {
 		port        int
 		rconpass    string
 		interactive bool
-		loglevel    int
+		loglevel    string
 	)
 
 	flag.StringVar(&host, "host", "localhost", "hostname of the gameserver")
@@ -38,13 +37,16 @@ func main() {
 	flag.BoolVar(&interactive, "interactive", false, "run in interactive mode")
 	flag.BoolVar(&interactive, "i", false, "run in interactive mode")
 
-	flag.IntVar(&loglevel, "loglevel", int(log.WarnLevel), "log level")
+	flag.StringVar(&loglevel, "loglevel", "warn", "log level")
-	flag.IntVar(&loglevel, "l", int(log.WarnLevel), "log level (shorthand)")
+	flag.StringVar(&loglevel, "l", "warn", "log level (shorthand)")
+
 	flag.Parse()
 
-	if slices.Contains(log.AllLevels, log.Level(loglevel)) {
+	level, err := log.ParseLevel(loglevel)
-		log.SetLevel(log.Level(loglevel))
+	if err != nil {
+		exitOnError(fmt.Errorf("invalid log level: %s", loglevel))
 	}
+	log.SetLevel(level)
 
 	if port < 1024 || port > 65535 {
 		exitOnError(fmt.Errorf("invalid port value, got: (%d) expected: in range 1024-65535", port))

go.mod

@@ -4,4 +4,4 @@ go 1.23.0
 
 require github.com/sirupsen/logrus v1.9.3
 
-require golang.org/x/sys v0.25.0 // indirect
+require golang.org/x/sys v0.34.0 // indirect

go.sum

@@ -9,8 +9,8 @@ github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+
 github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
 github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
 golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.25.0 h1:r+8e+loiHxRqhXVl6ML1nO3l1+oFoWbnlu2Ehimmi34=
+golang.org/x/sys v0.34.0 h1:H5Y5sJ2L2JRdyv7ROF1he/lPdvFsd0mJHFw2ThKHxLA=
-golang.org/x/sys v0.25.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
+golang.org/x/sys v0.34.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

internal/packet/request.go

@@ -3,6 +3,8 @@ package packet
 import (
 	"bytes"
 	"fmt"
+
+	log "github.com/sirupsen/logrus"
 )
 
 const bufSz = 512
@@ -29,5 +31,6 @@ func (r Request) Encode(cmd string) []byte {
 	r.buf.Reset()
 	r.buf.Write(r.Header())
 	r.buf.WriteString(fmt.Sprintf(" %s %s", r.password, cmd))
+	log.Tracef("Encoded request: %s", r.buf.String())
 	return r.buf.Bytes()
 }

makefile

@@ -5,24 +5,26 @@ BIN_DIR := bin
 
 WINDOWS=$(BIN_DIR)/$(PROGRAM)_windows_amd64.exe
 LINUX=$(BIN_DIR)/$(PROGRAM)_linux_amd64
+MACOS=$(BIN_DIR)/$(PROGRAM)_darwin_amd64
 VERSION=$(shell git log -n 1 --format=%h)
 
 .DEFAULT_GOAL := build
 
-.PHONY: fmt vet build windows linux test clean
+.PHONY: fmt vet build windows linux macos test clean
 fmt:        
 	$(GO) fmt ./...
 
 vet: fmt        
 	$(GO) vet ./...
 
-build: vet windows linux | $(BIN_DIR)
+build: vet windows linux macos | $(BIN_DIR)
 	@echo version: $(VERSION)
 
 windows: $(WINDOWS)
 
 linux: $(LINUX)
 
+macos: $(MACOS)
 
 $(WINDOWS):
 	env GOOS=windows GOARCH=amd64 go build -v -o $(WINDOWS) -ldflags="-s -w -X main.version=$(VERSION)"  ./cmd/$(PROGRAM)/
@@ -30,6 +32,9 @@ $(WINDOWS):
 $(LINUX):
 	env GOOS=linux GOARCH=amd64 go build -v -o $(LINUX) -ldflags="-s -w -X main.version=$(VERSION)"  ./cmd/$(PROGRAM)/
 
+$(MACOS):
+	env GOOS=darwin GOARCH=amd64 go build -v -o $(MACOS) -ldflags="-s -w -X main.version=$(VERSION)"  ./cmd/$(PROGRAM)/
+
 test:
 	$(GO) test ./...