Add formatted code and linting (#149)

* Add gofumpt and golangci-lint

* Remove trailing spaces from links

* Replace interface{} with any

.github/workflows/go.yml

@@ -7,7 +7,6 @@ on:
     branches: [ master ]
 
 jobs:
-
   build:
     name: Build
     runs-on: ubuntu-latest
@@ -21,5 +20,11 @@ jobs:
       with:
         go-version-file: 'go.mod'
 
+    - name: Lint
+      uses: golangci/golangci-lint-action@v6
+      with:
+        # Require: The version of golangci-lint to use.
+        version: latest
+
     - name: Build and Test
       run: go run build.go test

.golangci.yml

@@ -0,0 +1,7 @@
+linters:
+  enable:
+    - revive
+    - gofumpt
+    - errorlint
+    - godot
+    - errname

LINKS.md

@@ -1,21 +1,21 @@
-https://www.microsoft.com/en-us/research/blog/fp2-fully-in-place-functional-programming-provides-memory-reuse-for-pure-functional-programs/  
+https://www.microsoft.com/en-us/research/blog/fp2-fully-in-place-functional-programming-provides-memory-reuse-for-pure-functional-programs/
 
-https://medium.com/@octskyward/graal-truffle-134d8f28fb69#.jo3luf4dn  
-http://nez-peg.github.io/  
-https://en.wikipedia.org/wiki/DFA_minimization  
+https://medium.com/@octskyward/graal-truffle-134d8f28fb69#.jo3luf4dn
+http://nez-peg.github.io/
+https://en.wikipedia.org/wiki/DFA_minimization
 
-https://news.ycombinator.com/item?id=14589173  
-http://jamey.thesharps.us/2017/06/search-based-compiler-code-generation.html  
+https://news.ycombinator.com/item?id=14589173
+http://jamey.thesharps.us/2017/06/search-based-compiler-code-generation.html
 
-https://news.ycombinator.com/item?id=15105119  
-https://en.wikipedia.org/wiki/Tree_transducer  
+https://news.ycombinator.com/item?id=15105119
+https://en.wikipedia.org/wiki/Tree_transducer
 
 # Type-Driven Program Synthesis
-https://news.ycombinator.com/item?id=18251145  
-https://www.youtube.com/watch?v=HnOix9TFy1A  
-http://comcom.csail.mit.edu/comcom/#welcome  
-https://bitbucket.org/nadiapolikarpova/synquid  
+https://news.ycombinator.com/item?id=18251145
+https://www.youtube.com/watch?v=HnOix9TFy1A
+http://comcom.csail.mit.edu/comcom/#welcome
+https://bitbucket.org/nadiapolikarpova/synquid
 
 # Formality – An efficient programming language and proof assistant
-https://news.ycombinator.com/item?id=18230148  
-https://github.com/maiavictor/formality  
+https://news.ycombinator.com/item?id=18230148
+https://github.com/maiavictor/formality

README.md

@@ -228,7 +228,30 @@ Will print out `"capture"`. The captured string is stored in `buffer[begin:end]`
 
 Testing a grammar usually requires more than the average unit testing with multiple inputs and outputs. Grammars are also usually not for just one language implementation. Consider maintaining a list of inputs with expected outputs in a structured file format such as JSON or YAML and parsing it for testing or using one of the available options for Go such as Rob Muhlestein's [`tinout`](https://github.com/robmuh/tinout) package.
 
-## Files
+## Development
+
+### Requirements
+
+* [Golang](https://golang.org/doc/install), see [go.mod](go.mod) for version
+* [golangci-lint latest version](https://github.com/golangci/golangci-lint#install)
+* gofumpt
+  ```
+  go install mvdan.cc/gofumpt@latest
+  ```
+
+### Lint code
+
+```
+golangci-lint run
+```
+
+### Format code
+
+```
+gofumpt -l -w .
+```
+
+### Files
 
 * `bootstrap/main.go` - bootstrap syntax tree of peg
 * `tree/peg.go` - syntax tree and code generator

bootstrap/main.go

@@ -530,11 +530,11 @@ func main() {
 	})
 
 	filename := "bootstrap.peg.go"
-	out, err := os.OpenFile(filename, os.O_RDWR|os.O_CREATE|os.O_TRUNC, 0644)
+	out, err := os.OpenFile(filename, os.O_RDWR|os.O_CREATE|os.O_TRUNC, 0o644)
 	if err != nil {
 		fmt.Printf("%v: %v\n", filename, err)
 		return
 	}
 	defer out.Close()
-	t.Compile(filename, os.Args, out)
+	_ = t.Compile(filename, os.Args, out)
 }

build.go

@@ -55,11 +55,11 @@ package main
 
 const (
 	// VERSION is the version of peg
-	VERSION   = "{{.Version}}"
+	VERSION = "{{.Version}}"
 	// BUILDTIME is the build time of peg
 	BUILDTIME = "{{.Buildtime}}"
 	// COMMIT is the commit hash of peg
-	COMMIT    = "{{.Commit}}"
+	COMMIT = "{{.Commit}}"
 	// IS_TAGGED is there a version
 	IS_TAGGED = {{.IsTagged}}
 )
@@ -114,7 +114,7 @@ func buildinfo() {
 
 var processed = make(map[string]bool)
 
-func done(file string, deps ...interface{}) bool {
+func done(file string, deps ...any) bool {
 	fini := true
 	file = filepath.FromSlash(file)
 	info, err := os.Stat(file)
@@ -204,7 +204,7 @@ func command(name, inputFile, outputFile string, arg ...string) {
 		if err != nil {
 			panic(err)
 		}
-		err = os.WriteFile(outputFile, output, 0600)
+		err = os.WriteFile(outputFile, output, 0o600)
 		if err != nil {
 			panic(err)
 		}

buildinfo.go

@@ -3,11 +3,11 @@ package main
 
 const (
 	// VERSION is the version of peg
-	VERSION   = ""
+	VERSION = ""
 	// BUILDTIME is the build time of peg
 	BUILDTIME = "2024-11-27T19:39:27"
 	// COMMIT is the commit hash of peg
-	COMMIT    = "f02924709a94d2f169ee1dd5f9cee0277aed4edd"
+	COMMIT = "f02924709a94d2f169ee1dd5f9cee0277aed4edd"
 	// IS_TAGGED is there a version
 	IS_TAGGED = false
 )

go.mod

@@ -1,3 +1,3 @@
 module github.com/pointlander/peg
 
-go 1.16
+go 1.23

grammars/c/c_test.go

@@ -39,8 +39,7 @@ func noParseC_4t(t *testing.T, src string) {
 }
 
 func TestCParsing_Expressions1(t *testing.T) {
-	case1src :=
-		`int a() {
+	case1src := `int a() {
 		(es);
 		1++;
 		1+1;
@@ -82,19 +81,24 @@ return 0+(a);
 func TestCParsing_Expressions4(t *testing.T) {
 	parseC_4t(t, `int a(){1+(a);}`)
 }
+
 func TestCParsing_Expressions5(t *testing.T) {
 	parseC_4t(t, `int a(){return (int)0;}`)
 }
+
 func TestCParsing_Expressions6(t *testing.T) {
 	parseC_4t(t, `int a(){return (in)0;}`)
 }
+
 func TestCParsing_Expressions7(t *testing.T) {
 	parseC_4t(t, `int a()
 { return (0); }`)
 }
+
 func TestCParsing_Cast0(t *testing.T) {
 	parseC_4t(t, `int a(){(cast)0;}`)
 }
+
 func TestCParsing_Cast1(t *testing.T) {
 	parseC_4t(t, `int a(){(m*)(rsp);}`)
 	parseC_4t(t, `int a(){(struct m*)(rsp);}`)
@@ -103,11 +107,13 @@ func TestCParsing_Cast1(t *testing.T) {
 func TestCParsing_Empty(t *testing.T) {
 	parseC_4t(t, `/** empty is valid. */  `)
 }
+
 func TestCParsing_EmptyStruct(t *testing.T) {
 	parseC_4t(t, `struct empty{};`)
 	parseC_4t(t, `struct {} empty;`)
 	parseC_4t(t, `struct empty {} empty;`)
 }
+
 func TestCParsing_EmptyEmbeddedUnion(t *testing.T) {
 	parseC_4t(t, `struct empty{
 	union {
@@ -116,6 +122,7 @@ func TestCParsing_EmptyEmbeddedUnion(t *testing.T) {
 	};
 };`)
 }
+
 func TestCParsing_ExtraSEMI(t *testing.T) {
 	parseC_4t(t, `int func(){}
 ;
@@ -127,6 +134,7 @@ int foo() {};;
 
 	noParseC_4t(t, `struct empty{}`)
 }
+
 func TestCParsing_ExtraSEMI2(t *testing.T) {
 	parseC_4t(t, `
 struct a { int b; ; };

grammars/calculator/calculator.go

@@ -2,9 +2,6 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-//go:build grammars
-// +build grammars
-
 package main
 
 import (

main.go

@@ -19,9 +19,10 @@ import (
 //go:generate build peg
 
 var (
-	inline        = flag.Bool("inline", false, "parse rule inlining")
-	_switch       = flag.Bool("switch", false, "replace if-else if-else like blocks with switch blocks")
-	print         = flag.Bool("print", false, "directly dump the syntax tree")
+	inline  = flag.Bool("inline", false, "parse rule inlining")
+	_switch = flag.Bool("switch", false, "replace if-else if-else like blocks with switch blocks")
+	// Avoid redefinition of built-in function print.
+	printFlag     = flag.Bool("print", false, "directly dump the syntax tree")
 	syntax        = flag.Bool("syntax", false, "print out the syntax tree")
 	noast         = flag.Bool("noast", false, "disable AST")
 	strict        = flag.Bool("strict", false, "treat compiler warnings as errors")
@@ -58,14 +59,14 @@ func main() {
 	}
 
 	p := &Peg{Tree: tree.New(*inline, *_switch, *noast), Buffer: string(buffer)}
-	p.Init(Pretty(true), Size(1<<15))
+	_ = p.Init(Pretty(true), Size(1<<15))
 	if err := p.Parse(); err != nil {
 		log.Fatal(err)
 	}
 
 	p.Execute()
 
-	if *print {
+	if *printFlag {
 		p.Print()
 	}
 	if *syntax {
@@ -75,7 +76,7 @@ func main() {
 	if *filename == "" {
 		*filename = file + ".go"
 	}
-	out, err := os.OpenFile(*filename, os.O_RDWR|os.O_CREATE|os.O_TRUNC, 0644)
+	out, err := os.OpenFile(*filename, os.O_RDWR|os.O_CREATE|os.O_TRUNC, 0o644)
 	if err != nil {
 		fmt.Printf("%v: %v\n", *filename, err)
 		return

peg_test.go

@@ -14,14 +14,14 @@ type T Peg {}
 Grammar <- !.
 `
 	p := &Peg{Tree: tree.New(false, false, false), Buffer: buffer}
-	p.Init()
+	_ = p.Init()
 	err := p.Parse()
 	if err != nil {
 		t.Error(err)
 	}
 
 	p = &Peg{Tree: tree.New(false, false, false), Buffer: buffer}
-	p.Init(Size(1 << 15))
+	_ = p.Init(Size(1 << 15))
 	err = p.Parse()
 	if err != nil {
 		t.Error(err)
@@ -34,7 +34,7 @@ type T Peg {}
 Grammar <- !.
 `
 	p := &Peg{Tree: tree.New(false, false, false), Buffer: buffer}
-	p.Init(Size(1 << 15))
+	_ = p.Init(Size(1 << 15))
 	err := p.Parse()
 	if err == nil {
 		t.Error("packagenospace was parsed without error")
@@ -48,7 +48,7 @@ typenospace Peg {}
 Grammar <- !.
 `
 	p := &Peg{Tree: tree.New(false, false, false), Buffer: buffer}
-	p.Init(Size(1 << 15))
+	_ = p.Init(Size(1 << 15))
 	err := p.Parse()
 	if err == nil {
 		t.Error("typenospace was parsed without error")
@@ -62,15 +62,15 @@ func TestSame(t *testing.T) {
 	}
 
 	p := &Peg{Tree: tree.New(true, true, false), Buffer: string(buffer)}
-	p.Init(Size(1 << 15))
+	_ = p.Init(Size(1 << 15))
 	if err = p.Parse(); err != nil {
 		t.Error(err)
 	}
 
 	p.Execute()
 
 	out := &bytes.Buffer{}
-	p.Compile("peg.peg.go", []string{"./peg", "-inline", "-switch", "peg.peg"}, out)
+	_ = p.Compile("peg.peg.go", []string{"./peg", "-inline", "-switch", "peg.peg"}, out)
 
 	bootstrap, err := os.ReadFile("peg.peg.go")
 	if err != nil {
@@ -114,7 +114,7 @@ Begin <- Begin 'x'
 
 	for i, buffer := range tt {
 		p := &Peg{Tree: tree.New(false, false, false), Buffer: buffer}
-		p.Init(Size(1 << 15))
+		_ = p.Init(Size(1 << 15))
 		if err := p.Parse(); err != nil {
 			t.Fatal(err)
 		}
@@ -144,7 +144,7 @@ type DiceExprParser Peg {
 Expr <- 'CJK' / '汉字' / 'test'
 `
 	p := &Peg{Tree: tree.New(false, true, false), Buffer: buffer}
-	p.Init(Size(1 << 15))
+	_ = p.Init(Size(1 << 15))
 	err := p.Parse()
 	if err != nil {
 		t.Fatal("cjk character test failed")
@@ -173,7 +173,7 @@ func BenchmarkInitOnly(b *testing.B) {
 	for i := 0; i < b.N; i++ {
 		for _, peg := range pegs {
 			p := &Peg{Tree: tree.New(true, true, false), Buffer: peg}
-			p.Init(Size(1 << 15))
+			_ = p.Init(Size(1 << 15))
 		}
 	}
 }
@@ -187,7 +187,7 @@ func BenchmarkParse(b *testing.B) {
 		}
 
 		p := &Peg{Tree: tree.New(true, true, false), Buffer: string(input)}
-		p.Init(Size(1 << 15))
+		_ = p.Init(Size(1 << 15))
 		pegs[i] = p
 	}
 
@@ -213,7 +213,7 @@ func BenchmarkResetAndParse(b *testing.B) {
 		}
 
 		p := &Peg{Tree: tree.New(true, true, false), Buffer: string(input)}
-		p.Init(Size(1 << 15))
+		_ = p.Init(Size(1 << 15))
 		pegs[i] = p
 	}
 
@@ -242,7 +242,7 @@ func BenchmarkInitAndParse(b *testing.B) {
 	for i := 0; i < b.N; i++ {
 		for _, str := range strs {
 			peg := &Peg{Tree: tree.New(true, true, false), Buffer: str}
-			peg.Init(Size(1 << 15))
+			_ = peg.Init(Size(1 << 15))
 			if err := peg.Parse(); err != nil {
 				b.Error(err)
 			}
@@ -264,7 +264,7 @@ func BenchmarkInitResetAndParse(b *testing.B) {
 	for i := 0; i < b.N; i++ {
 		for _, str := range strs {
 			peg := &Peg{Tree: tree.New(true, true, false), Buffer: str}
-			peg.Init(Size(1 << 15))
+			_ = peg.Init(Size(1 << 15))
 			if err := peg.Parse(); err != nil {
 				b.Error(err)
 			}