Merge pull request #95 from osteele/modernize

Modernize

.golangci.yml

@@ -6,7 +6,46 @@ issues:
 
     # go generate introduces these
     - path: expressions/scanner.go
-      linters: [deadcode, unused, varcheck]
+      linters: [deadcode, unused, varcheck, revive, stylecheck, gocritic, unconvert, gofumpt]
 linters:
-  enable:
-    - gofmt
+  enable-all: true
+  disable:
+    - depguard
+    - exhaustruct
+    - varnamelen
+    - godox
+    - wsl
+    - wrapcheck
+    - gomnd
+    - gochecknoglobals
+    - exhaustive
+    - testpackage
+    - ireturn
+    - godot
+    - mnd
+    - nonamedreturns
+    - funlen
+    - gci
+    - nlreturn
+    - inamedparam
+    - lll
+    - paralleltest
+    - gocognit
+    - goconst
+    - cyclop
+    - dupword
+    - whitespace
+    - nolintlint
+    - nestif
+    - forcetypeassert
+    - interfacebloat
+    - revive
+    - gocyclo
+    - errname
+    - gosmopolitan
+    - maintidx
+
+    # Todo: re-add
+    - err113
+    - errorlint
+  fix: true

CHANGELOG.md

@@ -115,7 +115,7 @@ Contributions:
 
 * Fix array[nil] ([e39a1fe](https://github.com/osteele/liquid/commit/e39a1fe))
 * Fix file not found tests for Windows ([068afef](https://github.com/osteele/liquid/commit/068afef))
-* Restore m['str'] where m map[interface{}]interface{}
+* Restore m['str'] where m map[any]any
   ([9852226](https://github.com/osteele/liquid/commit/9852226))
 
 ### Docs

README.md

@@ -43,7 +43,7 @@ generator.
 ```go
 engine := liquid.NewEngine()
 template := `<h1>{{ page.title }}</h1>`
-bindings := map[string]interface{}{
+bindings := map[string]any{
     "page": map[string]string{
         "title": "Introduction",
     },
@@ -84,15 +84,15 @@ These features of Shopify Liquid aren't implemented:
 
 Drops have a different design from the Shopify (Ruby) implementation. A Ruby
 drop sets `liquid_attributes` to a list of attributes that are exposed to
-Liquid. A Go drop implements `ToLiquid() interface{}`, that returns a proxy
+Liquid. A Go drop implements `ToLiquid() any`, that returns a proxy
 object. Conventionally, the proxy is a `map` or `struct` that defines the
 exposed properties. See <http://godoc.org/github.com/osteele/liquid#Drop> for
 additional information.
 
 ### Value Types
 
 `Render` and friends take a `Bindings` parameter. This is a map of `string` to
-`interface{}`, that associates template variable names with Go values.
+`any`, that associates template variable names with Go values.
 
 Any Go value can be used as a variable value. These values have special meaning:
 

cmd/liquid/main.go

@@ -21,12 +21,12 @@ import (
 
 // for testing
 var (
-	stderr     io.Writer              = os.Stderr
-	stdout     io.Writer              = os.Stdout
-	stdin      io.Reader              = os.Stdin
-	exit       func(int)              = os.Exit
-	env        func() []string        = os.Environ
-	bindings   map[string]interface{} = map[string]interface{}{}
+	stderr     io.Writer       = os.Stderr
+	stdout     io.Writer       = os.Stdout
+	stdin      io.Reader       = os.Stdin
+	exit       func(int)       = os.Exit
+	env        func() []string = os.Environ
+	bindings   map[string]any  = map[string]any{}
 	strictVars bool
 )
 

cmd/liquid/main_test.go

@@ -18,7 +18,7 @@ func TestMain(t *testing.T) {
 		stdin = os.Stdin
 		exit = os.Exit
 		env = os.Environ
-		bindings = map[string]interface{}{}
+		bindings = map[string]any{}
 	}()
 
 	exit = func(n int) {
@@ -58,7 +58,7 @@ func TestMain(t *testing.T) {
 	main()
 	require.True(t, envCalled)
 	require.Equal(t, "Hello, World!", buf.String())
-	bindings = make(map[string]interface{})
+	bindings = make(map[string]any)
 
 	// filename
 	stdin = os.Stdin

drops.go

@@ -2,12 +2,12 @@ package liquid
 
 // Drop indicates that the object will present to templates as its ToLiquid value.
 type Drop interface {
-	ToLiquid() interface{}
+	ToLiquid() any
 }
 
 // FromDrop returns returns object.ToLiquid() if object's type implement this function;
 // else the object itself.
-func FromDrop(object interface{}) interface{} {
+func FromDrop(object any) any {
 	switch object := object.(type) {
 	case Drop:
 		return object.ToLiquid()

drops_test.go

@@ -10,7 +10,7 @@ import (
 
 type dropTest struct{}
 
-func (d dropTest) ToLiquid() interface{} { return "drop" }
+func (d dropTest) ToLiquid() any { return "drop" }
 
 func TestDrops(t *testing.T) {
 	require.Equal(t, "drop", FromDrop(dropTest{}))
@@ -20,22 +20,22 @@ func TestDrops(t *testing.T) {
 
 type redConvertible struct{}
 
-func (c redConvertible) ToLiquid() interface{} {
-	return map[string]interface{}{
+func (c redConvertible) ToLiquid() any {
+	return map[string]any{
 		"color": "red",
 	}
 }
 
 func ExampleDrop_map() {
 	// type redConvertible struct{}
 	//
-	// func (c redConvertible) ToLiquid() interface{} {
-	// 	return map[string]interface{}{
+	// func (c redConvertible) ToLiquid() any {
+	// 	return map[string]any{
 	// 		"color": "red",
 	// 	}
 	// }
 	engine := NewEngine()
-	bindings := map[string]interface{}{
+	bindings := map[string]any{
 		"car": redConvertible{},
 	}
 	template := `{{ car.color }}`
@@ -49,7 +49,7 @@ func ExampleDrop_map() {
 
 type car struct{ color, model string }
 
-func (c car) ToLiquid() interface{} {
+func (c car) ToLiquid() any {
 	return carDrop{c.model, c.color}
 }
 
@@ -65,7 +65,7 @@ func (c carDrop) Drive() string {
 func ExampleDrop_struct() {
 	// type car struct{ color, model string }
 	//
-	// func (c car) ToLiquid() interface{} {
+	// func (c car) ToLiquid() any {
 	// 	return carDrop{c.model, c.color}
 	// }
 	//
@@ -79,7 +79,7 @@ func ExampleDrop_struct() {
 	// }
 
 	engine := NewEngine()
-	bindings := map[string]interface{}{
+	bindings := map[string]any{
 		"car": car{"blue", "S85"},
 	}
 	template := `{{ car.color }} {{ car.Drive }} Model {{ car.Model }}`

engine.go

@@ -43,7 +43,7 @@ func (e *Engine) RegisterBlock(name string, td Renderer) {
 // * https://github.com/osteele/liquid/blob/main/filters/standard_filters.go
 //
 // * https://github.com/osteele/gojekyll/blob/master/filters/filters.go
-func (e *Engine) RegisterFilter(name string, fn interface{}) {
+func (e *Engine) RegisterFilter(name string, fn any) {
 	e.cfg.AddFilter(name, fn)
 }
 

engine_examples_test.go

@@ -3,6 +3,7 @@ package liquid
 import (
 	"fmt"
 	"log"
+	"strconv"
 	"strings"
 
 	"github.com/osteele/liquid/render"
@@ -11,7 +12,7 @@ import (
 func Example() {
 	engine := NewEngine()
 	source := `<h1>{{ page.title }}</h1>`
-	bindings := map[string]interface{}{
+	bindings := map[string]any{
 		"page": map[string]string{
 			"title": "Introduction",
 		},
@@ -27,18 +28,19 @@ func Example() {
 func ExampleEngine_ParseAndRenderString() {
 	engine := NewEngine()
 	source := `{{ hello | capitalize | append: " Mundo" }}`
-	bindings := map[string]interface{}{"hello": "hola"}
+	bindings := map[string]any{"hello": "hola"}
 	out, err := engine.ParseAndRenderString(source, bindings)
 	if err != nil {
 		log.Fatalln(err)
 	}
 	fmt.Println(out)
 	// Output: Hola Mundo
 }
+
 func ExampleEngine_ParseTemplate() {
 	engine := NewEngine()
 	source := `{{ hello | capitalize | append: " Mundo" }}`
-	bindings := map[string]interface{}{"hello": "hola"}
+	bindings := map[string]any{"hello": "hola"}
 	tpl, err := engine.ParseString(source)
 	if err != nil {
 		log.Fatalln(err)
@@ -50,11 +52,12 @@ func ExampleEngine_ParseTemplate() {
 	fmt.Println(out)
 	// Output: Hola Mundo
 }
+
 func ExampleEngine_RegisterFilter() {
 	engine := NewEngine()
 	engine.RegisterFilter("has_prefix", strings.HasPrefix)
 	template := `{{ title | has_prefix: "Intro" }}`
-	bindings := map[string]interface{}{
+	bindings := map[string]any{
 		"title": "Introduction",
 	}
 	out, err := engine.ParseAndRenderString(template, bindings)
@@ -64,6 +67,7 @@ func ExampleEngine_RegisterFilter() {
 	fmt.Println(out)
 	// Output: true
 }
+
 func ExampleEngine_RegisterFilter_optional_argument() {
 	engine := NewEngine()
 	// func(a, b int) int) would default the second argument to zero.
@@ -74,7 +78,7 @@ func ExampleEngine_RegisterFilter_optional_argument() {
 		return a + b(1)
 	})
 	template := `10 + 1 = {{ m | inc }}; 20 + 5 = {{ n | inc: 5 }}`
-	bindings := map[string]interface{}{
+	bindings := map[string]any{
 		"m": 10,
 		"n": "20",
 	}
@@ -108,7 +112,7 @@ func ExampleEngine_RegisterBlock() {
 			return "", err
 		}
 		n := len(s)
-		return fmt.Sprint(n), nil
+		return strconv.Itoa(n), nil
 	})
 
 	template := `{% length %}abc{% endlength %}`

engine_test.go

@@ -3,15 +3,15 @@ package liquid
 import (
 	"bytes"
 	"encoding/json"
-	"fmt"
 	"io"
+	"strconv"
 	"strings"
 	"testing"
 
 	"github.com/stretchr/testify/require"
 )
 
-var emptyBindings = map[string]interface{}{}
+var emptyBindings = map[string]any{}
 
 // There's a lot more tests in the filters and tags sub-packages.
 // This collects a minimal set for testing end-to-end.
@@ -21,18 +21,18 @@ var liquidTests = []struct{ in, expected string }{
 	{`{{ "upper" | upcase }}`, "UPPER"},
 }
 
-var testBindings = map[string]interface{}{
+var testBindings = map[string]any{
 	"x":  123,
 	"ar": []string{"first", "second", "third"},
-	"page": map[string]interface{}{
+	"page": map[string]any{
 		"title": "Introduction",
 	},
 }
 
 func TestEngine_ParseAndRenderString(t *testing.T) {
 	engine := NewEngine()
 	for i, test := range liquidTests {
-		t.Run(fmt.Sprint(i+1), func(t *testing.T) {
+		t.Run(strconv.Itoa(i+1), func(t *testing.T) {
 			out, err := engine.ParseAndRenderString(test.in, testBindings)
 			require.NoErrorf(t, err, test.in)
 			require.Equalf(t, test.expected, out, test.in)
@@ -51,7 +51,7 @@ func (c *capWriter) Write(bs []byte) (int, error) {
 func TestEngine_ParseAndFRender(t *testing.T) {
 	engine := NewEngine()
 	for i, test := range liquidTests {
-		t.Run(fmt.Sprint(i+1), func(t *testing.T) {
+		t.Run(strconv.Itoa(i+1), func(t *testing.T) {
 			wr := capWriter{}
 			err := engine.ParseAndFRender(&wr, []byte(test.in), testBindings)
 			require.NoErrorf(t, err, test.in)
@@ -61,8 +61,8 @@ func TestEngine_ParseAndFRender(t *testing.T) {
 }
 
 func TestEngine_ParseAndRenderString_ptr_to_hash(t *testing.T) {
-	params := map[string]interface{}{
-		"message": &map[string]interface{}{
+	params := map[string]any{
+		"message": &map[string]any{
 			"Text":       "hello",
 			"jsonNumber": json.Number("123"),
 		},
@@ -77,7 +77,7 @@ func TestEngine_ParseAndRenderString_ptr_to_hash(t *testing.T) {
 type testStruct struct{ Text string }
 
 func TestEngine_ParseAndRenderString_struct(t *testing.T) {
-	params := map[string]interface{}{
+	params := map[string]any{
 		"message": testStruct{
 			Text: "hello",
 		},
@@ -103,7 +103,7 @@ func TestEngine_ParseAndRender_errors(t *testing.T) {
 func BenchmarkEngine_Parse(b *testing.B) {
 	engine := NewEngine()
 	buf := new(bytes.Buffer)
-	for i := 0; i < 1000; i++ {
+	for range 1000 {
 		_, err := io.WriteString(buf, `if{% if true %}true{% elsif %}elsif{% else %}else{% endif %}`)
 		require.NoError(b, err)
 		_, err = io.WriteString(buf, `loop{% for item in array %}loop{% break %}{% endfor %}`)
@@ -115,7 +115,7 @@ func BenchmarkEngine_Parse(b *testing.B) {
 	}
 	s := buf.Bytes()
 	b.ResetTimer()
-	for i := 0; i < b.N; i++ {
+	for range b.N {
 		_, err := engine.ParseTemplate(s)
 		require.NoError(b, err)
 	}
@@ -134,5 +134,5 @@ func TestEngine_ParseTemplateAndCache(t *testing.T) {
 	// ...and execute the second.
 	result, err := eng.ParseAndRender(templateB, Bindings{})
 	require.NoError(t, err)
-	require.Equal(t, string(result), "Foo, Bar")
+	require.Equal(t, "Foo, Bar", string(result))
 }