https://github.com/tetafro/godot

Linter that checks that comments end in a period
https://github.com/tetafro/godot

go golang linter

Last synced: 22 days ago
JSON representation

Linter that checks that comments end in a period

• Host: GitHub
• URL: https://github.com/tetafro/godot
• Owner: tetafro
• License: mit
• Created: 2020-03-15T08:47:38.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-09-09T17:33:11.000Z (2 months ago)
• Last Synced: 2024-10-03T12:23:08.349Z (about 2 months ago)
• Topics: go, golang, linter
• Language: Go
• Homepage:
• Size: 173 KB
• Stars: 44
• Watchers: 4
• Forks: 7
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# godot

[![License](http://img.shields.io/badge/license-MIT-green.svg?style=flat)](https://raw.githubusercontent.com/tetafro/godot/master/LICENSE)

[![Github CI](https://img.shields.io/github/actions/workflow/status/tetafro/godot/push.yml)](https://github.com/tetafro/godot/actions)

[![Go Report](https://goreportcard.com/badge/github.com/tetafro/godot)](https://goreportcard.com/report/github.com/tetafro/godot)

[![Codecov](https://codecov.io/gh/tetafro/godot/branch/master/graph/badge.svg)](https://codecov.io/gh/tetafro/godot)

Linter that checks if all top-level comments contain a period at the

end of the last sentence if needed.

[CodeReviewComments](https://github.com/golang/go/wiki/CodeReviewComments#comment-sentences) 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](https://github.com/golangci/golangci-lint)

(disabled by default).*

Build from source

```sh

go install github.com/tetafro/godot/cmd/godot@latest

```

or download binary from [releases page](https://github.com/tetafro/godot/releases).

## 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:

```yaml

# 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

```sh

godot ./myproject

```

Autofix flags are also available

```sh

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

```go

package math

// Sum sums two integers

func Sum(a, b int) int {

    return a + b // result

}

```

Output

```sh

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

```