Update codelingo.yaml (#335)

* Update codelingo.yaml

* Import comment-first-word-when-empty again
This commit is contained in:
Adrian Gallagher
2019-08-06 15:19:57 +10:00
committed by GitHub
parent 3f71050881
commit 20a5ff256e

View File

@@ -8,33 +8,9 @@ tenets:
- import: codelingo/effective-go/unnecessary-else
- import: codelingo/code-review-comments/declare-empty-slice
- import: codelingo/effective-go/defer-close-file
# Overwrite one tenet with custom logic
# - import: codelingo/effective-go/comment-first-word-when-empty
- name: comment-first-word-when-empty
flows:
codelingo/review:
comment: |
Every exported function in a program should have a doc comment. The first sentence should be a summary that starts with the name ({{funcName}}) being declared.
From [effective go](https://golang.org/doc/effective_go.html#commentary).
codelingo/rewrite:
place: holder
query: |
import codelingo/ast/go
@review comment
@rewrite --prepend --line "// {{funcName}} is a function."
go.func_decl(depth = any):
# Customisation to exclude test packages
exclude:
go.ident:
name as funcname
regex(/_test/, funcname)
exclude:
go.comment_group
go.ident:
name as funcName
public == "true"
- import: codelingo/effective-go/comment-first-word-when-empty
- name: missing-stop-ticker
flows:
actions:
codelingo/review:
comment: Add `defer {{varName}}.Stop()` to stop the ticker and release associated resources.
query: |