feat: improve gno linter with basic errors support

gnovm/cmd/gno/lint.go

@@ -6,7 +6,11 @@ import (
 	"fmt"
 	"os"
 	"path/filepath"
+	"regexp"
+	"strings"
 
+	gno "github.com/gnolang/gno/gnovm/pkg/gnolang"
+	"github.com/gnolang/gno/gnovm/tests"
 	"github.com/gnolang/gno/tm2/pkg/commands"
 	osm "github.com/gnolang/gno/tm2/pkg/os"
 )
@@ -70,7 +74,7 @@ func execLint(cfg *lintCfg, args []string, io *commands.IO) error {
 			fmt.Fprintf(io.Err, "Linting %q...\n", pkgPath)
 		}
 
-		// 'gno.mod' exists?
+		// Check if 'gno.mod' exists
 		gnoModPath := filepath.Join(pkgPath, "gno.mod")
 		if !osm.FileExists(gnoModPath) {
 			addIssue(lintIssue{
@@ -81,12 +85,90 @@ func execLint(cfg *lintCfg, args []string, io *commands.IO) error {
 			})
 		}
 
-		// TODO: add more checkers
+		// Use `RunMemPackage` to detect basic package errors
+		var (
+			stdout = io.Out
+			stdin  = io.In
+			stderr = io.Err
+
+			testStore = tests.TestStore(
+				rootDir, "",
+				stdin, stdout, stderr,
+				tests.ImportModeStdlibsOnly,
+			)
+
+			reParseRecover = regexp.MustCompile(`^(.+):(\d+): ?(.*)$`)
+		)
+
+		handleError := func() {
+			// Errors here mostly come from: gnovm/pkg/gnolang/preprocess.go
+			if r := recover(); r != nil {
+				var err error
+				switch v := r.(type) {
+				case *gno.PreprocessStackError:
+					err = v.Err
+				case error:
+					err = v
+				default:
+					panic(r)
+				}
+
+				parsedError := strings.TrimSpace(err.Error())
+				parsedError = strings.TrimPrefix(parsedError, pkgPath+"/")
+				matches := reParseRecover.FindStringSubmatch(parsedError)
+				if len(matches) > 0 {
+					addIssue(lintIssue{
+						Code:       lintGnoError,
+						Confidence: 1,
+						Location:   fmt.Sprintf("%s:%s", matches[1], matches[2]),
+						Msg:        strings.TrimSpace(matches[3]),
+					})
+				}
+			}
+		}
+
+		// Run the machine on the target package
+		func() {
+			defer handleError()
+
+			memPkg := gno.ReadMemPackage(filepath.Dir(pkgPath), pkgPath)
+			tm := tests.TestMachine(testStore, stdout, memPkg.Name)
+
+			// 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
+				}
+
+				if strings.HasSuffix(mfile.Name, "_test.gno") {
+					// Keep only test files
+					testfiles.AddFiles(n)
+				}
+			}
+
+			tm.RunFiles(testfiles.Files...)
+		}()
+
+		// TODO: Add more checkers
 	}
 
 	if hasError && cfg.setExitStatus != 0 {
 		os.Exit(cfg.setExitStatus)
 	}
+
+	if verbose {
+		fmt.Println("no lint errors")
+	}
+
 	return nil
 }
 
@@ -95,6 +177,8 @@ type lintCode int
 const (
 	lintUnknown  lintCode = 0
 	lintNoGnoMod lintCode = iota
+	lintGnoError
+
 	// TODO: add new linter codes here.
 )
 

gnovm/cmd/gno/lint_test.go

@@ -11,15 +11,19 @@ func TestLintApp(t *testing.T) {
 			args:                []string{"lint", "--set_exit_status=0", "../../tests/integ/run-main/"},
 			stderrShouldContain: "./../../tests/integ/run-main: missing 'gno.mod' file (code=1).",
 		}, {
-			args:                []string{"lint", "--set_exit_status=0", "../../tests/integ/run-main/"},
-			stderrShouldContain: "./../../tests/integ/run-main: missing 'gno.mod' file (code=1).",
+			args:                []string{"lint", "--set_exit_status=0", "../../tests/integ/undefined-variable-test/undefined_variables_test.gno"},
+			stderrShouldContain: "undefined_variables_test.gno:6: name toto not declared (code=2)",
+		}, {
+			args:                []string{"lint", "--set_exit_status=0", "../../tests/integ/package-not-declared/main.gno"},
+			stderrShouldContain: "main.gno:4: name fmt not declared (code=2).",
 		}, {
 			args: []string{"lint", "--set_exit_status=0", "../../tests/integ/minimalist-gnomod/"},
 			// TODO: raise an error because there is a gno.mod, but no .gno files
 		}, {
 			args: []string{"lint", "--set_exit_status=0", "../../tests/integ/invalid-module-name/"},
 			// TODO: raise an error because gno.mod is invalid
 		},
+
 		// TODO: 'gno mod' is valid?
 		// TODO: is gno source valid?
 		// TODO: are dependencies valid?

gnovm/cmd/gno/main_test.go

@@ -7,6 +7,7 @@ import (
 	"os"
 	"os/exec"
 	"path/filepath"
+	"strconv"
 	"strings"
 	"testing"
 
@@ -153,10 +154,13 @@ func setupTestScript(t *testing.T, txtarDir string) testscript.Params {
 	rootDir := filepath.Dir(string(goModPath))
 	// Build a fresh gno binary in a temp directory
 	gnoBin := filepath.Join(t.TempDir(), "gno")
+
 	err = exec.Command("go", "build", "-o", gnoBin, filepath.Join(rootDir, "gnovm", "cmd", "gno")).Run()
 	require.NoError(t, err)
 	// Define script params
+	updateSripts, _ := strconv.ParseBool(os.Getenv("UPDATE_SCRIPTS"))
 	return testscript.Params{
+		UpdateScripts: updateSripts,
 		Setup: func(env *testscript.Env) error {
 			env.Vars = append(env.Vars,
 				"GNOROOT="+rootDir, // thx PR 1014 :)

gnovm/cmd/gno/testdata/gno_test/lint_bad_import.txtar

@@ -0,0 +1,19 @@
+# testing gno lint command: bad import error
+
+! gno lint ./bad_file.gno
+
+cmp stdout stdout.golden
+cmp stderr stderr.golden
+
+-- bad_file.gno --
+package main
+
+import "python"
+
+func main() {
+	fmt.Println("Hello", 42)
+}
+
+-- stdout.golden --
+-- stderr.golden --
+bad_file.gno:1: unknown import path python (code=2).

gnovm/cmd/gno/testdata/gno_test/lint_file_error.txtar

@@ -0,0 +1,20 @@
+# gno lint: test file error
+
+! gno lint ./i_have_error_test.gno
+
+cmp stdout stdout.golden
+cmp stderr stderr.golden
+
+-- i_have_error_test.gno --
+package main
+
+import "fmt"
+
+func TestIHaveSomeError() {
+	i := undefined_variable
+	fmt.Println("Hello", 42)
+}
+
+-- stdout.golden --
+-- stderr.golden --
+i_have_error_test.gno:6: name undefined_variable not declared (code=2).

gnovm/cmd/gno/testdata/gno_test/lint_file_error_txtar

@@ -0,0 +1,20 @@
+# gno lint: test file error
+
+! gno lint ./i_have_error_test.gno
+
+cmp stdout stdout.golden
+cmp stderr stderr.golden
+
+-- i_have_error_test.gno --
+package main
+
+import "fmt"
+
+func TestIHaveSomeError() {
+	i := undefined_variable
+	fmt.Println("Hello", 42)
+}
+
+-- stdout.golden --
+-- stderr.golden --
+i_have_error_test.gno:6: name undefined_variable not declared (code=2).

gnovm/cmd/gno/testdata/gno_test/lint_no_error.txtar

@@ -0,0 +1,18 @@
+# testing simple gno lint command with any error
+
+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)
+}
+
+-- stdout.golden --
+-- stderr.golden --

gnovm/cmd/gno/testdata/gno_test/lint_no_gnomod.txtar

@@ -0,0 +1,19 @@
+# gno lint: no gnomod
+
+! gno lint .
+
+cmp stdout stdout.golden
+cmp stderr stderr.golden
+
+-- good_file.gno --
+package main
+
+import "fmt"
+
+func main() {
+	fmt.Println("Hello", 42)
+}
+
+-- stdout.golden --
+-- stderr.golden --
+./.: missing 'gno.mod' file (code=1).

gnovm/cmd/gno/testdata/gno_test/lint_not_declared.txtar

@@ -0,0 +1,20 @@
+# testing gno lint command: not declared error
+
+! gno lint ./bad_file.gno
+
+cmp stdout stdout.golden
+cmp stderr stderr.golden
+
+-- bad_file.gno --
+package main
+
+import "fmt"
+
+func main() {
+  hello.Foo()
+	fmt.Println("Hello", 42)
+}
+
+-- stdout.golden --
+-- stderr.golden --
+bad_file.gno:6: name hello not declared (code=2).

gnovm/pkg/gnolang/debug.go

@@ -4,6 +4,7 @@ import (
 	"fmt"
 	"net/http"
 	"os"
+	"strings"
 	"time"
 
 	// Ignore pprof import, as the server does not
@@ -76,6 +77,40 @@ func (d debugging) Errorf(format string, args ...interface{}) {
 	}
 }
 
+// PreprocessStackError wraps a processing error along with its associated
+// preprocessing stack for enhanced error reporting.
+type PreprocessStackError struct {
+	Err   error
+	Stack []BlockNode
+}
+
+// PreprocessError returns the encapsulated error message.
+func (p *PreprocessStackError) PreprocessError() string {
+	return p.Err.Error()
+}
+
+// PreprocessStack produces a string representation of the preprocessing stack
+// trace that was associated with the error occurrence.
+func (p *PreprocessStackError) PreprocessStack() string {
+	var stacktrace strings.Builder
+	for i := len(p.Stack) - 1; i >= 0; i-- {
+		sbn := p.Stack[i]
+		fmt.Fprintf(&stacktrace, "stack %d: %s\n", i, sbn.String())
+	}
+	return stacktrace.String()
+}
+
+// Error consolidates and returns the full error message, including
+// the actual error followed by its associated preprocessing stack.
+func (p *PreprocessStackError) Error() string {
+	var err strings.Builder
+	fmt.Fprintf(&err, "%s:", p.PreprocessError())
+	fmt.Fprintln(&err, "--- preprocess stack ---")
+	fmt.Fprint(&err, p.PreprocessStack())
+	fmt.Fprintf(&err, "------------------------")
+	return err.String()
+}
+
 // ----------------------------------------
 // Exposed errors accessors
 // File tests may access debug errors.
@@ -107,3 +142,12 @@ func DisableDebug() {
 func EnableDebug() {
 	enabled = true
 }
+
+type DebugError struct {
+	error
+	Metas interface{}
+}
+
+func (d *DebugError) Error() string {
+	return d.Error()
+}

gnovm/pkg/gnolang/preprocess.go

@@ -154,24 +154,27 @@ func Preprocess(store Store, ctx BlockNode, n Node) Node {
 
 		defer func() {
 			if r := recover(); r != nil {
-				fmt.Println("--- preprocess stack ---")
-				for i := len(stack) - 1; i >= 0; i-- {
-					sbn := stack[i]
-					fmt.Printf("stack %d: %s\n", i, sbn.String())
-				}
-				fmt.Println("------------------------")
 				// before re-throwing the error, append location information to message.
 				loc := last.GetLocation()
 				if nline := n.GetLine(); nline > 0 {
 					loc.Line = nline
 				}
-				if rerr, ok := r.(error); ok {
+
+				var err error
+				rerr, ok := r.(error)
+				if ok {
 					// NOTE: gotuna/gorilla expects error exceptions.
-					panic(errors.Wrap(rerr, loc.String()))
+					err = errors.Wrap(rerr, loc.String())
 				} else {
 					// NOTE: gotuna/gorilla expects error exceptions.
-					panic(errors.New(fmt.Sprintf("%s: %v", loc.String(), r)))
+					err = errors.New(fmt.Sprintf("%s: %v", loc.String(), r))
 				}
+
+				// Re-throw the error after wrapping it with the preprocessing stack information.
+				panic(&PreprocessStackError{
+					Err:   err,
+					Stack: stack,
+				})
 			}
 		}()
 		if debug {

gnovm/pkg/repl/repl_test.go

@@ -69,7 +69,7 @@ var fixtures = []struct {
 		CodeSteps: []step{
 			{
 				Line:  "importasdasd",
-				Error: "recovered from panic: test/test1.gno:7: name importasdasd not declared",
+				Error: "test/test1.gno:7: name importasdasd not declared",
 			},
 			{
 				Line: "var a := 1",

gnovm/tests/integ/package-not-declared/gno.mod

@@ -0,0 +1 @@
+module gno.land/tests/nodeclared