Linter for Third Party Packages

[nunnatsa]

Hi.

I'm working on a linter to ginkgo and gomega (the popular testing package and its matchers packege). The code is here: https://github.com/nunnatsa/ginkgolinter

The linter enforces standards of using ginkgo and gomega. Right now it only warns for asserting len(x), instead of asserting x with existing length assertions, such as HaveLen().

I also integrated this new linter with golangci-lint and it's working (locally).

My question is: would you accept a linter for non-pure golang, but for packages, like ginkgo & gomega?

Thanks!

[ldez]

Hi,

would you accept a linter for non-pure golang, but for packages, like ginkgo & gomega?

The question is not precisely that, it's more related to dependencies: more dependencies imply more problems.
Your linter depends on ginkgo and gomega, from my point of view it can be a problem.

You can also create a plugin https://golangci-lint.run/contributing/new-linters/#how-to-add-a-private-linter-to-golangci-lint

[ldez]

offtopic: you have to remove the vendor folder.
https://github.com/nunnatsa/ginkgolinter/tree/main/testdata/src/a/vendor

[ldez]

But the analyzer will fail without these dependencies.

I will see if I can change the test mechanism.

[nunnatsa]

I made a small change in my linter - set the Analyzer's RunDespiteErrors field to true - it makes the analyzer to ignore load errors. However, the cli, that uses singlechecker.Main, does not look at this field and fails to run without the ginkgo and gomega dependencies.

The same happens in golangci-lint unit tests, and I couldn't find a way around it, yet.

If there is a way to make golangci-lint respect the Analyzer's RunDespiteErrors field, then I think we can contribute linters for 3rd party packages without their dependencies.

[ldez]

If there is a way to make golangci-lint respect the Analyzer's RunDespiteErrors field

Currently, it's not possible.

FYI, I'm still working on something.

[nunnatsa]

I'm still working on something

Thanks!

[nunnatsa]

offtopic: you have to remove the vendor folder.

This is to solve a similar problem in the linter unit tests. This is the only way I found to run the tests.

However, the vendor directory is not part of the package code and does not affect the package users. It's only used for unit tests.

[ldez]

You are right, it's related to "GO111MODULE=off" from https://github.com/golang/tools/blob/b929f3bf4d57d9023b392ff552aa21a4845e1a07/go/analysis/analysistest/analysistest.go#L328

[Antonboom]

vendor unit-tests workaround will be irrelevant after
golang/go#61336

[ldez]

@nunnatsa Good news, I found a solution: #3124

.
├── enabled_linters_test.go
├── fix_test.go
├── linters_test.go
├── output_test.go
├── run_test.go
├── testdata
│   ├── asasalint.go
│   ├── asciicheck.go
│   ├── containedctx.go
...
│   ├── ginkgolinter
│   │   ├── ginkgolinter.go
│   │   ├── go.mod
│   │   └── go.sum
...
│   ├── wrapcheck.go
│   └── wsl.go
...

[nunnatsa]

@ldez - I not sure it's belongs to the global linter list. WDYT?

[ldez]

I don't understand your sentence, can you rephrase it?

[nunnatsa]

OK, here it is: #3369.

@ldez - sorry it took so much time.

[ldez]

my login is Ldez

[nunnatsa]

sorry! Thanks for finding that anyway