godot

README

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

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

Autofix flags are also available

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

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

Documentation

Overview

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

Index

• func Fix(path string, file *ast.File, fset *token.FileSet, settings Settings) ([]byte, error)
• func Replace(path string, file *ast.File, fset *token.FileSet, settings Settings) error
• type Issue
  • func Run(file *ast.File, fset *token.FileSet, settings Settings) []Issue
• type Settings

Functions

func Fix

func Fix(path string, file *ast.File, fset *token.FileSet, settings Settings) ([]byte, error)

Fix fixes all issues and return new version of file content.

func Replace

func Replace(path string, file *ast.File, fset *token.FileSet, settings Settings) error

Replace rewrites original file with it's fixed version.

Types

type Issue

type Issue struct {
	Pos         token.Position
	Message     string
	Replacement string
}

Issue contains a description of linting error and a possible replacement.

func Run

func Run(file *ast.File, fset *token.FileSet, settings Settings) []Issue

Run runs this linter on the provided code.

type Settings

type Settings struct {
	// Check all top-level comments, not only declarations
	CheckAll bool
}

Settings contains linter settings.