cuonglm/gocmt

Add missing comment on exported function, method, type, constant, variable in go file

gocmt's Issues

How to add a linter like this.

Hi, I want to add some linter to avoid writing function which is public but uncomment.
It's the contrary of this tool.
Because we are an open-source repo(https://github.com/apache/incubator-devlake), we need to write more normative code.
Could you help me 😁?

golint has update the rule, is there any plan for support it?

now, the method need prefix for golint, is there any plan for support it? such as:

go lint report

gorose/orm.go
Line 81: warning: comment on exported method Orm.Table should be of the form "Table ..." (golint)

orm.go source code

func (dba *Orm) Table(tab interface{}) IOrm {
	dba.GetISession().Bind(tab)
	//dba.table = dba.GetISession().GetTableName()
	return dba
}

this need the comment like // Orm.Table ..., not // Table ...

is it necessary for every element in parens to add comment?

In golint, it is ok if we have a comment above the parens

[BUG] incorrect comments when an exported var defined in a func

Produce steps:

1. create a main.go in foo directory:

package p

import "log"

// I ...
var I = 1

func a() {

        // LogAll ... 
	var LogAll map[string]struct{}
	log.Println(LogAll)
}

2. run gocmt -d foo -i

Result:

$ cat foo/main.go
package p

import "log"

// I ...
var I = 1

func a() {

	// LogAll ...
	// LogAll ...
	var LogAll map[string]struct{}
	log.Println(LogAll)
}

feat: support go 1.20, or go 1.18 at least

Go 1.18 introduced generics, and gocmt can not handle the generics things.

Based on my testing, updating the Go version resolves issues with the AST parser and allows it to function correctly.

Ignore vendor folders

gocmt -d . -i also modifies vendored folders.

The default behaviour should be to ignore it, since you almost never want your vendored packages to be modified.