First draft of common patterns on codegens.

Some are not tested, might have typos in templates.

common-templates/README.md.gotmpl

@@ -0,0 +1,12 @@
+This template holds chunks of common README.md
+
+{{ define "readme_usage" -}}
+## Usage
+
+```bash
+substreams build
+substreams auth
+substreams gui
+```
+{{- end }}
+

common.go

@@ -0,0 +1,41 @@
+package codegen
+
+import (
+	"embed"
+	"io/fs"
+	"text/template"
+
+	"github.com/bmatcuk/doublestar/v4"
+)
+
+//go:embed common-templates/*.gotmpl
+var commonTemplatesFS embed.FS
+
+var commonTemplates *template.Template
+
+func init() {
+	var err error
+	commonTemplates, err = parseCommonTemplates()
+	if err != nil {
+		panic(err)
+	}
+}
+func parseCommonTemplates() (*template.Template, error) {
+	t := template.New("").Funcs(templateFuncs)
+	filenames, err := doublestar.Glob(commonTemplatesFS, "**/*.gotmpl")
+	if err != nil {
+		return nil, err
+	}
+
+	for _, filename := range filenames {
+		b, err := fs.ReadFile(commonTemplatesFS, filename)
+		if err != nil {
+			return nil, err
+		}
+		_, err = t.New(filename).Parse(string(b))
+		if err != nil {
+			return nil, err
+		}
+	}
+	return t, nil
+}

evm-events-calls/generate.go

@@ -205,7 +205,7 @@ func (p *Project) Render() (projectFiles map[string][]byte, err error) {
 		"rust-toolchain.toml":         "rust-toolchain.toml",
 		".gitignore":                  ".gitignore",
 		"substreams.yaml.gotmpl":      "substreams.yaml",
-		"README.md":                   "README.md",
+		"README.md.gotmpl":            "README.md",
 	}
 
 	for templateFile, finalFileName := range templateFiles {

evm-events-calls/generate_test.go

@@ -16,14 +16,24 @@ func TestTemplates(t *testing.T) {
 	_ = tpls
 }
 
+type match struct {
+	file     string
+	contains string
+}
+
 func Test_Generate(t *testing.T) {
 	cases := []struct {
 		name          string
 		generatorFile string
+		contains      []match
 	}{
 		{
 			name:          "uniswap_factory_track_calls",
 			generatorFile: "./testdata/uniswap_factory_track_calls.json",
+			contains: []match{
+				{"README.md", "## Usage\n\n```bash\nsubstreams build\n"},
+				{"README.md", "INSERT CONTRACT ADDRESS"},
+			},
 		},
 		{
 			name:          "uniswap_factory_track_calls_events",
@@ -90,18 +100,25 @@ func Test_Generate(t *testing.T) {
 			require.NoError(t, err)
 			assert.NotEmpty(t, len(projFiles))
 
-			sourceTmpDir, err := os.MkdirTemp(os.TempDir(), "test_output_src.zip")
-			require.NoError(t, err)
+			for _, cont := range c.contains {
+				assert.Contains(t, projFiles, cont.file)
+				assert.Contains(t, string(projFiles[cont.file]), cont.contains)
+			}
 
-			projectTmpDir, err := os.MkdirTemp(os.TempDir(), "test_output_project.zip")
-			require.NoError(t, err)
+			// sourceTmpDir, err := os.MkdirTemp(os.TempDir(), "test_output_src.zip")
+			// require.NoError(t, err)
 
-			if os.Getenv("TEST_KEEP_TEST_OUTPUT") != "true" {
-				defer func() {
-					_ = os.RemoveAll(sourceTmpDir)
-					_ = os.RemoveAll(projectTmpDir)
-				}()
-			}
+			// projectTmpDir, err := os.MkdirTemp(os.TempDir(), "test_output_project.zip")
+			// require.NoError(t, err)
+
+			// if os.Getenv("TEST_KEEP_TEST_OUTPUT") != "true" {
+			// 	defer func() {
+			// 		_ = os.RemoveAll(sourceTmpDir)
+			// 		_ = os.RemoveAll(projectTmpDir)
+			// 	}()
+			// } else {
+			// 	fmt.Println("Produced", sourceTmpDir, projectTmpDir)
+			// }
 		})
 	}
 }

evm-minimal/templates/README.md.gotmpl

@@ -1,25 +1,12 @@
-# EVM Minimal
+# {{ .Name }} Substreams modules
 
-## Build your Substreams
+This package was initialized via `substreams init`, using the `evm-minimal` template.
 
-```bash
-substreams build
-```
-
-## Authenticate
-
-To run your Substreams you will need to [authenticate](https://substreams.streamingfast.io/documentation/consume/authentication) yourself.
-
-```bash
-substreams auth
-```
-
-## Run your Substreams
-
-```bash
-substreams gui
-```
+{{ template "readme_usage" }}
 
 ## Modules
 
-`map_my_data`: This module will do a simple computation of the number of **transactions** in each block.
+### `map_my_data`
+
+This module extracts small bits of block data, and does simple computations over the 
+number of **transactions** in each block.

injective-events/generate.go

@@ -30,7 +30,7 @@ func (p *Project) Render(outType outputType) (substreamsFiles map[string][]byte,
 
 	templateFiles := map[string]string{
 		".gitignore":             ".gitignore",
-		"README.md":              "README.md",
+		"README.md.gotmpl":       "README.md",
 		"substreams.yaml.gotmpl": "substreams.yaml",
 	}
 

injective-events/templates/README.md.gotmpl

@@ -0,0 +1,12 @@
+# {{ .Name }} Substreams modules
+
+This package was initialized via `substreams init`, using the `injective-events` template.
+
+{{ template "readme_usage" }}
+
+## Modules
+
+### `{{ .ModuleName }}`
+
+This module uses the [Injective Foundational Modules](https://github.com/streamingfast/substreams-foundational-modules/)
+and applies filters on the chosen events and attributes.

injective-minimal/templates/README.md.gotmpl

@@ -1,25 +1,11 @@
-# Injective Minimal
+# {{ .Name }} Substreams modules
 
-## Build your Substreams
+This package was initialized via `substreams init`, using the `injective-minimal` template.
 
-```bash
-substreams build
-```
-
-## Authenticate
-
-To run your Substreams you will need to [authenticate](https://substreams.streamingfast.io/documentation/consume/authentication) yourself.
-
-```bash
-substreams auth
-```
-
-## Run your Substreams
-
-```bash
-substreams gui
-```
+{{ template "readme_usage" }}
 
 ## Modules
 
-`map_my_data`: This module will do a simple computation of the number of **transactions** in each block.
+### `map_my_data`
+
+This module will do a simple computation of the number of **transactions** in each block.

templating.go

@@ -2,13 +2,14 @@ package codegen
 
 import (
 	"fmt"
-	"github.com/huandu/xstrings"
-	"github.com/iancoleman/strcase"
 	"io/fs"
 	"regexp"
 	"strings"
 	"text/template"
 
+	"github.com/huandu/xstrings"
+	"github.com/iancoleman/strcase"
+
 	"github.com/bmatcuk/doublestar/v4"
 	"github.com/golang-cz/textcase"
 )
@@ -27,7 +28,12 @@ var templateFuncs = template.FuncMap{
 
 // ParseFS reads the files from the embedded FS and parses them into named templates.
 func ParseFS(myFuncs template.FuncMap, fsys fs.FS, pattern string) (*template.Template, error) {
-	t := template.New("").Funcs(templateFuncs).Funcs(myFuncs)
+	t, err := commonTemplates.Clone()
+	if err != nil {
+		return nil, err
+	}
+	t.Funcs(myFuncs)
+
 	filenames, err := doublestar.Glob(fsys, pattern)
 	if err != nil {
 		return nil, err
@@ -49,6 +55,7 @@ func ParseFS(myFuncs template.FuncMap, fsys fs.FS, pattern string) (*template.Te
 			return nil, err
 		}
 	}
+
 	return t, nil
 }