code for release 2.1.1

.circleci/config.yml

@@ -14,7 +14,7 @@ version: 2
 jobs:
   "test_core_and_drivers_with_coverage":
     docker:
-      - image: cimg/go:1.17
+      - image: cimg/go:1.18
     steps:
       - checkout
       - run:
@@ -31,7 +31,7 @@ jobs:
 
   "test_platforms":
     docker:
-      - image: cimg/go:1.17
+      - image: cimg/go:1.18
     steps:
       - checkout
       - run:
@@ -45,7 +45,7 @@ jobs:
 
   "check_examples":
     docker:
-      - image: cimg/go:1.17
+      - image: cimg/go:1.18
     steps:
       - checkout
       - run:

.github/workflows/golangci-lint.yml

@@ -17,14 +17,14 @@ jobs:
     steps:
       - uses: actions/setup-go@v4
         with:
-          go-version: '1.17'
+          go-version: '1.18'
           cache: false
       - uses: actions/checkout@v3
       - name: golangci-lint
         uses: golangci/golangci-lint-action@v3
         with:
           # Optional: version of golangci-lint to use in form of v1.2 or v1.2.3 or `latest` to use the latest version
-          version: v1.52.2
+          version: v1.53.3
 
           # Optional: working directory, useful for monorepos
           # working-directory: v2

.gitignore

@@ -1,14 +1,14 @@
 .sass-cache
 *.test
 *.swp
+*.snap
 profile.cov
 count.out
-*.swp
-*.snap
 /parts
 /prime
 /stage
 vendor/
+output/
 .idea/
 coverage.txt
 .chglog/chglog_tmp*.md

.golangci.yml

@@ -29,22 +29,118 @@ run:
     - platforms/opencv
 
 linters:
-  # Enable specific linter
+  # currently active linters:
+  #
+  #INFO [lintersdb] Active 35 linters: [asasalint asciicheck bidichk contextcheck decorder depguard durationcheck errcheck exportloopref
+  # gocheckcompilerdirectives gomoddirectives gomodguard goprintffuncname gosimple govet grouper ineffassign makezero mirror musttag
+  # nilerr nilnil nolintlint nosprintfhostport prealloc reassign revive staticcheck tagalign tenv testableexamples tparallel typecheck unused wastedassign]
+
+  enable-all: true
+
   # https://golangci-lint.run/usage/linters/#enabled-by-default
   # note: typecheck can not be disabled, it is used to check code compilation
-  #
-  # TODO: this default linters needs to be disabled to run successfully, we have to fix
-  #       all issues step by step to enable at least the default linters
   disable:
-    - errcheck
-    - ineffassign
-    #- staticcheck
-    - unused
-
-  enable:
-    - nolintlint
+    # deprecated
+    - deadcode # deprecated
+    - exhaustivestruct # deprecated
+    - golint # deprecated
+    - ifshort # deprecated
+    - interfacer # deprecated
+    - maligned # deprecated
+    - nosnakecase # deprecated
+    - scopelint # deprecated
+    - structcheck # deprecated
+    - varcheck # deprecated
+    # not used for any reason
+    - execinquery # not needed (no sql)
+    - exhaustive # not used (we allow incomplete usage of enum switch, e.g. with default case)
+    - forbidigo # not used (we allow print statements)
+    - ginkgolinter # not needed (enforces standards of using ginkgo and gomega)
+    - gochecknoglobals # not used (we allow definition of unexposed variables at top level)
+    - godot # not used (seems to be counting peas)
+    - godox # not used (we have many TODOs, so not useful)
+    - goerr113 # not used (we allow error creation at return statement)
+    - gofumpt # not used (we use "go fmt" or "gofmt" not gofumpt"
+    - gosmopolitan # not needed (report i18n/l10n anti-patterns)
+    - importas # not needed (there is no alias rule at the moment)
+    - ireturn # not used (we allow return interfaces)
+    - loggercheck # not needed (relates to kitlog, klog, logr, zap)
+    - paralleltest # not used
+    - promlinter # not needed (prometheus metrics naming)
+    - rowserrcheck # not needed (sql related)
+    - sqlclosecheck # not needed (sql related)
+    - testpackage # not needed, we use the same name for test package to have access to unexposed items
+    - wrapcheck # not needed (we allow errors from interface methods)
+    - zerologlint # not needed (related to zerolog package)
+    # important to have
+    - gofmt # important to prevent "format tsunami" ("gofmt -s -w" missed), disabled due to "https://github.com/golangci/golangci-lint-action/issues/535"
+    - nakedret # very useful together with "nonamedreturns" (reduce bugs)
+    - nonamedreturns # very useful (reduce bugs)
+    - unconvert # very useful (reduce bugs, simplify code)
+    - unparam # very useful (reduce bugs, simplify code)
+    # useful for the future
+    - bodyclose # maybe useful (reduce bugs), exclusions for tests needed
+    - containedctx # useful (structs are not for context wrapping)
+    - cyclop # useful with some tweeks (better understandable code), see also gocyclo
+    - dogsled # useful with some tweeks (e.g. exclude tests)
+    - dupl # useful with some tweeks (reduce bugs and lines of code)
+    - dupword # useful with some tweeks, but not important
+    - errchkjson # useful (reduce bugs)
+    - errname # useful for common style
+    - errorlint # useful (reduce bugs), but suppress the "Use `%w` to format errors" check
+    - exhaustruct # useful with some exclusions for existing code (e.g. mavlink/common/common.go)
+    - forcetypeassert # useful (reduce bugs)
+    - funlen # useful with some tweeks (reduce bugs, simplify code, better understandable code)
+    - gci # useful (improve readability)
+    - gochecknoinits # useful (reduce bugs, simplify bug catching)
+    - gocognit # useful with some tweeks (better understandable code)
+    - goconst # useful (reduce bugs)
+    - gocritic # useful with some exclusions for existing code (e.g. mavlink/common/common.go)
+    - gocyclo # useful with some tweeks (better understandable code)
+    - goheader # useful, if we introduce a common header (e.g. for copyright)
+    - goimports # useful (common style), but not important
+    - gomnd # useful with some exclusions for existing code (e.g. mavlink.go)
+    - gosec # useful (security)
+    - interfacebloat # useful with some exclusions at usage of external packages
+    - lll # useful with some exclusions for existing code (e.g. mavlink/common/common.go)
+    - maintidx # useful with some tweeks (better understandable code), maybe use instead "gocyclo", "gocognit" , "cyclop"
+    - misspell # useful (better understandable code), but not important
+    - nestif # useful (reduce bugs, simplify code, better understandable code)
+    - nlreturn # more common style, but could become annoying
+    - noctx # maybe good (show used context explicit)
+    - predeclared # useful (reduce bugs)
+    - stylecheck # useful with some tweaking (e.g. underscores in names should be allowed - we use it for constants retrieved from C/C++)
+    - tagliatelle # maybe useful with some tweaking or excluding
+    - thelper # useful
+    - usestdlibvars # useful
+    - varnamelen # maybe useful with some tweaking, but many findings
+    - whitespace # more common style, but could become annoying
+    - wsl # more common style, but could become annoying
 
 linters-settings:
+  depguard:
+    # Rules to apply.
+    #
+    # Variables:
+    # - File Variables
+    #   you can still use and exclamation mark ! in front of a variable to say not to use it.
+    #   Example !$test will match any file that is not a go test file.
+    #
+    #   `$all` - matches all go files
+    #   `$test` - matches all go test files
+    #
+    # - Package Variables
+    #
+    #  `$gostd` - matches all of go's standard library (Pulled from `GOROOT`)
+    #
+    # Default: Only allow $gostd in all files.
+    rules:
+      main:
+        # Packages that are not allowed where the value is a suggestion.
+        deny:
+          - pkg: "github.com/pkg/errors"
+            desc: Should be replaced by standard lib errors package
+
   nolintlint:
     # Enable to require an explanation of nonzero length after each nolint directive.
     # Default: false

CONTRIBUTING.md

@@ -47,6 +47,7 @@ Descriptions for each of these will eventually be provided below.
   * If there are commits after yours use “git rebase -i <new_head_branch>”
   * If you have local changes you may need to use “git stash”
   * For git help see [progit](http://git-scm.com/book) which is an awesome (and free) book on git
+* Use one of the latest existing platforms/drivers etc. as a blueprint for creating a new one
 
 ## Creating Pull Requests
 
@@ -58,9 +59,9 @@ The basics are as follows:
 
 1. Fork the project via the GitHub UI
 
-2. `go get` the upstream repo and set it up as the `upstream` remote and your own repo as the `origin` remote:
+2. `git clone` the upstream repo and set it up as the `upstream` remote and your own repo as the `origin` remote:
 
-    `go get gobot.io/x/gobot/v2`
+    `git clone https://github.com/hybridgroup/gobot.git`
     `cd $GOPATH/src/gobot.io/x/gobot`
     `git remote rename origin upstream`
     `git remote add origin git@github.com/YOUR_GITHUB_NAME/gobot`

Makefile

@@ -16,7 +16,7 @@ including_except := $(shell go list ./... | grep -v platforms/opencv)
 
 # Run tests on nearly all directories without test cache
 test:
-	go test -count=1 -v $(including_except)
+	go test -failfast -count=1 -v $(including_except)
 
 # Run tests with race detection
 test_race:
@@ -56,12 +56,12 @@ version_check:
 
 # Check for bad code style and other issues
 fmt_check:
-	gofmt -l ./	
+	gofmt -l -s .
 	golangci-lint run -v
 
 # Fix bad code style (will only be executed, on version match)
 fmt_fix: version_check
-	go fmt ./...
+	gofmt -l -s -w .
 
 examples: $(EXAMPLES)