{"id":15647448,"url":"https://github.com/tetafro/godot","last_synced_at":"2025-04-08T08:15:34.566Z","repository":{"id":46829261,"uuid":"247430773","full_name":"tetafro/godot","owner":"tetafro","description":"Linter that checks that comments end in a period","archived":false,"fork":false,"pushed_at":"2025-02-15T15:01:57.000Z","size":194,"stargazers_count":46,"open_issues_count":6,"forks_count":7,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-04-01T05:37:16.636Z","etag":null,"topics":["go","golang","linter"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tetafro.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-03-15T08:47:38.000Z","updated_at":"2025-03-08T04:51:10.000Z","dependencies_parsed_at":"2024-06-18T15:20:37.530Z","dependency_job_id":"271cd191-ebfe-4d5c-8591-9588b7bb8ed7","html_url":"https://github.com/tetafro/godot","commit_stats":null,"previous_names":[],"tags_count":54,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tetafro%2Fgodot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tetafro%2Fgodot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tetafro%2Fgodot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tetafro%2Fgodot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tetafro","download_url":"https://codeload.github.com/tetafro/godot/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247801175,"owners_count":20998339,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["go","golang","linter"],"created_at":"2024-10-03T12:19:31.239Z","updated_at":"2025-04-08T08:15:34.532Z","avatar_url":"https://github.com/tetafro.png","language":"Go","funding_links":[],"categories":["Go"],"sub_categories":[],"readme":"# godot\n\n[![License](http://img.shields.io/badge/license-MIT-green.svg?style=flat)](https://raw.githubusercontent.com/tetafro/godot/master/LICENSE)\n[![Github CI](https://img.shields.io/github/actions/workflow/status/tetafro/godot/push.yml)](https://github.com/tetafro/godot/actions)\n[![Go Report](https://goreportcard.com/badge/github.com/tetafro/godot)](https://goreportcard.com/report/github.com/tetafro/godot)\n[![Codecov](https://codecov.io/gh/tetafro/godot/branch/master/graph/badge.svg)](https://codecov.io/gh/tetafro/godot)\n\nLinter that checks if all top-level comments contain a period at the\nend of the last sentence if needed.\n\n[CodeReviewComments](https://github.com/golang/go/wiki/CodeReviewComments#comment-sentences) quote:\n\n\u003e Comments should begin with the name of the thing being described\n\u003e and end in a period\n\n## Install\n\n*NOTE: Godot is available as a part of [GolangCI Lint](https://github.com/golangci/golangci-lint)\n(disabled by default).*\n\nBuild from source\n\n```sh\ngo install github.com/tetafro/godot/cmd/godot@latest\n```\n\nor download binary from [releases page](https://github.com/tetafro/godot/releases).\n\n## Config\n\nYou can specify options using config file. Use default name `.godot.yaml`, or\nset it using `-c filename.yaml` argument. If no config provided the following\ndefaults are used:\n\n```yaml\n# Which comments to check:\n#   declarations - for top level declaration comments (default);\n#   toplevel     - for top level comments;\n#   noinline     - for all except inline comments;\n#   all          - for all comments.\nscope: declarations\n\n# List of regexps for excluding particular comment lines from check.\nexclude:\n\n# Check periods at the end of sentences.\nperiod: true\n\n# Check that first letter of each sentence is capital.\ncapital: false\n```\n\n## Run\n\n```sh\ngodot ./myproject\n```\n\nAutofix flags are also available\n\n```sh\ngodot -f ./myproject # fix issues and print the result\ngodot -w ./myproject # fix issues and replace the original file\n```\n\nSee all flags with `godot -h`.\n\n## Example\n\nCode\n\n```go\npackage math\n\n// Sum sums two integers\nfunc Sum(a, b int) int {\n    return a + b // result\n}\n```\n\nOutput\n\n```sh\nComment should end in a period: math/math.go:3:1\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftetafro%2Fgodot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftetafro%2Fgodot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftetafro%2Fgodot/lists"}