refactor: replace string YAML in generate.ts with template files

Anmol1696 · Anmol1696 · commit bac7ab3098fd · 2026-04-21T09:40:16.000+05:30
Move all remaining string-based YAML construction out of generate.ts
into template files under templates/k8s/:

- skaffold.yaml — main skaffold config skeleton with placeholders
  for per-function profiles, rawYaml lists, and port forwards
- skaffold-profile.yaml — per-function profile template
- functions-configmap.yaml — ConfigMap template for function registry

generate.ts now uses readTemplate() + renderTemplate() to load and
populate these files, same pattern as the function templates. No more
string array concatenation for YAML output.
diff --git a/scripts/generate.ts b/scripts/generate.ts
@@ -183,25 +183,32 @@ interface FunctionInfo {
   port: number;
 }
 
+const K8S_TEMPLATES_DIR: string = path.resolve(TEMPLATES_DIR, 'k8s');
+
+function readTemplate(name: string): string {
+  return fs.readFileSync(path.join(K8S_TEMPLATES_DIR, name), 'utf-8');
+}
+
+function renderTemplate(template: string, vars: Record<string, string>): string {
+  let result = template;
+  for (const [key, value] of Object.entries(vars)) {
+    result = result.replace(new RegExp(`\\{\\{${key}\\}\\}`, 'g'), value);
+  }
+  return result;
+}
+
 function generateFunctionsConfigMap(fns: FunctionInfo[], perFunction?: FunctionInfo): void {
   const targetFns = perFunction ? [perFunction] : fns;
-  const jobsSupported = targetFns.map((fn) => fn.name).join(',');
   const gatewayMap: Record<string, string> = {};
   for (const fn of targetFns) {
     gatewayMap[fn.name] = `http://${fn.name}.${K8S_NAMESPACE}.svc.cluster.local`;
   }
 
-  const yaml = [
-    '# AUTO-GENERATED by scripts/generate.ts — do not edit manually.',
-    'apiVersion: v1',
-    'kind: ConfigMap',
-    'metadata:',
-    '  name: functions-registry',
-    'data:',
-    `  JOBS_SUPPORTED: "${jobsSupported}"`,
-    `  INTERNAL_GATEWAY_DEVELOPMENT_MAP: '${JSON.stringify(gatewayMap)}'`,
-    '',
-  ].join('\n');
+  const template = readTemplate('functions-configmap.yaml');
+  const yaml = renderTemplate(template, {
+    jobs_supported: targetFns.map((fn) => fn.name).join(','),
+    gateway_map: JSON.stringify(gatewayMap),
+  });
 
   if (perFunction) {
     const dir = path.join(GENERATED_DIR, perFunction.dir, 'k8s');
@@ -213,70 +220,24 @@ function generateFunctionsConfigMap(fns: FunctionInfo[], perFunction?: FunctionI
 }
 
 function generateSkaffoldYaml(fns: FunctionInfo[]): void {
-  const buildBlock = [
-    '    build:',
-    '      artifacts:',
-    '        - image: constructive-functions',
-    '          context: .',
-    '          docker:',
-    '            dockerfile: Dockerfile.dev',
-    '          sync:',
-    '            manual:',
-    "              - src: 'functions/**/*.ts'",
-    '                dest: /usr/src/app',
-    '      local:',
-    '        push: false',
-  ].join('\n');
-
-  const sharedPortForwards = [
-    '      - resourceType: service',
-    '        resourceName: knative-job-service',
-    `        namespace: ${K8S_NAMESPACE}`,
-    '        port: 8080',
-    '        localPort: 8080',
-    '      - resourceType: service',
-    '        resourceName: postgres',
-    `        namespace: ${K8S_NAMESPACE}`,
-    '        port: 5432',
-    '        localPort: 5432',
-    '      - resourceType: service',
-    '        resourceName: constructive-server',
-    `        namespace: ${K8S_NAMESPACE}`,
-    '        port: 3000',
-    '        localPort: 3002',
-  ].join('\n');
-
-  // Per-function profiles
-  const perFnProfiles: string[] = [];
-  for (const fn of fns) {
-    perFnProfiles.push([
-      `  - name: ${fn.name}`,
-      buildBlock,
-      '    manifests:',
-      '      kustomize:',
-      '        paths:',
-      '          - k8s/overlays/local-simple',
-      '      rawYaml:',
-      `        - generated/${fn.dir}/k8s/local-deployment.yaml`,
-      `        - generated/${fn.dir}/k8s/functions-configmap.yaml`,
-      '    deploy:',
-      '      kubectl:',
-      `        defaultNamespace: ${K8S_NAMESPACE}`,
-      '    portForward:',
-      '      - resourceType: service',
-      `        resourceName: ${fn.name}`,
-      `        namespace: ${K8S_NAMESPACE}`,
-      '        port: 80',
-      `        localPort: ${fn.port}`,
-      sharedPortForwards,
-    ].join('\n'));
-  }
-
-  // local-simple: all functions
+  const profileTemplate = readTemplate('skaffold-profile.yaml');
+  const skaffoldTemplate = readTemplate('skaffold.yaml');
+
+  // Render per-function profiles from template
+  const perFnProfiles = fns.map((fn) =>
+    renderTemplate(profileTemplate, {
+      name: fn.name,
+      dir: fn.dir,
+      port: String(fn.port),
+      namespace: K8S_NAMESPACE,
+    }).trimEnd()
+  ).join('\n');
+
+  // Build dynamic lists for aggregate profiles
   const allRawYaml = fns
     .map((fn) => `        - generated/${fn.dir}/k8s/local-deployment.yaml`)
     .join('\n');
-  const allFnPortForwards = fns
+  const allPortForwards = fns
     .map((fn) => [
       '      - resourceType: service',
       `        resourceName: ${fn.name}`,
@@ -286,56 +247,12 @@ function generateSkaffoldYaml(fns: FunctionInfo[]): void {
     ].join('\n'))
     .join('\n');
 
-  const localSimpleProfile = [
-    '  # All functions together.',
-    '  - name: local-simple',
-    buildBlock,
-    '    manifests:',
-    '      kustomize:',
-    '        paths:',
-    '          - k8s/overlays/local-simple',
-    '      rawYaml:',
-    allRawYaml,
-    '        - generated/functions-configmap.yaml',
-    '    deploy:',
-    '      kubectl:',
-    `        defaultNamespace: ${K8S_NAMESPACE}`,
-    '    portForward:',
-    allFnPortForwards,
-    sharedPortForwards,
-  ].join('\n');
-
-  // local (Knative): no rawYaml, uses kustomize overlay
-  const localKnativeProfile = [
-    '  # Full Knative setup — requires `cd k8s && make operators-knative-only` first.',
-    '  - name: local',
-    buildBlock,
-    '    manifests:',
-    '      kustomize:',
-    '        paths:',
-    '          - k8s/overlays/local',
-    '    portForward:',
-    allFnPortForwards,
-    sharedPortForwards,
-  ].join('\n');
-
-  const skaffold = [
-    '# AUTO-GENERATED by scripts/generate.ts — do not edit manually.',
-    '# To add a function, create functions/<name>/handler.json and run `pnpm generate`.',
-    'apiVersion: skaffold/v4beta11',
-    'kind: Config',
-    'metadata:',
-    '  name: constructive-functions',
-    '',
-    'profiles:',
-    '  # Per-function profiles (infra + single function).',
-    ...perFnProfiles.map((p) => p),
-    '',
-    localSimpleProfile,
-    '',
-    localKnativeProfile,
-    '',
-  ].join('\n');
+  const skaffold = renderTemplate(skaffoldTemplate, {
+    per_function_profiles: perFnProfiles,
+    all_raw_yaml: allRawYaml,
+    all_port_forwards: allPortForwards,
+    namespace: K8S_NAMESPACE,
+  });
 
   const skaffoldPath = path.join(ROOT, 'skaffold.yaml');
   if (writeIfChanged(skaffoldPath, skaffold)) {
diff --git a/templates/k8s/functions-configmap.yaml b/templates/k8s/functions-configmap.yaml
@@ -0,0 +1,8 @@
+# AUTO-GENERATED by scripts/generate.ts — do not edit manually.
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: functions-registry
+data:
+  JOBS_SUPPORTED: "{{jobs_supported}}"
+  INTERNAL_GATEWAY_DEVELOPMENT_MAP: '{{gateway_map}}'
diff --git a/templates/k8s/skaffold-profile.yaml b/templates/k8s/skaffold-profile.yaml
@@ -0,0 +1,44 @@
+  - name: {{name}}
+    build:
+      artifacts:
+        - image: constructive-functions
+          context: .
+          docker:
+            dockerfile: Dockerfile.dev
+          sync:
+            manual:
+              - src: 'functions/**/*.ts'
+                dest: /usr/src/app
+      local:
+        push: false
+    manifests:
+      kustomize:
+        paths:
+          - k8s/overlays/local-simple
+      rawYaml:
+        - generated/{{dir}}/k8s/local-deployment.yaml
+        - generated/{{dir}}/k8s/functions-configmap.yaml
+    deploy:
+      kubectl:
+        defaultNamespace: {{namespace}}
+    portForward:
+      - resourceType: service
+        resourceName: {{name}}
+        namespace: {{namespace}}
+        port: 80
+        localPort: {{port}}
+      - resourceType: service
+        resourceName: knative-job-service
+        namespace: {{namespace}}
+        port: 8080
+        localPort: 8080
+      - resourceType: service
+        resourceName: postgres
+        namespace: {{namespace}}
+        port: 5432
+        localPort: 5432
+      - resourceType: service
+        resourceName: constructive-server
+        namespace: {{namespace}}
+        port: 3000
+        localPort: 3002
diff --git a/templates/k8s/skaffold.yaml b/templates/k8s/skaffold.yaml
@@ -0,0 +1,88 @@
+# AUTO-GENERATED by scripts/generate.ts — do not edit manually.
+# To add a function, create functions/<name>/handler.json and run `pnpm generate`.
+apiVersion: skaffold/v4beta11
+kind: Config
+metadata:
+  name: constructive-functions
+
+profiles:
+  # Per-function profiles (infra + single function).
+{{per_function_profiles}}
+
+  # All functions together.
+  - name: local-simple
+    build:
+      artifacts:
+        - image: constructive-functions
+          context: .
+          docker:
+            dockerfile: Dockerfile.dev
+          sync:
+            manual:
+              - src: 'functions/**/*.ts'
+                dest: /usr/src/app
+      local:
+        push: false
+    manifests:
+      kustomize:
+        paths:
+          - k8s/overlays/local-simple
+      rawYaml:
+{{all_raw_yaml}}
+        - generated/functions-configmap.yaml
+    deploy:
+      kubectl:
+        defaultNamespace: {{namespace}}
+    portForward:
+{{all_port_forwards}}
+      - resourceType: service
+        resourceName: knative-job-service
+        namespace: {{namespace}}
+        port: 8080
+        localPort: 8080
+      - resourceType: service
+        resourceName: postgres
+        namespace: {{namespace}}
+        port: 5432
+        localPort: 5432
+      - resourceType: service
+        resourceName: constructive-server
+        namespace: {{namespace}}
+        port: 3000
+        localPort: 3002
+
+  # Full Knative setup — requires `cd k8s && make operators-knative-only` first.
+  - name: local
+    build:
+      artifacts:
+        - image: constructive-functions
+          context: .
+          docker:
+            dockerfile: Dockerfile.dev
+          sync:
+            manual:
+              - src: 'functions/**/*.ts'
+                dest: /usr/src/app
+      local:
+        push: false
+    manifests:
+      kustomize:
+        paths:
+          - k8s/overlays/local
+    portForward:
+{{all_port_forwards}}
+      - resourceType: service
+        resourceName: knative-job-service
+        namespace: {{namespace}}
+        port: 8080
+        localPort: 8080
+      - resourceType: service
+        resourceName: postgres
+        namespace: {{namespace}}
+        port: 5432
+        localPort: 5432
+      - resourceType: service
+        resourceName: constructive-server
+        namespace: {{namespace}}
+        port: 3000
+        localPort: 3002
