fix: cursor added the comments to every stencil block. (#20)

* fix: cursor added the comments to every stencil block.

* Move comments outside the blocks

* Fix build issue

Author: saygin-dogu

.github/workflows/build-release.yml

@@ -26,6 +26,7 @@ jobs:
       contents: write
       actions: read
     steps:
+      # Add CI secret/auth steps here (e.g. configure AWS, custom tokens).
       ## <<Stencil::Block(getMoreCiSecrets)>>
 
       ## <</Stencil::Block>>
@@ -51,17 +52,20 @@ jobs:
         with:
           github-token: ${{ github.token }}
           version: "latest"
+      # Add auth steps for build/test here (e.g. login to private registry).
       ## <<Stencil::Block(buildtestauth)>>
       ## <</Stencil::Block>>
       - name: Build Test repo
         run: mise run buildtest
         # Fill in env: -> GITHUB_TOKEN here if you need a custom token to read module dependencies
+        # Add env vars for the Build Test repo step here.
         ## <<Stencil::Block(buildTestEnvVars)>>
 
         ## <</Stencil::Block>>
       - name: Run Tests
         run: mise run runtest
         # Fill in env: -> GITHUB_TOKEN here if you need a custom token to read module dependencies
+        # Add env vars for the Run Tests step here.
         ## <<Stencil::Block(runTestEnvVars)>>
 
         ## <</Stencil::Block>>
@@ -71,13 +75,15 @@ jobs:
         run: mise run gentable
         env:
           # Fill in GH_TOKEN env with a different token here if you need a custom token to read module dependencies
+          # Override token for README updates here. Default: GH_TOKEN from github.token.
           ## <<Stencil::Block(readmeUpdateGhToken)>>
           GH_TOKEN: ${{ github.token }}
           ## <</Stencil::Block>>
       - name: Commit back any changes
         uses: stefanzweifel/git-auto-commit-action@e348103e9026cc0eee72ae06630dbe30c8bf7a79 #v5
         with:
           commit_message: Update README.md manifest options table
+      # Add extra build/test steps here (run after standard build and test).
       ## <<Stencil::Block(buildteststeps)>>
 
       ## <</Stencil::Block>>
@@ -116,6 +122,7 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: npx semantic-release
 
+  # Add additional workflow jobs here (alongside build-and-test and build-release).
   ## <<Stencil::Block(extraActions)>>
 
   ## <</Stencil::Block>>

.gitignore

@@ -54,6 +54,7 @@ tests/native/*
 !tests/template
 tests/template/*
 !tests/template/stencil.yaml
+# Add additional gitignore patterns here (e.g. "*.log", "custom-dir/").
 ## <<Stencil::Block(ignores)>>
 
 ## <</Stencil::Block>>

.mise.toml

@@ -1,6 +1,7 @@
 [tools]
 nodejs = "lts"
 pnpm = "latest"
+# Add additional tool versions here (e.g. rust = "1.75"). Installed via mise alongside defaults.
 ## <<Stencil::Block(additionalTools)>>
 
 ## <</Stencil::Block>>
@@ -29,6 +30,7 @@ done
 [tasks.runtest]
 description = 'Run the tests'
 dir = "tests"
+# Customize test runner: override run command and/or add env vars for the runtest task.
 ## <<Stencil::Block(runTests)>>
 run = """
 #!/usr/bin/env bash
@@ -43,6 +45,7 @@ mise run test
 description = 'Generate the README.md table of arguments'
 run = "node scripts/yamltotable.js"
 
+# Add custom mise tasks here (e.g. [tasks.mytask] description = "...", run = "...").
 ## <<Stencil::Block(tasks)>>
 
 ## <</Stencil::Block>>

manifest.yaml

@@ -1,6 +1,7 @@
 name: github.com/udemy/stencil-module-base
 type: templates
 arguments:
+  # Add custom Stencil module arguments here. Used in templates when generating projects.
   ## <<Stencil::Block(arguments)>>
   nativeModule:
     required: false
@@ -35,9 +36,11 @@ arguments:
     description: package.json scripts to add to the generated package.json (key/value map)
   ## <</Stencil::Block>>
 modules:
+  # Add additional Stencil modules to include. Loaded and available during project generation.
   ## <<Stencil::Block(modules)>>
 
   ## <</Stencil::Block>>
+# Add extra manifest config here (e.g. postRunCommand, hooks).
 ## <<Stencil::Block(extra)>>
 postRunCommand:
   - name: Install/Update pnpm deps to lockfile

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

@@ -36,6 +36,7 @@ jobs:
       contents: write
       actions: read
     steps:
+      # Add CI secret/auth steps here (e.g. configure AWS, custom tokens).
       ## <<Stencil::Block(getMoreCiSecrets)>>
 {{ file.Block "getMoreCiSecrets" }}
       ## <</Stencil::Block>>
@@ -79,6 +80,7 @@ jobs:
         run: mise run build
       - name: Run Go Tests
         run: go run gotest.tools/gotestsum@latest
+        # Add env vars for Go tests here (e.g. TEST_DB_URL).
         ## <<Stencil::Block(gotestvars)>>
 {{ file.Block "gotestvars" }}
         ## <</Stencil::Block>>
@@ -89,18 +91,21 @@ jobs:
         with:
           github-token: {{ "${{ github.token }}" }}
           version: 'latest'
+      # Add auth steps for build/test here (e.g. login to private registry).
       ## <<Stencil::Block(buildtestauth)>>
 {{ file.Block "buildtestauth" }}
       ## <</Stencil::Block>>
       - name: Build Test repo
         run: mise run buildtest
         # Fill in env: -> GITHUB_TOKEN here if you need a custom token to read module dependencies
+        # Add env vars for the Build Test repo step here.
         ## <<Stencil::Block(buildTestEnvVars)>>
 {{ file.Block "buildTestEnvVars" }}
         ## <</Stencil::Block>>
       - name: Run Tests
         run: mise run runtest
         # Fill in env: -> GITHUB_TOKEN here if you need a custom token to read module dependencies
+        # Add env vars for the Run Tests step here.
         ## <<Stencil::Block(runTestEnvVars)>>
 {{ file.Block "runTestEnvVars" }}
         ## <</Stencil::Block>>
@@ -110,6 +115,7 @@ jobs:
         run: mise run gentable
         env:
           # Fill in GH_TOKEN env with a different token here if you need a custom token to read module dependencies
+          # Override token for README updates here. Default: GH_TOKEN from github.token.
           ## <<Stencil::Block(readmeUpdateGhToken)>>
 {{- if empty (file.Block "readmeUpdateGhToken") }}
           GH_TOKEN: {{ "${{ github.token }}" }}
@@ -121,6 +127,7 @@ jobs:
         uses: stefanzweifel/git-auto-commit-action@e348103e9026cc0eee72ae06630dbe30c8bf7a79 #v5
         with:
           commit_message: Update README.md manifest options table
+      # Add extra build/test steps here (run after standard build and test).
       ## <<Stencil::Block(buildteststeps)>>
 {{ file.Block "buildteststeps" }}
       ## <</Stencil::Block>>
@@ -192,6 +199,7 @@ jobs:
           args: release --release-notes tempchangelog.md --clean
         env:
           GITHUB_TOKEN: {{ "${{ secrets.GITHUB_TOKEN }}" }}
+          # Add env vars for goreleaser here (e.g. CUSTOM_VAR from secrets).
           ## <<Stencil::Block(goreleaserEnvVars)>>
 {{ file.Block "goreleaserEnvVars" }}
           ## <</Stencil::Block>>
@@ -204,6 +212,7 @@ jobs:
         run: npx semantic-release
 {{- end }}
 
+  # Add additional workflow jobs here (alongside build-and-test and build-release).
   ## <<Stencil::Block(extraActions)>>
 {{ file.Block "extraActions" }}
   ## <</Stencil::Block>>

templates/.gitignore.tpl

@@ -54,6 +54,7 @@ tests/{{ $entry.Name }}/*
 {{ end -}}
 {{ end -}}
 {{ end -}}
+# Add additional gitignore patterns here (e.g. "*.log", "custom-dir/").
 ## <<Stencil::Block(ignores)>>
 {{ file.Block "ignores" }}
 ## <</Stencil::Block>>

templates/.goreleaser.yaml.tpl

@@ -14,6 +14,7 @@ builds:
     ldflags:
       - -s
       - -w
+      # Add extra linker flags for the plugin build (e.g. -X main.version=1.0.0).
       ## <<Stencil::Block(pluginLdflags)>>
 {{ file.Block "pluginLdflags" }}
       ## <</Stencil::Block>>
@@ -22,13 +23,15 @@ builds:
     goarch:
       - amd64
       - arm64
+      # Add extra architectures to build (e.g. "386", "arm"). Defaults: amd64, arm64.
       ## <<Stencil::Block(pluginExtraArch)>>
 {{ file.Block "pluginExtraArch" }}
       ## <</Stencil::Block>>
     goos:
       - linux
       - darwin
       - windows
+      # Add extra OS targets to build (e.g. "freebsd", "openbsd"). Defaults: linux, darwin, windows.
       ## <<Stencil::Block(pluginExtraOS)>>
 {{ file.Block "pluginExtraOS" }}
       ## <</Stencil::Block>>

templates/.mise.toml.tpl

@@ -10,6 +10,7 @@ goreleaser = "latest"
 "go:golang.org/x/tools/cmd/goimports" = "latest"
 "go:github.com/thenativeweb/get-next-version" = "latest"
 {{- end }}
+# Add additional tool versions here (e.g. rust = "1.75"). Installed via mise alongside defaults.
 ## <<Stencil::Block(additionalTools)>>
 {{ file.Block "additionalTools" }}
 ## <</Stencil::Block>>
@@ -75,6 +76,7 @@ done
 [tasks.runtest]
 description = 'Run the tests'
 dir = "tests"
+# Customize test runner: override run command and/or add env vars for the runtest task.
 ## <<Stencil::Block(runTests)>>
 {{- if (empty (file.Block "runTests")) }}
 env = {ENV_VAR_NAME = 'hooray'} # env vars for the script
@@ -92,6 +94,7 @@ echo "Tests are running"
 description = 'Generate the README.md table of arguments'
 run = "node scripts/yamltotable.js"
 
+# Add custom mise tasks here (e.g. [tasks.mytask] description = "...", run = "...").
 ## <<Stencil::Block(tasks)>>
 {{ file.Block "tasks" }}
 ## <</Stencil::Block>>

templates/go.mod.tpl

@@ -5,6 +5,7 @@ module github.com/{{ stencil.Arg "githubOrg" }}/{{ .Config.Name }}
 
 go 1.25
 
+// Add extra Go module dependencies here. If empty, default require block is used; if set, it replaces the default.
 // <<Stencil::Block(requires)>>
 {{- if empty (trim (file.Block "requires")) }}
 require (

templates/manifest.yaml.tpl

@@ -9,13 +9,16 @@ type: templates
 {{- fail "Either templateModule or nativeModule must be true" }}
 {{- end }}
 arguments:
+  # Add custom Stencil module arguments here. Used in templates when generating projects.
   ## <<Stencil::Block(arguments)>>
 {{ file.Block "arguments" }}
   ## <</Stencil::Block>>
 modules:
+  # Add additional Stencil modules to include. Loaded and available during project generation.
   ## <<Stencil::Block(modules)>>
 {{ file.Block "modules" }}
   ## <</Stencil::Block>>
+# Add extra manifest config here (e.g. postRunCommand, hooks).
 ## <<Stencil::Block(extra)>>
 {{ file.Block "extra" }}
 ## <</Stencil::Block>>