Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/go.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Set up Go
uses: actions/setup-go@v5
uses: actions/setup-go@v7
with:
go-version: 1.22
go-version: 1.27
id: go

- name: Check out code into the Go module directory
Expand Down
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,5 @@
tags

bin/

profile.cov
303 changes: 114 additions & 189 deletions .golangci.yml
Original file line number Diff line number Diff line change
@@ -1,198 +1,123 @@
run:
timeout: 1m

linters-settings:
errcheck:
# report about not checking of errors in type assetions: `a := b.(MyStruct)`;
# default is false: such cases aren't reported by default.
check-type-assertions: true

# report about assignment of errors to blank identifier: `num, _ := strconv.Atoi(numStr)`;
# default is false: such cases aren't reported by default.
check-blank: false

# [deprecated] comma-separated list of pairs of the form pkg:regex
# the regex is used to ignore names within pkg. (default "fmt:.*").
# see https://github.com/kisielk/errcheck#the-deprecated-method for details
# ignore: fmt:.*,io/ioutil:^Read.*

# path to a file containing a list of functions to exclude from checking
# see https://github.com/kisielk/errcheck#excluding-functions for details
# exclude: /path/to/file.txt

funlen:
lines: 50
statements: 40

govet:
# report about shadowed variables
shadow: true

# enable or disable analyzers by name
# enable:
# - atomicalign
enable-all: true
disable:
- fieldalignment
# disable-all: false
revive:
# minimal confidence for issues, default is 0.8
min-confidence: 0.8
gofmt:
# simplify code: gofmt with `-s` option, true by default
simplify: true
goimports:
# put imports beginning with prefix after 3rd-party packages;
# it's a comma-separated list of prefixes
local-prefixes: github.com/kinbiko/bugsnag
gocyclo:
# minimal code complexity to report, 30 by default (but we recommend 10-20)
# This check is set to an unreasonably low number by most developers'
# standards to track the code standard over time
min-complexity: 10
gocognit:
# minimal code complexity to report, 30 by default (but we recommend 10-20)
# This check is a more useful cyclomatic complexity called cognitive complexity,
# where nested if/for is weighted more, and only one point regardless of
# cases in a switch.
min-complexity: 11
dupl:
# tokens count to trigger issue, 150 by default
threshold: 100
goconst:
# minimal length of string constant, 3 by default
min-len: 10
# minimal occurrences count to trigger, 3 by default
min-occurrences: 3

# packages-with-error-messages:
# specify an error message to output when a blacklisted package is used
# github.com/sirupsen/logrus: "logging is allowed only by logutils.Log"
misspell:
# Correct spellings using locale preferences for US or UK.
# Default is to use a neutral variety of English.
# Setting locale to US will correct the British spelling of 'colour' to 'color'.
locale: US
# ignore-words:
# - someword
lll:
# max line length, lines longer will be reported. Default is 120.
# '\t' is counted as 1 character by default, and can be changed with the tab-width option
line-length: 165
# tab width in spaces. Default to 1.
tab-width: 4
unused:
# treat code as a program (not a library) and report unused exported identifiers; default is false.
# XXX: if you enable this setting, unused will report a lot of false-positives in text editors:
# if it's called for subdir of a project it can't find funcs usages. All text editor integrations
# with golangci-lint call it on a directory with the changed file.
check-exported: false
unparam:
# Inspect exported functions, default is false. Set to true if no external program/library imports your code.
# XXX: if you enable this setting, unparam will report a lot of false-positives in text editors:
# if it's called for subdir of a project it can't find external interfaces. All text editor integrations
# with golangci-lint call it on a directory with the changed file.
check-exported: true
nakedret:
# make an issue if func has more lines of code than this setting and it has naked returns; default is 30
# Naked returns can go plop itself
max-func-lines: 0
prealloc:
# XXX: we don't recommend using this linter before doing performance profiling.
# For most programs usage of prealloc will be a premature optimization.

# Report preallocation suggestions only on simple loops that have no returns/breaks/continues/gotos in them.
# True by default.
simple: true
range-loops: true # Report preallocation suggestions on range loops, true by default
for-loops: false # Report preallocation suggestions on for loops, false by default
gocritic:
# Which checks should be enabled; can't be combined with 'disabled-checks';
# See https://go-critic.github.io/overview#checks-overview
# To check which checks are enabled run `GL_DEBUG=gocritic golangci-lint run`
# By default list of stable checks is used.
# enabled-checks:
# - badCond

# Which checks should be disabled; can't be combined with 'enabled-checks'; default is empty
# disabled-checks:

# Enable multiple checks by tags, run `GL_DEBUG=gocritic golangci-lint run` to see all tags and checks.
# Empty list by default. See https://github.com/go-critic/go-critic#usage -> section "Tags".
enabled-tags:
- diagnostic
- style
- performance

settings: # settings passed to gocritic
captLocal: # must be valid enabled check name
paramsOnly: true
rangeValCopy:
sizeThreshold: 64
godox:
# report any comments starting with keywords, this is useful for TODO or FIXME comments that
# might be left in the code accidentally and should be resolved before merging
keywords: # default keywords are TODO, BUG, and FIXME, these can be overwritten by this setting
- TODO
- FIXME
dogsled:
# checks assignments with too many blank identifiers; default is 2
max-blank-identifiers: 2

whitespace:
multi-if: false # Enforces newlines (or comments) after every multi-line if statement
multi-func: false # Enforces newlines (or comments) after every multi-line function signature

version: "2"
linters:
# `standard` enables errcheck, govet, ineffassign, staticcheck, unused: https://golangci-lint.run/docs/linters/#all-linters

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I do actually like the idea of having new linters being introduced as the language and best practices evolve causing build failures, instead of having to manually keep track of linters being introduced in golangci-lint.

As an exercise there's value in learning about the judgments in the linter violations that'll (presumably) appear if we keep the configs/disabled list the same (up to renames).

default: standard
# Linters explicitly enabled on top of `standard`: only those with deliberately configured thresholds below.
enable:
- dogsled
- dupl
- funlen
- gocognit
- goconst
- gocritic
- gocyclo
- godox
- lll
- misspell
- nakedret
- prealloc
- whitespace
# Not in `standard`; kept as a documented guard in case they're ever promoted, recording past rejections.
disable:
- wsl
- godot
- nlreturn

- depguard

- gci # This conflicts with goimports
- varnamelen # This has too many false positives around indexes etc to be useful
presets:
- bugs
- complexity
- format
- performance
- style
- unused
fast: false

- varnamelen # This has too many false positives around indexes etc to be useful
settings:
dogsled:
max-blank-identifiers: 2
dupl:
threshold: 100
errcheck:
check-type-assertions: true
check-blank: false
funlen:
lines: 50
statements: 40
gocognit:
min-complexity: 11
goconst:
min-len: 10
min-occurrences: 3
ignore-tests: true
gocritic:
enabled-tags:
- diagnostic
- style
- performance
settings:
captLocal:
paramsOnly: true
rangeValCopy:
sizeThreshold: 64
gocyclo:
min-complexity: 10
godox:
keywords:
- TODO
- FIXME
govet:
disable:
- fieldalignment
enable-all: true
lll:
line-length: 165
tab-width: 4
misspell:
locale: US
nakedret:
max-func-lines: 0
prealloc:
simple: true
range-loops: true
for-loops: false
staticcheck:
# QF1008 keeps suggesting dropping the `tt.` prefix; to preserve the original Asserter API we're choosing to ignore this warning.

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nah, I think it should be included. I do expect changes to .go files as part of this change, as the code is updated to adopt to the new language idioms.

checks:
- all
- -QF1008
whitespace:
multi-if: false
multi-func: false
exclusions:
generated: lax
rules:
- linters:
- dupl
- errcheck
- errchkjson
- forbidigo
- funlen
- gocognit
- gocyclo
- lll
- mnd
- staticcheck
- testpackage
path: _test\.go
paths:
- third_party$
- builtin$
- examples$
Comment on lines +86 to +102

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can simplify here I think.

Suggested change
- linters:
- dupl
- errcheck
- errchkjson
- forbidigo
- funlen
- gocognit
- gocyclo
- lll
- mnd
- staticcheck
- testpackage
path: _test\.go
paths:
- third_party$
- builtin$
- examples$
- linters:
- gocognit
- funlen
- lll
path: _test\.go

issues:
# Excluding configuration per-path, per-linter, per-text and per-source
exclude-rules:
# Exclude some linters from running on tests files.
- path: _test\.go
linters:
- cyclop
- dupl
- errcheck
- errchkjson
- exhaustivestruct
- forbidigo
- funlen
- gocognit
- gocyclo
- gomnd
- lll
- stylecheck
- testpackage
- varnamelen
- maintidx
- path: \.go
linters:
- err113

# Independently from option `exclude` we use default exclude patterns,
# it can be disabled by this option. To list all
# excluded by default patterns execute `golangci-lint run --help`.
# Default value for this option is true.
exclude-use-default: false
# Maximum issues count per one linter. Set to 0 to disable. Default is 50.
max-issues-per-linter: 0
# Maximum count of issues with the same text. Set to 0 to disable. Default is 3.
max-same-issues: 0
formatters:
enable:
- gofmt
- gofumpt
# `gci` deliberately unused ("conflicts with goimports"); import formatters live in this section since v2.
- goimports
settings:
gofmt:
simplify: true
goimports:
local-prefixes:
- github.com/kinbiko/bugsnag

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is leftover copy+pasta, and can be removed.

exclusions:
generated: lax
paths:
- third_party$
- builtin$
- examples$
Comment on lines +120 to +123

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think these exist.

4 changes: 2 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
LINTER_VERSION := v1.61.0
LINTER_VERSION := v2.13.2

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This solutions is alright, but since 1.24, Go has added the idea of a dev-dependency.
I'd like to use this to maintain the golangci-lint version in a more idiomatic way, that tools like dependabot understand.

A requirement that's likely going to make the naive and obvious solution insufficient: The github.com/kinbiko/jsonassert module MUST have 0 transitive dependencies, i.e. any users of this library should not implicitly download linter-related code.


.PHONY: check
check: lint test
Expand All @@ -20,5 +20,5 @@ coverage:
go test -race -v -coverprofile=profile.cov -covermode=atomic ./...

bin/linter: Makefile
curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b ./bin $(LINTER_VERSION)
curl -sSfL https://golangci-lint.run/install.sh | sh -s -- -b ./bin $(LINTER_VERSION)
mv ./bin/golangci-lint ./bin/linter
2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
module github.com/kinbiko/jsonassert

go 1.22
go 1.27