Merge pull request #41 from gostaticanalysis/release-v2.0.3

Release v2.0.3

.github/workflows/testandvet.yml

@@ -0,0 +1,52 @@
+name: Test and Vet
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+      - release-v2.*.*
+  release:
+    types:
+      - published
+      - created
+      - edited
+
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  test:
+    runs-on: ubuntu-20.04
+
+    steps:
+    - name: Install Go
+      uses: actions/setup-go@v2
+      with:
+        go-version: 1.16.x
+
+    - name: Checkout code
+      uses: actions/checkout@v2
+
+    - name: Cache Go module and build cache
+      uses: actions/cache@v2
+      with:
+        key: go-${{ hashFiles('**/go.sum') }}
+        path: |
+          ~/go/pkg/mod
+        restore-keys: |
+          go-
+
+    - name: Install tennvet
+      run: |
+        GOBIN=$(pwd)/v2 go install github.com/tenntenn/tennvet@latest
+
+    - name: Test and vet
+      run: |
+        cd v2
+        go vet ./...
+        go vet -vettool=$(pwd)/tennvet ./...
+        go test -v -race ./...

README.md

@@ -2,7 +2,7 @@
 
 skeleton creates skeleton codes for a modularized static analysis tool with [x/tools/go/analysis](https://golang.org/x/tools/go/analysis) package.
 
-## x/tools/go/analysis pacakge
+## x/tools/go/analysis package
 
 [x/tools/go/analysis](https://golang.org/x/tools/go/analysis) package provides a type `analysis.Analyzer` which is unit of analyzers in modularized static analysis tool.
 

v2/go.sum

@@ -16,6 +16,7 @@ golang.org/x/sync v0.0.0-20201020160332-67f06af15bc9/go.mod h1:RxMgew5VJxzue5/jJ
 golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
 golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20200930185726-fdedc70b468f/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20210119212857-b64e53b001e4 h1:myAQVi0cGEoqQVR5POX+8RR2mrocKqNN1hmeMqhX27k=
 golang.org/x/sys v0.0.0-20210119212857-b64e53b001e4/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
 golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=

v2/skeleton/fs.go

@@ -133,7 +133,7 @@ func create(prompt *Prompt, path string, policy overwritePolicy) (io.WriteCloser
 	exist, err := isExist(path)
 	if err != nil {
 		return nil, err
-	}	
+	}
 
 	if !exist {
 		return os.Create(path)

v2/skeleton/generator.go

@@ -3,9 +3,11 @@ package skeleton
 import (
 	"bytes"
 	"io/fs"
+	"path/filepath"
 	"text/template"
 
 	"github.com/josharian/txtarfs"
+	"golang.org/x/tools/imports"
 	"golang.org/x/tools/txtar"
 )
 
@@ -18,7 +20,23 @@ func (g *Generator) Run(info *Info) (fs.FS, error) {
 	if err := g.template().Execute(&buf, info); err != nil {
 		return nil, err
 	}
-	return txtarfs.As(txtar.Parse(buf.Bytes())), nil
+	ar := txtar.Parse(buf.Bytes())
+	for i := range ar.Files {
+		if filepath.Ext(ar.Files[i].Name) != ".go" ||
+			len(bytes.TrimSpace(ar.Files[i].Data)) == 0 {
+			continue
+		}
+		opt := &imports.Options{
+			Comments:   true,
+			FormatOnly: true,
+		}
+		src, err := imports.Process(ar.Files[i].Name, ar.Files[i].Data, opt)
+		if err != nil {
+			return nil, err
+		}
+		ar.Files[i].Data = src
+	}
+	return txtarfs.As(ar), nil
 }
 
 func (g *Generator) template() *template.Template {

v2/skeleton/info.go

@@ -1,10 +1,10 @@
 package skeleton
 
 type Info struct {
-	Kind        Kind
-	Checker     Checker
-	Pkg         string
-	Path        string
-	Cmd         bool
-	Plugin bool
+	Kind    Kind
+	Checker Checker
+	Pkg     string
+	Path    string
+	Cmd     bool
+	Plugin  bool
 }

v2/skeleton/skeleton.go

@@ -47,6 +47,9 @@ func (s *Skeleton) Run(version string, args []string) int {
 	}
 
 	info.Path = flags.Arg(0)
+	if prefix := os.Getenv("SKELETON_PREFIX"); prefix != "" {
+		info.Path = path.Join(prefix, info.Path)
+	}
 	// allow package name only
 	if module.CheckImportPath(info.Path) != nil {
 		flags.Usage()
@@ -73,13 +76,9 @@ func (s *Skeleton) parseFlag(args []string, info *Info) (*flag.FlagSet, error) {
 		flags.PrintDefaults()
 	}
 	flags.Var(&info.Checker, "checker", "[unit,single,multi]")
-	if info.Checker == "" {
-		info.Checker = CheckerUnit
-	}
+
 	flags.Var(&info.Kind, "kind", "[inspect,ssa,codegen]")
-	if info.Kind == "" {
-		info.Kind = KindInspect
-	}
+
 	flags.BoolVar(&info.Cmd, "cmd", true, "create main file")
 	flags.BoolVar(&info.Plugin, "plugin", false, "create golangci-lint plugin")
 	flags.StringVar(&info.Pkg, "pkg", "", "package name")
@@ -88,6 +87,19 @@ func (s *Skeleton) parseFlag(args []string, info *Info) (*flag.FlagSet, error) {
 		return nil, err
 	}
 
+	if info.Kind == "" {
+		info.Kind = KindInspect
+	}
+
+	if info.Checker == "" {
+		switch info.Kind {
+		case KindCodegen:
+			info.Checker = CheckerSingle
+		default:
+			info.Checker = CheckerUnit
+		}
+	}
+
 	return flags, nil
 }
 

v2/skeleton/skeleton_test.go

@@ -75,6 +75,10 @@ func TestSkeletonRun(t *testing.T) {
 				t.Errorf("exit code want %d got %d", tt.wantExitCode, gotExitCode)
 			}
 
+			if tt.wantExitCode == 0 && errout.String() != "" {
+				t.Error("exit code want 0 but error messages are outputed", errout.String())
+			}
+
 			if tt.wantOutput != "" && out.String() != tt.wantOutput {
 				t.Errorf("output want %s got %s", tt.wantOutput, out.String())
 			}

v2/skeleton/testdata/nooption.golden

@@ -7,7 +7,6 @@ import (
 )
 
 func main() { unitchecker.Main(example.Analyzer) }
-
 -- example/example.go --
 package example
 

v2/skeleton/testdata/onlypkgname.golden

@@ -3,11 +3,11 @@ package main
 
 import (
 	"example"
+
 	"golang.org/x/tools/go/analysis/unitchecker"
 )
 
 func main() { unitchecker.Main(example.Analyzer) }
-
 -- example/example.go --
 package example
 
@@ -56,6 +56,7 @@ import (
 	"testing"
 
 	"example"
+
 	"github.com/gostaticanalysis/testutil"
 	"golang.org/x/tools/go/analysis/analysistest"
 )

v2/skeleton/testdata/overwrite-cancel.golden

@@ -7,7 +7,6 @@ import (
 )
 
 func main() { unitchecker.Main(example.Analyzer) }
-
 -- example/example.go --
 package example
 

v2/skeleton/testdata/overwrite-confirm-no.golden

@@ -7,7 +7,6 @@ import (
 )
 
 func main() { unitchecker.Main(example.Analyzer) }
-
 -- example/example.go --
 package example
 

v2/skeleton/testdata/overwrite-confirm-yes.golden

@@ -7,7 +7,6 @@ import (
 )
 
 func main() { unitchecker.Main(example.Analyzer) }
-
 -- example/example.go --
 package example
 

v2/skeleton/testdata/overwrite-force.golden

@@ -7,7 +7,6 @@ import (
 )
 
 func main() { unitchecker.Main(example.Analyzer) }
-
 -- example/example.go --
 package example
 

v2/skeleton/testdata/overwrite-newonly.golden

@@ -7,7 +7,6 @@ import (
 )
 
 func main() { unitchecker.Main(example.Analyzer) }
-
 -- example/example.go --
 package example
 

v2/skeleton/testdata/plugin.golden

@@ -7,7 +7,6 @@ import (
 )
 
 func main() { unitchecker.Main(example.Analyzer) }
-
 -- example/example.go --
 package example
 

v2/version.txt

@@ -1 +1 @@
-v2.0.2
+v2.0.3