Skip to content

tetafro/godot

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

godot

License Github CI Go Report Codecov

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

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.

Config

You can specify options using config file. Use default name .godot.yaml, or set it using -c filename.yaml argument. If no config provided the following defaults are used:

# Which comments to check:
#   declarations - for top level declaration comments (default);
#   toplevel     - for top level comments;
#   all          - for all comments.
scope: declarations

# List of regexps for excluding particular comment lines from check.
exclude:

# Check periods at the end of sentences.
period: true

# Check that first letter of each sentence is capital.
capital: false

Run

godot ./myproject

Autofix flags are also available

godot -f ./myproject # fix issues and print the result
godot -w ./myproject # fix issues and replace the original file

See all flags with godot -h.

Example

Code

package math

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

Output

Comment should end in a period: math/math.go:3:1

About

Linter that checks if comments end in a period

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages