chore(build): configure 'revive' and 'nolintlint' linters (#984)

spring cleaning in the `// nolint` comments ;)

Signed-off-by: Xavier Coulon <[email protected]>

.golangci.yml

@@ -16,21 +16,47 @@ linters:
     - revive
     - misspell
     - exportloopref
+    - nolintlint
   disable-all: false
   disable:
     - maligned
     - prealloc
     - scopelint
+    - golint
   presets:
     - bugs
     - unused
   fast: false
 
 linters-settings:
+  revive:
+    # Enable all available rules.
+    # Default: false
+    # enable-all-rules: true
+    rules:
+      # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#dot-imports
+      - name: dot-imports
+        disabled: true
   exhaustive:
     # check switch statements in generated files also
     check-generated: false
     # indicates that switch statements are to be considered exhaustive if a
     # 'default' case is present, even if all enum members aren't listed in the
     # switch
-    default-signifies-exhaustive: true
+    default-signifies-exhaustive: true
+  nolintlint:
+    # Disable to ensure that all nolint directives actually have an effect.
+    # Default: false
+    allow-unused: false
+    # Disable to ensure that nolint directives don't have a leading space.
+    # Default: true
+    allow-leading-space: false
+    # Exclude following linters from requiring an explanation.
+    # Default: []
+    allow-no-explanation: []
+    # Enable to require an explanation of nonzero length after each nolint directive.
+    # Default: false
+    require-explanation: false
+    # Enable to require nolint directives to mention the specific linter being suppressed.
+    # Default: false
+    require-specific: true

cmd/libasciidoc/cmd_suite_test.go

@@ -1,8 +1,8 @@
 package main_test
 
 import (
-	. "github.com/onsi/ginkgo/v2" // nolint:golint
-	. "github.com/onsi/gomega"    // nolint:golintt
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
 
 	"testing"
 

cmd/libasciidoc/root_cmd.go

@@ -52,7 +52,7 @@ func NewRootCmd() *cobra.Command {
 			for _, sourcePath := range args {
 				out, close := getOut(cmd, sourcePath, outputName)
 				if out != nil {
-					defer close() // nolint errcheck
+					defer close() //nolint:errcheck
 					// log.Debugf("Starting to process file %v", path)
 					config := configuration.NewConfiguration(
 						configuration.WithFilename(sourcePath),

cmd/libasciidoc/root_cmd_test.go

@@ -6,8 +6,8 @@ import (
 
 	main "github.com/bytesparadise/libasciidoc/cmd/libasciidoc"
 
-	. "github.com/onsi/ginkgo/v2" // nolint:golint
-	. "github.com/onsi/gomega"    // nolint:golintt
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
 )
 
 var _ = Describe("root cmd", func() {

cmd/libasciidoc/version_cmd_test.go

@@ -5,8 +5,8 @@ import (
 
 	main "github.com/bytesparadise/libasciidoc/cmd/libasciidoc"
 
-	. "github.com/onsi/ginkgo/v2" // nolint:golint
-	. "github.com/onsi/gomega"    // nolint:golintt
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
 )
 
 var _ = Describe("version cmd", func() {

libasciidoc_suite_test.go

@@ -3,8 +3,8 @@ package libasciidoc_test
 import (
 	"testing"
 
-	. "github.com/onsi/ginkgo/v2" // nolint:golint
-	. "github.com/onsi/gomega"    // nolint:golint
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
 )
 
 func TestLibasciidoc(t *testing.T) {

libasciidoc_test.go

@@ -10,8 +10,8 @@ import (
 	"github.com/bytesparadise/libasciidoc/pkg/types"
 	. "github.com/bytesparadise/libasciidoc/testsupport"
 
-	. "github.com/onsi/ginkgo/v2" // nolint:golint
-	. "github.com/onsi/gomega"    // nolint:golintt
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
 	log "github.com/sirupsen/logrus"
 )
 

pkg/parser/attribute_substitution_test.go

@@ -4,8 +4,8 @@ import (
 	"github.com/bytesparadise/libasciidoc/pkg/types"
 	. "github.com/bytesparadise/libasciidoc/testsupport"
 
-	. "github.com/onsi/ginkgo/v2" // nolint:golint
-	. "github.com/onsi/gomega"    // nolint:golint
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
 )
 
 var _ = Describe("attribute substitutions", func() {

pkg/parser/attributes_test.go

@@ -8,8 +8,8 @@ import (
 	. "github.com/bytesparadise/libasciidoc/testsupport"
 	log "github.com/sirupsen/logrus"
 
-	. "github.com/onsi/ginkgo/v2" // nolint:golint
-	. "github.com/onsi/gomega"    // nolint:golint
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
 )
 
 var _ = Describe("attributes", func() {

pkg/parser/bench_test.go

@@ -10,9 +10,9 @@ import (
 
 	"github.com/bytesparadise/libasciidoc/pkg/parser"
 
-	. "github.com/onsi/ginkgo/v2"                  // nolint:golint
-	. "github.com/onsi/ginkgo/v2/extensions/table" // nolint:golint
-	. "github.com/onsi/gomega"                     // nolint:golint
+	. "github.com/onsi/ginkgo/v2"                  //nolint:revive
+	. "github.com/onsi/ginkgo/v2/extensions/table" //nolint:revive
+	. "github.com/onsi/gomega"                     //nolint:revive
 )
 
 const (

pkg/parser/blank_line_test.go

@@ -4,8 +4,8 @@ import (
 	"github.com/bytesparadise/libasciidoc/pkg/types"
 	. "github.com/bytesparadise/libasciidoc/testsupport"
 
-	. "github.com/onsi/ginkgo/v2" // nolint:golint
-	. "github.com/onsi/gomega"    // nolint:golintt
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
 )
 
 var _ = Describe("blank lines", func() {

pkg/parser/check_list_test.go

@@ -4,8 +4,8 @@ import (
 	"github.com/bytesparadise/libasciidoc/pkg/types"
 	. "github.com/bytesparadise/libasciidoc/testsupport"
 
-	. "github.com/onsi/ginkgo/v2" // nolint:golint
-	. "github.com/onsi/gomega"    // nolint:golint
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
 )
 
 var _ = Describe("checked lists", func() {

pkg/parser/comment_test.go

@@ -4,8 +4,8 @@ import (
 	"github.com/bytesparadise/libasciidoc/pkg/types"
 	. "github.com/bytesparadise/libasciidoc/testsupport"
 
-	. "github.com/onsi/ginkgo/v2" // nolint:golint
-	. "github.com/onsi/gomega"    // nolint:golintt
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
 )
 
 var _ = Describe("comments", func() {

pkg/parser/cross_reference_test.go

@@ -4,8 +4,8 @@ import (
 	"github.com/bytesparadise/libasciidoc/pkg/types"
 	. "github.com/bytesparadise/libasciidoc/testsupport"
 
-	. "github.com/onsi/ginkgo/v2" // nolint:golint
-	. "github.com/onsi/gomega"    // nolint:golint
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
 )
 
 var _ = Describe("cross references", func() {

pkg/parser/delimited_block_admonition_test.go

@@ -3,8 +3,8 @@ package parser_test
 import (
 	"github.com/bytesparadise/libasciidoc/pkg/types"
 	. "github.com/bytesparadise/libasciidoc/testsupport"
-	. "github.com/onsi/ginkgo/v2" // nolint:golint
-	. "github.com/onsi/gomega"    // nolint:golint
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
 )
 
 var _ = Describe("admonition blocks", func() {

pkg/parser/delimited_block_example_test.go

@@ -6,8 +6,8 @@ import (
 	"github.com/bytesparadise/libasciidoc/pkg/types"
 	. "github.com/bytesparadise/libasciidoc/testsupport"
 
-	. "github.com/onsi/ginkgo/v2" // nolint:golint
-	. "github.com/onsi/gomega"    // nolint:golint
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
 )
 
 var _ = Describe("example blocks", func() {

pkg/parser/delimited_block_fenced_test.go

@@ -4,8 +4,8 @@ import (
 	"github.com/bytesparadise/libasciidoc/pkg/types"
 	. "github.com/bytesparadise/libasciidoc/testsupport"
 
-	. "github.com/onsi/ginkgo/v2" // nolint:golint
-	. "github.com/onsi/gomega"    // nolint:golint
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
 )
 
 var _ = Describe("fenced blocks", func() {

pkg/parser/delimited_block_listing_test.go

@@ -7,8 +7,8 @@ import (
 	. "github.com/bytesparadise/libasciidoc/testsupport"
 	log "github.com/sirupsen/logrus"
 
-	. "github.com/onsi/ginkgo/v2" // nolint:golint
-	. "github.com/onsi/gomega"    // nolint:golint
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
 )
 
 var _ = Describe("listing blocks", func() {

pkg/parser/delimited_block_literal_test.go

@@ -4,8 +4,8 @@ import (
 	"github.com/bytesparadise/libasciidoc/pkg/types"
 	. "github.com/bytesparadise/libasciidoc/testsupport"
 
-	. "github.com/onsi/ginkgo/v2" // nolint:golint
-	. "github.com/onsi/gomega"    // nolint:golint
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
 )
 
 var _ = Describe("literal blocks", func() {

pkg/parser/delimited_block_markdown_quote_test.go

@@ -4,8 +4,8 @@ import (
 	"github.com/bytesparadise/libasciidoc/pkg/types"
 	. "github.com/bytesparadise/libasciidoc/testsupport"
 
-	. "github.com/onsi/ginkgo/v2" // nolint:golint
-	. "github.com/onsi/gomega"    // nolint:golintt
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
 )
 
 var _ = Describe("markdown-style quote blocks", func() {

pkg/parser/delimited_block_passthrough_test.go

@@ -4,8 +4,8 @@ import (
 	"github.com/bytesparadise/libasciidoc/pkg/types"
 	. "github.com/bytesparadise/libasciidoc/testsupport"
 
-	. "github.com/onsi/ginkgo/v2" // nolint:golint
-	. "github.com/onsi/gomega"    // nolint:golint
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
 )
 
 var _ = Describe("passthrough blocks", func() {

pkg/parser/delimited_block_quote_test.go

@@ -4,8 +4,8 @@ import (
 	"github.com/bytesparadise/libasciidoc/pkg/types"
 	. "github.com/bytesparadise/libasciidoc/testsupport"
 
-	. "github.com/onsi/ginkgo/v2" // nolint:golint
-	. "github.com/onsi/gomega"    // nolint:golintt
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
 )
 
 var _ = Describe("quote blocks", func() {

pkg/parser/delimited_block_sidebar_test.go

@@ -4,8 +4,8 @@ import (
 	"github.com/bytesparadise/libasciidoc/pkg/types"
 	. "github.com/bytesparadise/libasciidoc/testsupport"
 
-	. "github.com/onsi/ginkgo/v2" // nolint:golint
-	. "github.com/onsi/gomega"    // nolint:golintt
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
 )
 
 var _ = Describe("sidebar blocks", func() {

pkg/parser/delimited_block_source_test.go

@@ -4,8 +4,8 @@ import (
 	"github.com/bytesparadise/libasciidoc/pkg/types"
 	. "github.com/bytesparadise/libasciidoc/testsupport"
 
-	. "github.com/onsi/ginkgo/v2" // nolint:golint
-	. "github.com/onsi/gomega"    // nolint:golintt
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
 )
 
 var _ = Describe("source blocks", func() {

pkg/parser/delimited_block_verse_test.go

@@ -6,8 +6,8 @@ import (
 	"github.com/bytesparadise/libasciidoc/pkg/types"
 	. "github.com/bytesparadise/libasciidoc/testsupport"
 
-	. "github.com/onsi/ginkgo/v2" // nolint:golint
-	. "github.com/onsi/gomega"    // nolint:golint
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
 )
 
 var _ = Describe("verse blocks", func() {

pkg/parser/document_fragment_processing_test.go

@@ -5,8 +5,8 @@ import (
 	"github.com/bytesparadise/libasciidoc/pkg/types"
 	. "github.com/bytesparadise/libasciidoc/testsupport"
 
-	. "github.com/onsi/ginkgo/v2" // nolint:golint
-	. "github.com/onsi/gomega"    // nolint:golint
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
 )
 
 var _ = Describe("document processing", func() {

pkg/parser/document_header_test.go

@@ -5,8 +5,8 @@ import (
 	"github.com/bytesparadise/libasciidoc/pkg/types"
 	. "github.com/bytesparadise/libasciidoc/testsupport"
 
-	. "github.com/onsi/ginkgo/v2" // nolint:golint
-	. "github.com/onsi/gomega"    // nolint:golint
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
 )
 
 var _ = Describe("headers", func() {

pkg/parser/document_preprocessing_builder_test.go

@@ -4,8 +4,8 @@ import (
 	"github.com/bytesparadise/libasciidoc/pkg/configuration"
 	"github.com/bytesparadise/libasciidoc/pkg/types"
 
-	. "github.com/onsi/ginkgo/v2" // nolint:golint
-	. "github.com/onsi/gomega"    // nolint:golint
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
 )
 
 var _ = Describe("preprocessing condition stack", func() {

pkg/parser/document_preprocessing_conditionals_test.go

@@ -4,8 +4,8 @@ import (
 	"github.com/bytesparadise/libasciidoc/pkg/configuration"
 	. "github.com/bytesparadise/libasciidoc/testsupport"
 
-	. "github.com/onsi/ginkgo/v2" // nolint:golint
-	. "github.com/onsi/gomega"    // nolint:golintt
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
 )
 
 var _ = Describe("conditional inclusions", func() {

pkg/parser/document_preprocessing_include_files_test.go

@@ -8,8 +8,8 @@ import (
 	"github.com/bytesparadise/libasciidoc/pkg/types"
 	. "github.com/bytesparadise/libasciidoc/testsupport"
 
-	. "github.com/onsi/ginkgo/v2" // nolint:golint
-	. "github.com/onsi/gomega"    // nolint:golintt
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
 	log "github.com/sirupsen/logrus"
 )
 

pkg/parser/document_processing_aggregate_test.go

@@ -6,8 +6,8 @@ import (
 	"github.com/bytesparadise/libasciidoc/pkg/types"
 	. "github.com/bytesparadise/libasciidoc/testsupport"
 
-	. "github.com/onsi/ginkgo/v2" // nolint:golint
-	. "github.com/onsi/gomega"    // nolint:golint
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
 )
 
 var _ = Describe("aggregate fragments", func() {

pkg/parser/document_processing_apply_substitutions.go

@@ -620,7 +620,7 @@ const (
 	// Callouts the "callouts" substitution
 	Callouts string = "callouts"
 	// InlinePassthroughs the "inline_passthrough" substitution
-	InlinePassthroughs string = "inline_passthrough" // nolint:gosec
+	InlinePassthroughs string = "inline_passthrough" //nolint:gosec
 	// Macros the "macros" substitution
 	Macros string = "macros"
 	// None the "none" substitution