71 lines
1.7 KiB
Go
71 lines
1.7 KiB
Go
// Package singlechecker defines the main function for an analysis
|
|
// driver with only a single analysis.
|
|
// This package makes it easy for a provider of an analysis package to
|
|
// also provide a standalone tool that runs just that analysis.
|
|
//
|
|
// For example, if example.org/findbadness is an analysis package,
|
|
// all that is needed to define a standalone tool is a file,
|
|
// example.org/findbadness/cmd/findbadness/main.go, containing:
|
|
//
|
|
// // The findbadness command runs an analysis.
|
|
// package main
|
|
//
|
|
// import (
|
|
// "example.org/findbadness"
|
|
// "golang.org/x/tools/go/analysis/singlechecker"
|
|
// )
|
|
//
|
|
// func main() { singlechecker.Main(findbadness.Analyzer) }
|
|
//
|
|
package singlechecker
|
|
|
|
import (
|
|
"flag"
|
|
"fmt"
|
|
"log"
|
|
"os"
|
|
"strings"
|
|
|
|
"golang.org/x/tools/go/analysis"
|
|
"golang.org/x/tools/go/analysis/internal/checker"
|
|
)
|
|
|
|
// Main is the main function for a checker command for a single analysis.
|
|
func Main(a *analysis.Analyzer) {
|
|
log.SetFlags(0)
|
|
log.SetPrefix(a.Name + ": ")
|
|
|
|
checker.RegisterFlags()
|
|
|
|
a.Flags.VisitAll(func(f *flag.Flag) {
|
|
if flag.Lookup(f.Name) != nil {
|
|
log.Printf("%s flag -%s would conflict with driver; skipping", a.Name, f.Name)
|
|
return
|
|
}
|
|
flag.Var(f.Value, f.Name, f.Usage)
|
|
})
|
|
|
|
flag.Usage = func() {
|
|
paras := strings.Split(a.Doc, "\n\n")
|
|
fmt.Fprintf(os.Stderr, "%s: %s\n\n", a.Name, paras[0])
|
|
fmt.Printf("Usage: %s [-flag] [package]\n\n", a.Name)
|
|
if len(paras) > 1 {
|
|
fmt.Println(strings.Join(paras[1:], "\n\n"))
|
|
}
|
|
fmt.Println("\nFlags:")
|
|
flag.PrintDefaults()
|
|
}
|
|
flag.Parse()
|
|
|
|
args := flag.Args()
|
|
|
|
if len(args) == 0 {
|
|
flag.Usage()
|
|
os.Exit(1)
|
|
}
|
|
|
|
if err := checker.Run(args, []*analysis.Analyzer{a}); err != nil {
|
|
log.Fatal(err)
|
|
}
|
|
}
|