chore(ci): add golangci-lint

Author: bfabio

.github/workflows/lint.yml

@@ -0,0 +1,14 @@
+on: [push, pull_request]
+
+jobs:
+  go-lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
+        with:
+          go-version: '1.24'
+      - uses: golangci/golangci-lint-action@v8
+        with:
+          version: v2.1.6
+          args: --timeout 3m --verbose

.golangci.yaml

@@ -0,0 +1,127 @@
+version: "2"
+run:
+  # If set, we pass it to "go list -mod={option}". From "go help modules":
+  # If invoked with -mod=readonly, the go command is disallowed from the implicit
+  # automatic updating of go.mod described above. Instead, it fails when any changes
+  # to go.mod are needed. This setting is most useful to check that go.mod does
+  # not need updates, such as in a continuous integration and testing system.
+  # If invoked with -mod=vendor, the go command assumes that the vendor
+  # directory holds the correct copies of dependencies and ignores
+  # the dependency descriptions in go.mod.
+  #
+  # Allowed values: readonly|vendor|mod
+  # Default: ""
+  modules-download-mode: readonly
+
+  # Include test files or not.
+  # Default: true
+  tests: false
+
+linters:
+  default: all
+
+  disable:
+    # Not useful
+    - depguard
+    # Not terribly useful and ends up in too much boilerplate
+    - exhaustruct
+    # https://github.com/italia/developers-italia-api/issues/190)
+    # Don't feel about chasing this one down
+    - musttag
+
+    # More false positive than actual issues
+    - mnd
+
+    # TODO: fix and enable these
+    - cyclop
+    - depguard
+    - err113
+    - errname
+    - errorlint
+    - exhaustruct
+    - forbidigo
+    - forcetypeassert
+    - funlen
+    - gochecknoglobals
+    - gochecknoinits
+    - gocognit
+    - goconst
+    - godot
+    - godox
+    - gosec
+    - ireturn
+    - lll
+    - nestif
+    - nlreturn
+    - perfsprint
+    - prealloc
+    - recvcheck
+    - revive
+    - tagalign
+    - tagliatelle
+    - unused
+    - varnamelen
+    - whitespace
+    - wrapcheck
+    - wsl
+    - gocritic
+    - gocyclo
+    - noctx
+    - predeclared
+    - unparam
+
+  settings:
+    wrapcheck:
+      ignore-sigs:
+        # No point in wrapping these
+        - func encoding/json.Marshal(v any)
+        - func encoding/json.UnmarshalJSON(v any)
+
+        # Defaults
+        - .Errorf(
+        - errors.New(
+        - errors.Unwrap(
+        - .Wrap(
+        - .Wrapf(
+        - .WithMessage(
+        - .WithMessagef(
+        - .WithStack(
+    funlen:
+      # Increase the number of lines, considering funlen counts comments as well
+      # (https://github.com/ultraware/funlen/issues/12)
+      #
+      # default: 60
+      lines: 80
+    usetesting:
+      context-background: true
+      context-todo: true
+      os-chdir: true
+      os-mkdir-temp: true
+      os-setenv: true
+      os-create-temp: true
+      os-temp-dir: false
+
+  exclusions:
+    generated: lax
+    presets:
+      - comments
+      - common-false-positives
+      - legacy
+      - std-error-handling
+    paths:
+      - third_party$
+      - builtin$
+      - examples$
+
+formatters:
+  enable:
+    - gci
+    - gofmt
+    - gofumpt
+    - goimports
+  exclusions:
+    generated: lax
+    paths:
+      - third_party$
+      - builtin$
+      - examples$

errors.go

@@ -16,11 +16,12 @@ func (e ParseError) Error() string {
 }
 
 type ValidationError struct {
-	Key string         `json:"key"`
+	Key         string `json:"key"`
 	Description string `json:"description"`
-	Line int           `json:"line"`
-	Column int         `json:"column"`
+	Line        int    `json:"line"`
+	Column      int    `json:"column"`
 }
+
 func (e ValidationError) Error() string {
 	key := ""
 	if e.Key != "" {
@@ -29,14 +30,15 @@ func (e ValidationError) Error() string {
 
 	return fmt.Sprintf("publiccode.yml:%d:%d: error: %s%s", e.Line, e.Column, key, e.Description)
 }
+
 func (e ValidationError) MarshalJSON() ([]byte, error) {
 	type Ve ValidationError
 
 	return json.Marshal(&struct {
 		*Ve
 		Type string `json:"type"`
-	} {
-		Ve: (*Ve)(&e),
+	}{
+		Ve:   (*Ve)(&e),
 		Type: "error",
 	})
 }
@@ -46,6 +48,7 @@ func newValidationError(key string, description string, args ...interface{}) Val
 }
 
 type ValidationWarning ValidationError
+
 func (e ValidationWarning) Error() string {
 	key := ""
 	if e.Key != "" {
@@ -54,19 +57,21 @@ func (e ValidationWarning) Error() string {
 
 	return fmt.Sprintf("publiccode.yml:%d:%d: warning: %s%s", e.Line, e.Column, key, e.Description)
 }
+
 func (e ValidationWarning) MarshalJSON() ([]byte, error) {
 	type Ve ValidationError
 
 	return json.Marshal(&struct {
 		*Ve
 		Type string `json:"type"`
-	} {
-		Ve: (*Ve)(&e),
+	}{
+		Ve:   (*Ve)(&e),
 		Type: "warning",
 	})
 }
 
 type ValidationResults []error
+
 func (vr ValidationResults) Error() string {
 	var s []string
 	for _, e := range vr {

fields.go

@@ -5,9 +5,8 @@ import (
 	"net/url"
 
 	"github.com/alranel/go-vcsurl/v2"
-	spdxValidator "github.com/kyoh86/go-spdx/spdx"
-
 	urlutil "github.com/italia/publiccode-parser-go/v4/internal"
+	spdxValidator "github.com/kyoh86/go-spdx/spdx"
 )
 
 type validateFn func(publiccode PublicCode, parser Parser, network bool) error

internal/netutil.go

@@ -19,7 +19,9 @@ func downloadFile(filepath string, url *url.URL, headers map[string]string) erro
 	if err != nil {
 		return err
 	}
-	defer out.Close()
+	defer func() {
+		_ = out.Close()
+	}()
 
 	// Get the data from the url.
 	resp, err := httpclient.GetURL(url.String(), headers)

marshallers.go

@@ -1,4 +1,4 @@
-package publiccode;
+package publiccode
 
 import (
 	"net/url"
@@ -23,12 +23,13 @@ func (u *URL) UnmarshalYAML(unmarshal func(interface{}) error) error {
 }
 
 func (u *URL) MarshalYAML() (interface{}, error) {
-  return u.String(), nil
+	return u.String(), nil
 }
 
 func (u URL) String() string {
-    return (*url.URL)(&u).String()
+	return (*url.URL)(&u).String()
 }
+
 type UrlOrUrlArray []*URL
 
 func (a *UrlOrUrlArray) UnmarshalYAML(unmarshal func(interface{}) error) error {

parser.go

@@ -16,10 +16,9 @@ import (
 
 	"github.com/alranel/go-vcsurl/v2"
 	"github.com/go-playground/validator/v10"
-	"gopkg.in/yaml.v3"
-
 	urlutil "github.com/italia/publiccode-parser-go/v4/internal"
 	publiccodeValidator "github.com/italia/publiccode-parser-go/v4/validators"
+	"gopkg.in/yaml.v3"
 )
 
 type ParserConfig struct {
@@ -280,20 +279,22 @@ func (p *Parser) Parse(uri string) (PublicCode, error) {
 
 	url, err := toURL(uri)
 	if err != nil {
-		return nil, fmt.Errorf("Invalid URL '%s': %w", uri, err)
+		return nil, fmt.Errorf("invalid URL '%s': %w", uri, err)
 	}
 
 	if url.Scheme == "file" {
 		stream, err = os.Open(url.Path)
 		if err != nil {
-			return nil, fmt.Errorf("Can't open file '%s': %w", url.Path, err)
+			return nil, fmt.Errorf("can't open file '%s': %w", url.Path, err)
 		}
 	} else {
 		resp, err := http.Get(uri)
 		if err != nil {
-			return nil, fmt.Errorf("Can't GET '%s': %w", uri, err)
+			return nil, fmt.Errorf("can't GET '%s': %w", uri, err)
 		}
-		defer resp.Body.Close()
+		defer func() {
+			_ = resp.Body.Close()
+		}()
 
 		stream = resp.Body
 	}
@@ -314,7 +315,7 @@ func getNodes(key string, node *yaml.Node) (*yaml.Node, *yaml.Node) {
 }
 
 func getPositionInFile(key string, node yaml.Node) (int, int) {
-	var n *yaml.Node = &node
+	n := &node
 
 	keys := strings.Split(key, ".")
 	for _, path := range keys[:len(keys)-1] {
@@ -340,7 +341,7 @@ func getPositionInFile(key string, node yaml.Node) (int, int) {
 // getKeyAtLine returns the key name at line "line" for the YAML document
 // represented at parentNode.
 func getKeyAtLine(parentNode yaml.Node, line int, path string) string {
-	var key = path
+	key := path
 
 	for i, currNode := range parentNode.Content {
 		// If this node is a mapping and the index is odd it means

publiccode-parser/publiccode_parser.go

@@ -9,7 +9,6 @@ import (
 	"runtime/debug"
 
 	"github.com/alranel/go-vcsurl/v2"
-
 	publiccode "github.com/italia/publiccode-parser-go/v4"
 	urlutil "github.com/italia/publiccode-parser-go/v4/internal"
 )
@@ -33,7 +32,7 @@ func init() {
 
 func main() {
 	flag.Usage = func() {
-		fmt.Fprintf(flag.CommandLine.Output(), "Usage: %s [ OPTIONS ] publiccode.yml\n", os.Args[0])
+		_, _ = fmt.Fprintf(flag.CommandLine.Output(), "Usage: %s [ OPTIONS ] publiccode.yml\n", os.Args[0])
 		flag.PrintDefaults()
 	}
 	localBasePathPtr := flag.String("path", "", "Use this local directory as base path when checking for files existence instead of using the `url` key in publiccode.yml")
@@ -54,7 +53,7 @@ func main() {
 		return
 	}
 
-	var publiccodeFile = flag.Args()[0]
+	publiccodeFile := flag.Args()[0]
 
 	if ok, url := urlutil.IsValidURL(publiccodeFile); ok {
 		// supplied argument looks like an URL
@@ -68,7 +67,7 @@ func main() {
 	config.DisableNetwork = *disableNetworkPtr
 
 	p, err := publiccode.NewParser(config)
-	if (err != nil) {
+	if err != nil {
 		fmt.Fprintf(os.Stderr, "Error creating Parser: %s\n", err.Error())
 		os.Exit(1)
 	}
@@ -82,7 +81,7 @@ func main() {
 		}
 
 		out, jsonerr := json.MarshalIndent(err, "", "    ")
-		if (jsonerr != nil) {
+		if jsonerr != nil {
 			fmt.Fprintf(os.Stderr, "Error encoding JSON\n")
 			os.Exit(1)
 		}
@@ -107,7 +106,6 @@ func hasValidationErrors(results error) bool {
 		return false
 	}
 
-
 	switch e := results.(type) {
 	case publiccode.ValidationResults:
 		for _, res := range e {

v0.go

@@ -1,9 +1,8 @@
 package publiccode
 
 import (
-	"gopkg.in/yaml.v3"
-
 	urlutil "github.com/italia/publiccode-parser-go/v4/internal"
+	"gopkg.in/yaml.v3"
 )
 
 // PublicCodeV0 defines how a publiccode.yml v0.x is structured

v1.go

@@ -1,9 +1,8 @@
 package publiccode
 
 import (
-	"gopkg.in/yaml.v3"
-
 	urlutil "github.com/italia/publiccode-parser-go/v4/internal"
+	"gopkg.in/yaml.v3"
 )
 
 // There's no v1 yet, this is just an unexported placeholder type
@@ -16,7 +15,6 @@ type publicCodeV1 struct {
 //nolint:unused
 func (p publicCodeV1) Version() uint {
 	return 1
-
 }
 
 //nolint:unused