Skip to content

feat: add arangolint linter #5718

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
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
2 changes: 2 additions & 0 deletions .golangci.next.reference.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ linters:
# Enable specific linter.
# https://golangci-lint.run/usage/linters/#enabled-by-default
enable:
- arangolint
- asasalint
- asciicheck
- bidichk
Expand Down Expand Up @@ -124,6 +125,7 @@ linters:
# Disable specific linter.
# https://golangci-lint.run/usage/linters/#disabled-by-default
disable:
- arangolint
- asasalint
- asciicheck
- bidichk
Expand Down
1 change: 1 addition & 0 deletions go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ require (
github.com/Antonboom/nilnil v1.1.0
github.com/Antonboom/testifylint v1.6.1
github.com/BurntSushi/toml v1.5.0
github.com/Crocmagnon/arangolint v0.1.3
github.com/Crocmagnon/fatcontext v0.7.2
github.com/Djarvur/go-err113 v0.0.0-20210108212216-aea10b59be24
github.com/GaijinEntertainment/go-exhaustruct/v3 v3.3.1
Expand Down
2 changes: 2 additions & 0 deletions go.sum

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions jsonschema/golangci.next.jsonschema.json
Original file line number Diff line number Diff line change
Expand Up @@ -716,6 +716,7 @@
"anyOf": [
{
"enum": [
"arangolint",
"asasalint",
"asciicheck",
"bidichk",
Expand Down
19 changes: 19 additions & 0 deletions pkg/golinters/arangolint/arangolint.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
package arangolint

import (
"github.com/Crocmagnon/arangolint/pkg/analyzer"
"golang.org/x/tools/go/analysis"

"github.com/golangci/golangci-lint/v2/pkg/goanalysis"
)

func New() *goanalysis.Linter {
a := analyzer.NewAnalyzer()

return goanalysis.NewLinter(
a.Name,
a.Doc,
[]*analysis.Analyzer{a},
nil,
).WithLoadMode(goanalysis.LoadModeTypesInfo)
}
11 changes: 11 additions & 0 deletions pkg/golinters/arangolint/arangolint_integration_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
package arangolint

import (
"testing"

"github.com/golangci/golangci-lint/v2/test/testshared/integration"
)

func TestFromTestdata(t *testing.T) {
integration.RunTestdata(t)
}
47 changes: 47 additions & 0 deletions pkg/golinters/arangolint/testdata/arangolint.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
//golangcitest:args -Earangolint
package testdata

import (
"context"

"github.com/arangodb/go-driver/v2/arangodb"
)

func example() {
ctx := context.Background()
arangoClient := arangodb.NewClient(nil)
db, _ := arangoClient.GetDatabase(ctx, "name", nil)

// direct nil
db.BeginTransaction(ctx, arangodb.TransactionCollections{}, nil) // want "missing AllowImplicit option"
trx, _ := db.BeginTransaction(ctx, arangodb.TransactionCollections{}, nil) // want "missing AllowImplicit option"
_ = trx

// direct missing
db.BeginTransaction(ctx, arangodb.TransactionCollections{}, &arangodb.BeginTransactionOptions{LockTimeout: 0}) // want "missing AllowImplicit option"
trx, _ = db.BeginTransaction(ctx, arangodb.TransactionCollections{}, &arangodb.BeginTransactionOptions{LockTimeout: 0}) // want "missing AllowImplicit option"

// direct false
db.BeginTransaction(ctx, arangodb.TransactionCollections{}, &arangodb.BeginTransactionOptions{AllowImplicit: false})
trx, _ = db.BeginTransaction(ctx, arangodb.TransactionCollections{}, &arangodb.BeginTransactionOptions{AllowImplicit: false})

// direct true
db.BeginTransaction(ctx, arangodb.TransactionCollections{}, &arangodb.BeginTransactionOptions{AllowImplicit: true})
trx, _ = db.BeginTransaction(ctx, arangodb.TransactionCollections{}, &arangodb.BeginTransactionOptions{AllowImplicit: true})

// direct with other fields
db.BeginTransaction(ctx, arangodb.TransactionCollections{}, &arangodb.BeginTransactionOptions{AllowImplicit: true, LockTimeout: 0})
trx, _ = db.BeginTransaction(ctx, arangodb.TransactionCollections{}, &arangodb.BeginTransactionOptions{AllowImplicit: true, LockTimeout: 0})

// indirect no pointer
// options := arangodb.BeginTransactionOptions{LockTimeout: 0}
// db.BeginTransaction(ctx, arangodb.TransactionCollections{}, &options) // w@nt "missing AllowImplicit option"
// options.AllowImplicit = true
// db.BeginTransaction(ctx, arangodb.TransactionCollections{}, &options)
//
// indirect pointer
// optns := &arangodb.BeginTransactionOptions{LockTimeout: 0}
// db.BeginTransaction(ctx, arangodb.TransactionCollections{}, optns) // w@nt "missing AllowImplicit option"
// options.AllowImplicit = true
// db.BeginTransaction(ctx, arangodb.TransactionCollections{}, optns)
}
34 changes: 34 additions & 0 deletions pkg/golinters/arangolint/testdata/arangolint_cgo.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
//golangcitest:args -Earangolint
package testdata

/*
#include <stdio.h>
#include <stdlib.h>

void myprint(char* s) {
printf("%d\n", s);
}
*/
import "C"

import (
"context"
"unsafe"

"github.com/arangodb/go-driver/v2/arangodb"
)

func _() {
cs := C.CString("Hello from stdio\n")
C.myprint(cs)
C.free(unsafe.Pointer(cs))
}

func _() {
ctx := context.Background()
arangoClient := arangodb.NewClient(nil)
db, _ := arangoClient.GetDatabase(ctx, "name", nil)
trx, _ := db.BeginTransaction(ctx, arangodb.TransactionCollections{}, &arangodb.BeginTransactionOptions{LockTimeout: 0}) // want "missing AllowImplicit option"
db.BeginTransaction(ctx, arangodb.TransactionCollections{}, &arangodb.BeginTransactionOptions{AllowImplicit: false})
_ = trx
}
19 changes: 19 additions & 0 deletions pkg/golinters/arangolint/testdata/go.mod
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
module testdata

go 1.23.0

require github.com/arangodb/go-driver/v2 v2.1.3

require (
github.com/arangodb/go-velocypack v0.0.0-20200318135517-5af53c29c67e // indirect
github.com/dchest/siphash v1.2.3 // indirect
github.com/google/uuid v1.6.0 // indirect
github.com/kkdai/maglev v0.2.0 // indirect
github.com/mattn/go-colorable v0.1.13 // indirect
github.com/mattn/go-isatty v0.0.20 // indirect
github.com/pkg/errors v0.9.1 // indirect
github.com/rs/zerolog v1.33.0 // indirect
golang.org/x/net v0.33.0 // indirect
golang.org/x/sys v0.28.0 // indirect
golang.org/x/text v0.21.0 // indirect
)
46 changes: 46 additions & 0 deletions pkg/golinters/arangolint/testdata/go.sum

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions pkg/lint/lintersdb/builder_linter.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package lintersdb
import (
"github.com/golangci/golangci-lint/v2/pkg/config"
"github.com/golangci/golangci-lint/v2/pkg/golinters"
"github.com/golangci/golangci-lint/v2/pkg/golinters/arangolint"
"github.com/golangci/golangci-lint/v2/pkg/golinters/asasalint"
"github.com/golangci/golangci-lint/v2/pkg/golinters/asciicheck"
"github.com/golangci/golangci-lint/v2/pkg/golinters/bidichk"
Expand Down Expand Up @@ -134,6 +135,11 @@ func (LinterBuilder) Build(cfg *config.Config) ([]*linter.Config, error) {
// The linters are sorted in the alphabetical order (case-insensitive).
// When a new linter is added the version in `WithSince(...)` must be the next minor version of golangci-lint.
return []*linter.Config{
linter.NewConfig(arangolint.New()).
WithSince("v2.1.0").
WithLoadForGoAnalysis().
WithURL("https://github.com/Crocmagnon/arangolint"),

linter.NewConfig(asasalint.New(&cfg.Linters.Settings.Asasalint)).
WithSince("v1.47.0").
WithLoadForGoAnalysis().
Expand Down
Loading