feat(cmd/gno): perform type checking when calling linter

gnovm/cmd/gno/lint.go

@@ -6,17 +6,19 @@
 	"flag"
 	"fmt"
 	"go/scanner"
+	"go/types"
 	"io"
 	"os"
 	"path/filepath"
 	"regexp"
 	"strings"
 
+	"github.com/gnolang/gno/gnovm"
 	"github.com/gnolang/gno/gnovm/pkg/gnoenv"
 	gno "github.com/gnolang/gno/gnovm/pkg/gnolang"
+	"github.com/gnolang/gno/gnovm/pkg/gnomod"
 	"github.com/gnolang/gno/gnovm/pkg/test"
 	"github.com/gnolang/gno/tm2/pkg/commands"
-	osm "github.com/gnolang/gno/tm2/pkg/os"
 	"go.uber.org/multierr"
 )
 
@@ -50,6 +52,31 @@
 	fs.StringVar(&c.rootDir, "root-dir", rootdir, "clone location of github.com/gnolang/gno (gno tries to guess it)")
 }
 
+type lintCode int
+
+const (
+	lintUnknown lintCode = iota
+	lintGnoMod
+	lintGnoError
+	lintParserError
+	lintTypeCheckError
+
+	// TODO: add new linter codes here.
+)
+
+type lintIssue struct {
+	Code       lintCode
+	Msg        string
+	Confidence float64 // 1 is 100%
+	Location   string  // file:line, or equivalent
+	// TODO: consider writing fix suggestions
+}
+
+func (i lintIssue) String() string {
+	// TODO: consider crafting a doc URL based on Code.
+	return fmt.Sprintf("%s: %s (code=%d).", i.Location, i.Msg, i.Code)
+}
+
 func execLint(cfg *lintCfg, args []string, io commands.IO) error {
 	if len(args) < 1 {
 		return flag.ErrHelp
@@ -72,20 +99,25 @@
 
 	for _, pkgPath := range pkgPaths {
 		if verbose {
-			fmt.Fprintf(io.Err(), "Linting %q...\n", pkgPath)
+			io.ErrPrintln(pkgPath)
+		}
+
+		info, err := os.Stat(pkgPath)
+		if err == nil && !info.IsDir() {
+			pkgPath = filepath.Dir(pkgPath)
 		}
 
 		// Check if 'gno.mod' exists
-		gnoModPath := filepath.Join(pkgPath, "gno.mod")
-		if !osm.FileExists(gnoModPath) {
-			hasError = true
+		gmFile, err := gnomod.ParseAt(pkgPath)
+		if err != nil {
 			issue := lintIssue{
-				Code:       lintNoGnoMod,
+				Code:       lintGnoMod,
 				Confidence: 1,
 				Location:   pkgPath,
-				Msg:        "missing 'gno.mod' file",
+				Msg:        err.Error(),
 			}
-			fmt.Fprint(io.Err(), issue.String()+"\n")
+			io.ErrPrintln(issue)
+			hasError = true
 		}
 
 		// Handle runtime errors
@@ -96,42 +128,32 @@
 				stdin, stdout, stderr,
 			)
 
-			targetPath := pkgPath
-			info, err := os.Stat(pkgPath)
-			if err == nil && !info.IsDir() {
-				targetPath = filepath.Dir(pkgPath)
+			memPkg := gno.MustReadMemPackage(pkgPath, pkgPath)
+
+			// Run type checking
+			if gmFile == nil || !gmFile.Draft {
+				foundErr, err := lintTypeCheck(io, memPkg, testStore)
+				if err != nil {
+					io.ErrPrintln(err)
+					hasError = true
+				} else {
+					hasError = foundErr || hasError
+				}
+			} else if verbose {
+				io.ErrPrintfln("%s: module is draft, skipping type check", pkgPath)
 			}
 
-			memPkg := gno.MustReadMemPackage(targetPath, targetPath)
 			tm := test.Machine(testStore, stdout, memPkg.Path)
 			defer tm.Release()
 
 			// Check package
 			tm.RunMemPackage(memPkg, true)
 
 			// Check test files
-			testfiles := &gno.FileSet{}
-			for _, mfile := range memPkg.Files {
-				if !strings.HasSuffix(mfile.Name, ".gno") {
-					continue // Skip non-GNO files
-				}
-
-				n, _ := gno.ParseFile(mfile.Name, mfile.Body)
-				if n == nil {
-					continue // Skip empty files
-				}
+			testFiles := lintTestFiles(memPkg)
 
-				// XXX: package ending with `_test` is not supported yet
-				if strings.HasSuffix(mfile.Name, "_test.gno") && !strings.HasSuffix(string(n.PkgName), "_test") {
-					// Keep only test files
-					testfiles.AddFiles(n)
-				}
-			}
-
-			tm.RunFiles(testfiles.Files...)
+			tm.RunFiles(testFiles.Files...)
 		}) || hasError
-
-		// TODO: Add more checkers
 	}
 
 	if hasError {
@@ -141,6 +163,66 @@
 	return nil
 }
 
+func lintTypeCheck(io commands.IO, memPkg *gnovm.MemPackage, testStore gno.Store) (errorsFound bool, err error) {
+	tcErr := gno.TypeCheckMemPackageTest(memPkg, testStore)
+	if tcErr == nil {
+		return false, nil
+	}
+
+	errs := multierr.Errors(tcErr)
+	for _, err := range errs {
+		switch err := err.(type) {
+		case types.Error:
+			io.ErrPrintln(lintIssue{
+				Code:       lintTypeCheckError,
+				Msg:        err.Msg,
+				Confidence: 1,
+				Location:   err.Fset.Position(err.Pos).String(),
+			})
+		case scanner.ErrorList:
+			for _, scErr := range err {
+				io.ErrPrintln(lintIssue{
+					Code:       lintParserError,
+					Msg:        scErr.Msg,
+					Confidence: 1,
+					Location:   scErr.Pos.String(),
+				})
+			}
+		case scanner.Error:
+			io.ErrPrintln(lintIssue{
+				Code:       lintParserError,
+				Msg:        err.Msg,
+				Confidence: 1,
+				Location:   err.Pos.String(),
+			})
+		default:
+			return false, fmt.Errorf("unexpected error type: %T", err)
+		}
+	}
+	return true, nil
+}
+
+func lintTestFiles(memPkg *gnovm.MemPackage) *gno.FileSet {
+	testfiles := &gno.FileSet{}
+	for _, mfile := range memPkg.Files {
+		if !strings.HasSuffix(mfile.Name, ".gno") {
+			continue // Skip non-GNO files
+		}
+
+		n, _ := gno.ParseFile(mfile.Name, mfile.Body)
+		if n == nil {
+			continue // Skip empty files
+		}
+
+		// XXX: package ending with `_test` is not supported yet
+		if strings.HasSuffix(mfile.Name, "_test.gno") && !strings.HasSuffix(string(n.PkgName), "_test") {
+			// Keep only test files
+			testfiles.AddFiles(n)
+		}
+	}
+	return testfiles
+}
+
 func guessSourcePath(pkg, source string) string {
 	if info, err := os.Stat(pkg); !os.IsNotExist(err) && !info.IsDir() {
 		pkg = filepath.Dir(pkg)
@@ -198,29 +280,6 @@
 	return
 }
 
-type lintCode int
-
-const (
-	lintUnknown  lintCode = 0
-	lintNoGnoMod lintCode = iota
-	lintGnoError
-
-	// TODO: add new linter codes here.
-)
-
-type lintIssue struct {
-	Code       lintCode
-	Msg        string
-	Confidence float64 // 1 is 100%
-	Location   string  // file:line, or equivalent
-	// TODO: consider writing fix suggestions
-}
-
-func (i lintIssue) String() string {
-	// TODO: consider crafting a doc URL based on Code.
-	return fmt.Sprintf("%s: %s (code=%d).", i.Location, i.Msg, i.Code)
-}
-
 func issueFromError(pkgPath string, err error) lintIssue {
 	var issue lintIssue
 	issue.Confidence = 1

gnovm/cmd/gno/lint_test.go

@@ -9,7 +9,7 @@ func TestLintApp(t *testing.T) {
 			errShouldBe: "flag: help requested",
 		}, {
 			args:                []string{"lint", "../../tests/integ/run_main/"},
-			stderrShouldContain: "./../../tests/integ/run_main: missing 'gno.mod' file (code=1).",
+			stderrShouldContain: "./../../tests/integ/run_main: gno.mod file not found in current or any parent directory (code=1).",
 			errShouldBe:         "exit code: 1",
 		}, {
 			args:                []string{"lint", "../../tests/integ/undefined_variable_test/undefined_variables_test.gno"},
@@ -27,23 +27,25 @@ func TestLintApp(t *testing.T) {
 			args:                []string{"lint", "../../tests/integ/several-files-multiple-errors/main.gno"},
 			stderrShouldContain: "../../tests/integ/several-files-multiple-errors/file2.gno:3:5: expected 'IDENT', found '{' (code=2).\n../../tests/integ/several-files-multiple-errors/file2.gno:5:1: expected type, found '}' (code=2).\n../../tests/integ/several-files-multiple-errors/main.gno:5:5: expected ';', found example (code=2).\n../../tests/integ/several-files-multiple-errors/main.gno:6:2: expected '}', found 'EOF' (code=2).\n",
 			errShouldBe:         "exit code: 1",
-		}, {
-			args:                []string{"lint", "../../tests/integ/run_main/"},
-			stderrShouldContain: "./../../tests/integ/run_main: missing 'gno.mod' file (code=1).",
-			errShouldBe:         "exit code: 1",
 		}, {
 			args: []string{"lint", "../../tests/integ/minimalist_gnomod/"},
 			// TODO: raise an error because there is a gno.mod, but no .gno files
 		}, {
 			args: []string{"lint", "../../tests/integ/invalid_module_name/"},
 			// TODO: raise an error because gno.mod is invalid
+		}, {
+			args:                []string{"lint", "../../tests/integ/invalid_gno_file/"},
+			stderrShouldContain: "../../tests/integ/invalid_gno_file/invalid.gno:1:1: expected 'package', found packag (code=2)",
+			errShouldBe:         "exit code: 1",
+		}, {
+			args:                []string{"lint", "../../tests/integ/typecheck_missing_return/"},
+			stderrShouldContain: "../../tests/integ/typecheck_missing_return/main.gno:5:1: missing return (code=4).",
+			errShouldBe:         "exit code: 1",
 		},
 
 		// TODO: 'gno mod' is valid?
-		// TODO: is gno source valid?
 		// TODO: are dependencies valid?
 		// TODO: is gno source using unsafe/discouraged features?
-		// TODO: consider making `gno transpile; go lint *gen.go`
 		// TODO: check for imports of native libs from non _test.gno files
 	}
 	testMainCaseRun(t, tc)

gnovm/cmd/gno/testdata/gno_lint/bad_import.txtar → gnovm/cmd/gno/testdata/lint/bad_import.txtar

@@ -11,9 +11,13 @@ package main
 import "python"
 
 func main() {
-	fmt.Println("Hello", 42)
+	println("Hello", 42)
 }
 
+-- gno.mod --
+module gno.land/p/test
+
 -- stdout.golden --
 -- stderr.golden --
+bad_file.gno:3:8: could not import python (import not found: python) (code=4).
 bad_file.gno:3:8: unknown import path python (code=2).

gnovm/cmd/gno/testdata/gno_lint/file_error.txtar → gnovm/cmd/gno/testdata/lint/file_error.txtar

@@ -15,6 +15,9 @@ func TestIHaveSomeError() {
 	fmt.Println("Hello", 42)
 }
 
+-- gno.mod --
+module gno.land/p/test
+
 -- stdout.golden --
 -- stderr.golden --
 i_have_error_test.gno:6:7: name undefined_variable not declared (code=2).

gnovm/cmd/gno/testdata/gno_lint/no_error.txtar → gnovm/cmd/gno/testdata/lint/no_error.txtar

@@ -1,18 +1,19 @@
 # testing simple gno lint command with any error
 
-gno lint ./good_file.gno 
+gno lint ./good_file.gno
 
 cmp stdout stdout.golden
 cmp stdout stderr.golden
 
 -- good_file.gno --
 package main
 
-import "fmt"
-
 func main() {
-	fmt.Println("Hello", 42)
+	println("Hello", 42)
 }
 
+-- gno.mod --
+module gno.land/p/demo/test
+
 -- stdout.golden --
 -- stderr.golden --

gnovm/cmd/gno/testdata/gno_lint/no_gnomod.txtar → gnovm/cmd/gno/testdata/lint/no_gnomod.txtar

@@ -8,12 +8,10 @@ cmp stderr stderr.golden
 -- good_file.gno --
 package main
 
-import "fmt"
-
 func main() {
-	fmt.Println("Hello", 42)
+	println("Hello", 42)
 }
 
 -- stdout.golden --
 -- stderr.golden --
-./.: missing 'gno.mod' file (code=1).
+./.: parsing gno.mod at ./.: gno.mod file not found in current or any parent directory (code=1).

gnovm/cmd/gno/testdata/gno_lint/not_declared.txtar → gnovm/cmd/gno/testdata/lint/not_declared.txtar

@@ -8,13 +8,15 @@ cmp stderr stderr.golden
 -- bad_file.gno --
 package main
 
-import "fmt"
-
 func main() {
-  hello.Foo()
-	fmt.Println("Hello", 42)
+	hello.Foo()
+	println("Hello", 42)
 }
 
+-- gno.mod --
+module gno.land/p/demo/hello
+
 -- stdout.golden --
 -- stderr.golden --
-bad_file.gno:6:3: name hello not declared (code=2).
+bad_file.gno:4:2: undefined: hello (code=4).
+bad_file.gno:4:2: name hello not declared (code=2).

gnovm/cmd/gno/testdata_test.go

@@ -24,7 +24,6 @@ func Test_Scripts(t *testing.T) {
 		}
 
 		name := dir.Name()
-		t.Logf("testing: %s", name)
 		t.Run(name, func(t *testing.T) {
 			updateScripts, _ := strconv.ParseBool(os.Getenv("UPDATE_SCRIPTS"))
 			p := testscript.Params{