Run various cleanup, not affecting the logic of the package (#43)

Author: kinbiko

.github/CODE_OF_CONDUCT.md

@@ -14,22 +14,22 @@ appearance, race, religion, or sexual identity and orientation.
 Examples of behavior that contributes to creating a positive environment
 include:
 
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or
- advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
- address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
- professional setting
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
 
 ## Our Responsibilities
 

.github/workflows/codeql-analysis.yml

@@ -13,12 +13,12 @@ name: "CodeQL"
 
 on:
   push:
-    branches: [ main ]
+    branches: [main]
   pull_request:
     # The branches below must be a subset of the branches above
-    branches: [ main ]
+    branches: [main]
   schedule:
-    - cron: '35 16 * * 1'
+    - cron: "35 16 * * 1"
 
 jobs:
   analyze:
@@ -32,39 +32,39 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        language: [ 'go' ]
+        language: ["go"]
         # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
         # Learn more about CodeQL language support at https://git.io/codeql-language-support
 
     steps:
-    - name: Checkout repository
-      uses: actions/checkout@v3
+      - name: Checkout repository
+        uses: actions/checkout@v3
 
-    # Initializes the CodeQL tools for scanning.
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v2
-      with:
-        languages: ${{ matrix.language }}
-        # If you wish to specify custom queries, you can do so here or in a config file.
-        # By default, queries listed here will override any specified in a config file.
-        # Prefix the list here with "+" to use these queries and those in the config file.
-        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v2
+        with:
+          languages: ${{ matrix.language }}
+          # If you wish to specify custom queries, you can do so here or in a config file.
+          # By default, queries listed here will override any specified in a config file.
+          # Prefix the list here with "+" to use these queries and those in the config file.
+          # queries: ./path/to/local/query, your-org/your-repo/queries@main
 
-    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
-    # If this step fails, then you should remove it and run the build manually (see below)
-    - name: Autobuild
-      uses: github/codeql-action/autobuild@v2
+      # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+      # If this step fails, then you should remove it and run the build manually (see below)
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v2
 
-    # ℹ️ Command-line programs to run using the OS shell.
-    # 📚 https://git.io/JvXDl
+      # ℹ️ Command-line programs to run using the OS shell.
+      # 📚 https://git.io/JvXDl
 
-    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
-    #    and modify them (or add more) to build your code if your project
-    #    uses a compiled language
+      # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+      #    and modify them (or add more) to build your code if your project
+      #    uses a compiled language
 
-    #- run: |
-    #   make bootstrap
-    #   make release
+      #- run: |
+      #   make bootstrap
+      #   make release
 
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v2
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v2

.github/workflows/go.yml

@@ -1,37 +1,35 @@
 name: Go
 on: [push]
 jobs:
-
   build:
     name: Build
     runs-on: ubuntu-latest
     steps:
+      - name: Set up Go 1.17
+        uses: actions/setup-go@v1
+        with:
+          go-version: 1.17
+        id: go
 
-    - name: Set up Go 1.17
-      uses: actions/setup-go@v1
-      with:
-        go-version: 1.17
-      id: go
-
-    - name: Check out code into the Go module directory
-      uses: actions/checkout@v1
+      - name: Check out code into the Go module directory
+        uses: actions/checkout@v1
 
-    - name: Get dependencies
-      run: go get -v -t -d ./...
+      - name: Get dependencies
+        run: go get -v -t -d ./...
 
-    - name: Build
-      run: go build -v .
+      - name: Build
+        run: go build -v .
 
-    - name: Test (race)
-      run: go test -race -v -coverprofile=profile.cov -covermode=atomic ./...
+      - name: Test (race)
+        run: go test -race -v -coverprofile=profile.cov -covermode=atomic ./...
 
-    - name: Coverage
-      uses: shogo82148/actions-goveralls@v1
-      with:
-        path-to-profile: profile.cov
+      - name: Coverage
+        uses: shogo82148/actions-goveralls@v1
+        with:
+          path-to-profile: profile.cov
 
-    - name: Install Linter
-      run: curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s v1.45.2
+      - name: Install Linter
+        run: curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s v1.45.2
 
-    - name: Lint
-      run: ./bin/golangci-lint run .
+      - name: Lint
+        run: ./bin/golangci-lint run .

.golangci.yml

@@ -64,15 +64,10 @@ linters-settings:
     min-len: 10
     # minimal occurrences count to trigger, 3 by default
     min-occurrences: 3
-  depguard:
-    list-type: blacklist
-    include-go-root: false
-    packages:
-      - github.com/satori/go.uuid
 
     # 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"
+    # 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.
@@ -145,7 +140,7 @@ linters-settings:
     max-blank-identifiers: 2
 
   whitespace:
-    multi-if: false   # Enforces newlines (or comments) after every multi-line if statement
+    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
 
 linters:
@@ -154,6 +149,8 @@ linters:
     - godot
     - nlreturn
 
+    - depguard
+
       # These are apparently deprecated but still yell at you if you don't disable them
     - golint
     - scopelint
@@ -171,7 +168,6 @@ linters:
     - unused
   fast: false
 
-
 issues:
   # Excluding configuration per-path, per-linter, per-text and per-source
   exclude-rules:

core.go

@@ -38,7 +38,7 @@ func (a *Asserter) pathassertf(path, act, exp string) {
 		a.tt.Errorf("actual JSON (%s) and expected JSON (%s) were of different types at '%s'", actType, expType, path)
 		return
 	}
-	switch actType { // nolint:exhaustive // already know it's valid JSON and not null
+	switch actType { //nolint:exhaustive // already know it's valid JSON and not null
 	case jsonBoolean:
 		actBool, _ := extractBoolean(act)
 		expBool, _ := extractBoolean(exp)
@@ -63,7 +63,7 @@ func (a *Asserter) pathassertf(path, act, exp string) {
 }
 
 func serialize(a interface{}) string {
-	// nolint:errchkjson // Can be confident this won't return an error: the
+	//nolint:errchkjson // Can be confident this won't return an error: the
 	// input will be a nested part of valid JSON, thus valid JSON
 	bytes, _ := json.Marshal(a)
 	return string(bytes)

examples_test.go

@@ -13,7 +13,8 @@ func (p *printer) Errorf(format string, args ...interface{}) {
 }
 
 // using the varible name 't' to mimic a *testing.T variable
-// nolint:gochecknoglobals // this is global to make the examples look like valid test code
+//
+//nolint:gochecknoglobals // this is global to make the examples look like valid test code
 var t *printer
 
 func ExampleNew() {

exports.go

@@ -64,7 +64,6 @@ you only need one *jsonassert.Asseter per (sub)test.
 In most cases, this will look something like
 
 	ja := jsonassert.New(t)
-
 */
 func New(p Printer) *Asserter {
 	// Initially this package was written without the assumption that the

go.mod

@@ -1,3 +1,3 @@
 module github.com/kinbiko/jsonassert
 
-go 1.17
+go 1.19

helper.go

@@ -18,8 +18,8 @@ func (*noopHelperTT) Helper() {
 // e.g. to verify where one potential candidate is matching or not.
 type deepEqualityPrinter struct{ count int }
 
-func (p *deepEqualityPrinter) Errorf(msg string, args ...interface{}) { p.count++ }
-func (p *deepEqualityPrinter) Helper()                                { /* Intentional NOOP */ }
+func (p *deepEqualityPrinter) Errorf(_ string, _ ...interface{}) { p.count++ }
+func (p *deepEqualityPrinter) Helper()                           { /* Intentional NOOP */ }
 
 func (a *Asserter) deepEqual(act, exp interface{}) bool {
 	p := &deepEqualityPrinter{count: 0}

integration_test.go

@@ -460,7 +460,7 @@ type testCase struct {
 
 func (tc *testCase) check(t *testing.T) {
 	t.Helper()
-	tp := &testPrinter{}
+	tp := &testPrinter{messages: nil}
 	jsonassert.New(tp).Assertf(tc.act, tc.exp)
 
 	if got := len(tp.messages); got != len(tc.msgs) {

number.go

@@ -6,8 +6,10 @@ import (
 )
 
 // This is *probably* good enough. Can change this to be even smaller if necessary
-const minDiff = 0.000001
-const bitSize = 64
+const (
+	minDiff = 0.000001
+	bitSize = 64
+)
 
 func (a *Asserter) checkNumber(path string, act, exp float64) {
 	a.tt.Helper()