feat: Support native AND/OR template modules

.github/workflows/build-release.yml

@@ -20,6 +20,8 @@ on:
       - 'tests/**'
       - 'manifest.yaml'
       - 'stencil.yaml'
+      - '.goreleaser.yaml'
+      - '.mise.toml'
 
 env:
   GH_ROLE_ARN: arn:aws:iam::602046956384:role/GithubActions-github-actions-services-repos-Role

.mise.toml

@@ -2,8 +2,7 @@
 nodejs = "22"
 yarn = "1.22.22"
 
-
-
+# Template module tasks
 [tasks.cleantest]
 description = "Helper to clean the test directory"
 dir = "tests"
@@ -15,7 +14,7 @@ done
 """
 
 [tasks.buildtest]
-description = 'Build the Test templates'
+description = 'Build the Test projects'
 dir = "tests"
 run = """
 #!/usr/bin/env bash
@@ -28,9 +27,13 @@ done
 description = 'Run the tests'
 dir = "tests"
 ## <<Stencil::Block(runTests)>>
-env = {ENV_VAR_NAME = 'hooray'} # env vars for the script
+env = { ENV_VAR_NAME = 'hooray' } # env vars for the script
 run = """
 #!/usr/bin/env bash
 echo "Tests are running"
 """
 ## <</Stencil::Block>>
+
+## <<Stencil::Block(tasks)>>
+
+## <</Stencil::Block>>

README.md

@@ -1,6 +1,8 @@
 # stencil-templatemodule
 
-This is a stencil template module for making it easy to make stencil template modules.  Much meta, wow.
+This is a stencil module for making it easy to make stencil modules.  Much meta, wow.
+
+Stencil modules can be a native and/or template module.  A native module is one that contains native golang code.  A template module is one that contains templated code.  If you are looking for a guide on how to make your own stencil modules, check out the [stencil documentation](https://stencil.rgst.io/).
 
 ## Manifest Arguments
 
@@ -10,5 +12,6 @@ In the `arguments` section of the `manifest.yaml` file, you can specify the foll
 | -------------------- | --------------- | -------------------------------------------------------------- |
 | `description`        | Required        | Friendly-but-short description string for the frontend app     |
 | `owner`              | Required        | Pod or Portfolio ID for the owner of the frontend app          |
-| `nativeModule`       | `false`         | Does this template module include native module golang code    |
+| `nativeModule`       | `false`         | Does this module include native module golang code             |
+| `templateModule`     | `false`         | Does this module include templated code                        |
 | `buildAndTestRunner` | `ubuntu-latest` | The github actions runner to use for the build and test CI job |

manifest.yaml

@@ -1,4 +1,5 @@
 name: github.com/udemy/stencil-templatemodule
+type: templates
 dirReplacements:
   ## <<Stencil::Block(dirReplacements)>>
 
@@ -22,7 +23,12 @@ arguments:
   ## <<Stencil::Block(arguments)>>
   nativeModule:
     required: false
-    description: Does this template module include native module golang code
+    description: Does this module include native module golang code?
+    schema:
+      type: boolean
+  templateModule:
+    required: false
+    description: Does this module include templated code
     schema:
       type: boolean
   buildAndTestRunner:

stencil.yaml

@@ -3,6 +3,7 @@ name: stencil-templatemodule
 arguments:
   description: Stencil module forming the base for stencil template modules
   owner: platform
+  templateModule: true
 modules:
   - name: github.com/udemy/stencil-templatemodule
 replacements:

templates/.github/workflows/build-release.yml.tpl

@@ -107,6 +107,7 @@ jobs:
 {{ file.Block "gotestvars" }}
         ## <</Stencil::Block>>
 {{- end }}
+{{- if stencil.Arg "templateModule" }}
       ## <<Stencil::Block(buildtestauth)>>
 {{ file.Block "buildtestauth" }}
       ## <</Stencil::Block>>
@@ -127,6 +128,7 @@ jobs:
       ## <<Stencil::Block(buildteststeps)>>
 {{ file.Block "arguments" }}
       ## <</Stencil::Block>>
+{{- end }}
 
   build-release:
     name: Build and Release

templates/.mise.toml.tpl

@@ -10,8 +10,9 @@ goreleaser = "latest"
 "go:golang.org/x/tools/cmd/goimports" = "latest"
 "go:github.com/thenativeweb/get-next-version" = "latest"
 {{- end }}
+{{- if stencil.Arg "nativeModule" }}
 
-{{ if stencil.Arg "nativeModule" -}}
+# Native module tasks
 [tasks.build]
 description = "Build a binary for the current platform/architecture"
 run = "go build -trimpath -o ./bin/ -v ./cmd/..."
@@ -40,7 +41,9 @@ run = ["./.github/scripts/get-next-version.sh"]
 description = "Run tests"
 run = "gotestsum"
 {{- end }}
+{{- if stencil.Arg "templateModule" }}
 
+# Template module tasks
 [tasks.cleantest]
 description = "Helper to clean the test directory"
 dir = "tests"
@@ -52,7 +55,7 @@ done
 """
 
 [tasks.buildtest]
-description = 'Build the Test templates'
+description = 'Build the Test projects'
 dir = "tests"
 run = """
 #!/usr/bin/env bash
@@ -75,6 +78,7 @@ echo "Tests are running"
 {{ file.Block "runTests" }}
 {{- end }}
 ## <</Stencil::Block>>
+{{- end }}
 
 ## <<Stencil::Block(tasks)>>
 {{ file.Block "tasks" }}

templates/manifest.yaml.tpl

@@ -1,8 +1,12 @@
 name: github.com/udemy/{{ .Config.Name }}
-{{- if stencil.Arg "nativeModule" }}
+{{- if and (stencil.Arg "nativeModule") (stencil.Arg "templateModule") }}
 type: templates,extension
-{{- else }}
+{{- else if stencil.Arg "nativeModule" }}
+type: extension
+{{- else if stencil.Arg "templateModule" }}
 type: templates
+{{- else }}
+{{- fail "Either templateModule or nativeModule must be true" }}
 {{- end }}
 dirReplacements:
   ## <<Stencil::Block(dirReplacements)>>

templates/tests/README.md.tpl

@@ -1,7 +1,12 @@
+{{- if not (stencil.Arg "templateModule") -}}
+{{- file.Delete -}}
+{{- else -}}
 {{ file.Static -}}
+{{- end -}}
+For every test case that you have, regarding your stencil templates, you should have a corresponding directory which contains its own stencil.yaml in the tests directory.
 
-For every test case that you have, regarding your stencil templates, you should have a corresponding directory which contains its own stencil.yaml in the tests directory.  
+Make sure to also add each of these tests to the .gitignore file so that you don't commit the test results to the repository.
 
-This is a good practice to ensure that your templates are working as expected. 
+This is a good practice to ensure that your templates are working as expected.
 
 The CI pipeline will execute all the tests in the tests directory and will fail if any of them fail.

templates/tests/basic/stencil.yaml.tpl

@@ -1,4 +1,8 @@
+{{- if not (stencil.Arg "templateModule") -}}
+{{- file.Delete -}}
+{{- else -}}
 {{- file.Once -}}
+{{- end -}}
 # yaml-language-server: $schema=https://stencil.rgst.io/static/stencil.jsonschema.json
 name: {{ .Config.Name }}-test
 arguments: