Add more linters to our CI pipeline

[sebasslash]

Description

As part of our 1.0 efforts, we're trying to enforce best Go practices and improve consistency in our codebase. Our current CI pipeline is in need of much improvement allowing for inconsistencies, redundancies, and errors to go unnoticed. This PR enables several linters can serve as beneficial tools in our refactoring efforts:

goconst

One thing we noticed across our codebase were duplicate error messages. Goconst enables us to find these duplicate strings that can be refactored into a constant. In this case, commonly thrown errors should be refactored into a constant that lives in errors.go

gocritic

This linter will handle the brunt of our linter pipeline enforcing opinionated best practices for go. I've enabled several tags for gocritic:

• diagnostic - perform diagnostic checks to find potential programming errors.
• opinionated - enforces gocritic's opinionated style guide.
• performance - find minor performance issues that can become bottlenecks.

Some interesting errors returned:

• Update and Create options are considered "heavy" in size and gocritic recommends we pass the parameter as a pointer.
• Some of our variable names are shadow imports of packages, i.e var url string or var errors []string
• Some of our regular expressions used in our validations can be simplified
• If/else chains rewritten as switch statements
• Comment formatting issues

Read more in the docs

misspell

Often times grammar mistakes make their way unnoticed into our documentation. While a simple spelling mistake won't necessarily hamper the development experience, with 1.0 we'd like to begin to enforce high documentation quality and that begins with the little things :) misspell will help us find these unnoticed buggers.

unparam

unparam will help us find function parameters that are unused.

External links

• golangci-lint configuration

[brandonc]

I agree with the new infractions so this seems like a good set of linters. How can we make it easy to run these in development? Pre-commit or something?

[brandonc]

Is there a linter registry somewhere? How does it know about these? Can we add github links as above?

[sebasslash]

These linters are included with golangci-lint and are disabled by default -- err, at least we're first disabling all and then explicitly enabling which ones we want. More information about which linters are included and enabled.

Alternatively, you can run golangci-lint linters in the root of your project's directory to see the linters that have been enabled for the project.

[uturunku1]

Looking at the issues that gocritic is listing below for hugeParam is nice! It agrees with the type of refactoring we did previously around ListOptions and pointers

[uturunku1]

Will you implementing the fixes requested by the new lint libraries in this PR?