Merge pull request #46 from LandonTClipp/options

Add options for walk constructor, improve CI/CD

Author: LandonTClipp

.github/workflows/testing.yml

@@ -0,0 +1,37 @@
+name: Go Test
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ macos-latest, ubuntu-latest]
+        go_vers: ['1.20']
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Set up Go
+        uses: actions/setup-go@v2
+        with:
+          go-version: ${{ matrix.go_vers }}
+
+      - name: Download dependencies
+        run: go mod download -x
+
+      - name: Test
+        run: make test.ci
+
+      - name: Upload coverage to codecov
+        uses: codecov/codecov-action@v2
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: ./coverage.txt
+          verbose: true

.gitignore

@@ -0,0 +1 @@
+coverage.txt

.golangci.yml

@@ -0,0 +1,28 @@
+linters:
+  # Disable all linters.
+  # Default: false
+  disable-all: true
+  # Enable specific linter
+  # https://golangci-lint.run/usage/linters/#enabled-by-default
+  enable:
+    - errcheck
+    - gosimple
+    - govet
+    - ineffassign
+    - staticcheck
+    - typecheck
+    - contextcheck
+    - durationcheck
+    - exportloopref
+    - gocheckcompilerdirectives
+    - gosec
+    - loggercheck
+    - nilerr
+    - prealloc
+    - predeclared
+    - reassign
+linters-settings:
+  staticcheck:
+    checks:
+    - all
+    - '-SA1024'

Makefile

@@ -0,0 +1,23 @@
+SHELL=bash
+
+.PHONY: all
+all: fmt mocks test install docker
+
+.PHONY: fmt
+fmt:
+	go fmt ./...
+
+.PHONY: test
+test:
+	go test -v -coverprofile=coverage.txt ./...
+
+.PHONY: test.ci
+test.ci: test fmt
+
+.PHONY: lint
+lint:
+	go run github.com/golangci/golangci-lint/cmd/golangci-lint@v1.52.2 run
+
+.PHONY: clean
+clean:
+	rm -rf mocks

walk.go

@@ -102,9 +102,63 @@ type Walk struct {
 	root *Path
 }
 
+type WalkOptsFunc func(config *WalkOpts)
+
+func WalkDepth(depth int) WalkOptsFunc {
+	return func(config *WalkOpts) {
+		config.Depth = depth
+	}
+}
+
+func WalkAlgorithm(algo Algorithm) WalkOptsFunc {
+	return func(config *WalkOpts) {
+		config.Algorithm = algo
+	}
+}
+
+func WalkFollowSymlinks(follow bool) WalkOptsFunc {
+	return func(config *WalkOpts) {
+		config.FollowSymlinks = follow
+	}
+}
+
+func WalkMinimumFileSize(size int64) WalkOptsFunc {
+	return func(config *WalkOpts) {
+		config.MinimumFileSize = size
+	}
+}
+
+func WalkMaximumFileSize(size int64) WalkOptsFunc {
+	return func(config *WalkOpts) {
+		config.MaximumFileSize = size
+	}
+}
+
+func WalkVisitFiles(value bool) WalkOptsFunc {
+	return func(config *WalkOpts) {
+		config.VisitFiles = value
+	}
+}
+
+func WalkVisitDirs(value bool) WalkOptsFunc {
+	return func(config *WalkOpts) {
+		config.VisitDirs = value
+	}
+}
+
+func WalkVisitSymlinks(value bool) WalkOptsFunc {
+	return func(config *WalkOpts) {
+		config.VisitSymlinks = value
+	}
+}
+
 // NewWalk returns a new Walk struct with default values applied
-func NewWalk(root *Path) (*Walk, error) {
-	return NewWalkWithOpts(root, DefaultWalkOpts())
+func NewWalk(root *Path, opts ...WalkOptsFunc) (*Walk, error) {
+	config := DefaultWalkOpts()
+	for _, opt := range opts {
+		opt(config)
+	}
+	return NewWalkWithOpts(root, config)
 }
 
 // NewWalkWithOpts returns a Walk object with the given WalkOpts applied