/
checkcomments.go
136 lines (113 loc) · 3.45 KB
/
checkcomments.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
// Copyright 2021 FerretDB Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// Package main contains linter for comments.
package main
import (
"context"
"flag"
"log"
"regexp"
"strconv"
"strings"
"github.com/FerretDB/gh"
"golang.org/x/tools/go/analysis"
"golang.org/x/tools/go/analysis/singlechecker"
)
// todoRE represents correct // TODO comment format.
var todoRE = regexp.MustCompile(`^// TODO (\Qhttps://github.com/FerretDB/\E([-\w]+)/issues/(\d+))$`)
// analyzer represents the checkcomments analyzer.
var analyzer = &analysis.Analyzer{
Name: "checkcomments",
Doc: "check TODO comments",
Run: run,
Flags: *flag.NewFlagSet("", flag.ExitOnError),
}
// init initializes the analyzer flags.
func init() {
analyzer.Flags.Bool("offline", false, "do not check issues open/closed status")
analyzer.Flags.Bool("cache-debug", false, "log cache hits/misses")
analyzer.Flags.Bool("client-debug", false, "log GitHub API requests/responses")
}
// main runs the analyzer.
func main() {
singlechecker.Main(analyzer)
}
// run analyses TODO comments.
func run(pass *analysis.Pass) (any, error) {
var client *client
if !pass.Analyzer.Flags.Lookup("offline").Value.(flag.Getter).Get().(bool) {
p, err := cacheFilePath()
if err != nil {
log.Panic(err)
}
cacheDebugF := gh.NoopPrintf
if pass.Analyzer.Flags.Lookup("cache-debug").Value.(flag.Getter).Get().(bool) {
cacheDebugF = log.New(log.Writer(), "", log.Flags()).Printf
}
clientDebugF := gh.NoopPrintf
if pass.Analyzer.Flags.Lookup("client-debug").Value.(flag.Getter).Get().(bool) {
clientDebugF = log.New(log.Writer(), "client-debug: ", log.Flags()).Printf
}
if client, err = newClient(p, log.Printf, cacheDebugF, clientDebugF); err != nil {
log.Panic(err)
}
}
for _, f := range pass.Files {
for _, cg := range f.Comments {
for _, c := range cg.List {
line := c.Text
// the space between `//` and `TODO` is always added by `task fmt`
if !strings.HasPrefix(line, "// TODO") {
continue
}
if f.Name.Name == "testdata" {
line, _, _ = strings.Cut(line, ` // want "`)
}
match := todoRE.FindStringSubmatch(line)
if len(match) != 4 {
pass.Reportf(c.Pos(), "invalid TODO: incorrect format")
continue
}
url := match[1]
repo := match[2]
num, err := strconv.Atoi(match[3])
if err != nil {
log.Panic(err)
}
if num <= 0 {
pass.Reportf(c.Pos(), "invalid TODO: incorrect issue number")
continue
}
if client == nil {
continue
}
status, err := client.IssueStatus(context.TODO(), url, repo, num)
if err != nil {
log.Panic(err)
}
switch status {
case issueOpen:
// nothing
case issueClosed:
pass.Reportf(c.Pos(), "invalid TODO: linked issue %s is closed", url)
case issueNotFound:
pass.Reportf(c.Pos(), "invalid TODO: linked issue %s is not found", url)
default:
log.Panicf("unknown issue status: %s", status)
}
}
}
}
return nil, nil
}