mcristina422 / godot

Linter that checks if comments end in a period

godot

Linter that checks if all top-level comments contain a period at the end of the last sentence if needed.

CodeReviewComments quote:

Comments should begin with the name of the thing being described and end in a period

Install and run

NOTE: Godot is available as a part of GolangCI Lint (disabled by default).

Build from source

go get -u github.com/tetafro/godot/cmd/godot

or download binary from releases page.

Run

godot ./myproject

Examples

Code

package math

// Sum sums two integers
func Sum(a, b int) int {
    return a + b // result
}

Output

Top level comment should end in a period: math/math.go:3:1

See more examples in test files:

• for default mode
• for using --all flag