feat: add arangolint linter

[Crocmagnon]

https://github.com/Crocmagnon/arangolint

Opinionated linter for ArangoDB go driver v2.

Only one feature for now: Enforce explicit AllowImplicit in transactions (see repo readme)

[ldez]

In order for a pull request adding a linter to be reviewed, the linter and the PR must follow some requirements.

• The CLA must be signed

Pull Request Description

• It must have a link to the linter repository.
• It must provide a short description of the linter.

Linter

• It must not be a duplicate of another linter or a rule of a linter (the team will help to verify that).
• It must have a valid license (AGPL is not allowed), and the file must contain the required information by the license, ex: author, year, etc.
• It must use Go version <= 1.23
• The linter repository must have a CI and tests.
• It must use go/analysis.
• It must have a valid tag, ex: v1.0.0, v0.1.0.
• It must not contain init().
• It must not contain panic().
• It must not contain log.Fatal(), os.Exit(), or similar.
• It must not modify the AST.
• It must not have false positives/negatives (the team will help to verify that).
• It must have tests inside golangci-lint.

The Linter Tests Inside Golangci-lint

• They must have at least one std lib import.
• They must have integration tests without configuration (default).
• They must have integration tests with configuration (if the linter has a configuration).

.golangci.next.reference.yml

• The file .golangci.next.reference.yml must be updated.
• The file .golangci.reference.yml must NOT be edited.
• The linter must be added to the lists of available linters (alphabetical case-insensitive order).
  • enable and disable options
• If the linter has a configuration, the exhaustive configuration of the linter must be added (alphabetical case-insensitive order)
  • The values must be different from the default ones.
  • The default values must be defined in a comment.
  • The option must have a short description.

Others Requirements

• The files (tests and linter) inside golangci-lint must have the same name as the linter.
• The .golangci.yml of golangci-lint itself must not be edited and the linter must not be added to this file.
• The linters must be sorted in the alphabetical order (case-insensitive) in the lintersdb/builder_linter.go and .golangci.next.reference.yml.
• The load mode (WithLoadMode(...)):
  • if the linter uses goanalysis.LoadModeSyntax -> no WithLoadForGoAnalysis() in lintersdb/builder_linter.go
  • if the linter uses goanalysis.LoadModeTypesInfo, it requires WithLoadForGoAnalysis() in lintersdb/builder_linter.go
• The version in WithSince(...) must be the next minor version (v1.X.0) of golangci-lint.
• WithURL() must contain the URL of the repository.

Recommendations

• The file jsonschema/golangci.next.jsonschema.json should be updated.
• The file jsonschema/golangci.jsonschema.json must NOT be edited.
• The linter repository should have a readme and linting.
• The linter should be published as a binary (useful to diagnose bug origins).
• The linter repository should have a .gitignore (IDE files, binaries, OS files, etc. should not be committed)
• A tag should never be recreated.
• use main as the default branch name.

---

The golangci-lint team will edit this comment to check the boxes before and during the review.

The code review will start after the completion of those checkboxes (except for the specific items that the team will help to verify).

The reviews should be addressed as commits (no squash).

If the author of the PR is a member of the golangci-lint team, he should not edit this message.

This checklist does not imply that we will accept the linter.

[Crocmagnon]

I added some fixes from the checklist to both this branch and the linter itself.
No more force push to this branch from now on.

[Crocmagnon]

tests fail:

    arangolint_integration_test.go:10: testdata/*.go
=== RUN   TestFromTestdata/arangolint.go
=== PAUSE TestFromTestdata/arangolint.go
=== RUN   TestFromTestdata/arangolint_cgo.go
=== PAUSE TestFromTestdata/arangolint_cgo.go
=== CONT  TestFromTestdata/arangolint.go
=== CONT  TestFromTestdata/arangolint_cgo.go
level=info msg="[test] ran [/tmp/TestFromTestdata4153015037/001/golangci-lint run --internal-cmd-test --allow-parallel-runners --no-config --disable-all --out-format=json --max-same-issues=100 --max-issues-per-linter=100 arangolint.go] in 113.78456ms"
=== NAME  TestFromTestdata/arangolint.go
    run.go:51: 
        	Error Trace:	/home/runner/go/pkg/mod/github.com/golangci/[email protected]/test/testshared/integration/run.go:100
        	            				/home/runner/go/pkg/mod/github.com/golangci/[email protected]/test/testshared/integration/run.go:51
        	Error:      	Not equal: 
        	            	expected: 1
        	            	actual  : 3
        	Test:       	TestFromTestdata/arangolint.go
        	Messages:   	Unexpected exit code: Error: unknown flag: --disable-all
        	            	Failed executing command with error: unknown flag: --disable-all
level=info msg="[test] ran [/tmp/TestFromTestdata4153015037/001/golangci-lint run --internal-cmd-test --allow-parallel-runners --no-config --disable-all --out-format=json --max-same-issues=100 --max-issues-per-linter=100 arangolint_cgo.go] in 125.549512ms"
=== NAME  TestFromTestdata/arangolint_cgo.go
    run.go:51: 
        	Error Trace:	/home/runner/go/pkg/mod/github.com/golangci/[email protected]/test/testshared/integration/run.go:100
        	            				/home/runner/go/pkg/mod/github.com/golangci/[email protected]/test/testshared/integration/run.go:51
        	Error:      	Not equal: 
        	            	expected: 1
        	            	actual  : 3
        	Test:       	TestFromTestdata/arangolint_cgo.go
        	Messages:   	Unexpected exit code: Error: unknown flag: --disable-all
        	            	Failed executing command with error: unknown flag: --disable-all
--- FAIL: TestFromTestdata (0.04s)
    --- FAIL: TestFromTestdata/arangolint.go (0.11s)
    --- FAIL: TestFromTestdata/arangolint_cgo.go (0.13s)
FAIL
FAIL	github.com/golangci/golangci-lint/v2/pkg/golinters/arangolint	0.168s

I don't understand where the error comes from.

[ldez]

At the moment, I'm wondering about the scope of this linter, because it's extremely niche.

[Crocmagnon]

Based on the number of stars on the github driver it may seem so but it looks like there are some large companies using it: https://arangodb.com/solutions/solutions-customers/
I don't know if they're using the go driver though.

[ldez]

We have linters for SQL, Ginkgo, etc., and Arango seems popular, so I think it is acceptable to add it.

LGTM