feat: add spec.inputs support, improve test infrastructure with 24 GitLab template tests, and fix type safety for rules array access

Author: noxify

.changeset/fix-rules-type-guards.md

@@ -0,0 +1,17 @@
+---
+"@noxify/gitlab-ci-builder": minor
+---
+
+Add comprehensive test infrastructure for GitLab CI templates with local YAML storage and improve type safety for rules array access
+
+- Add test helper utilities for GitLab template round-trip testing
+- Add 22 official GitLab CI templates as local test fixtures
+- Add integration tests for language templates (19 tests)
+- Add integration tests for infrastructure templates (3 tests)
+- Add integration tests for browser performance artifacts (2 tests)
+- Add support for `spec` with `inputs` (GitLab CI/CD components)
+- Add integration tests for multi-document YAML with OpenTofu component
+- Add interpolation support for schema fields that can contain GitLab CI/CD variables
+- Fix TypeScript type errors in test assertions for rules array access by adding proper type guards
+- Remove 'pages' from reserved job names (it's a valid GitLab Pages job name)
+- Reorganize tests into unit and integration directories

.gitignore

@@ -35,3 +35,5 @@ dist/
 
 # turbo
 .turbo
+
+**/.generated/

package.json

@@ -39,7 +39,9 @@
     "lint:fix": "eslint . --fix",
     "test": "vitest --run",
     "test:coverage": "vitest --coverage",
+    "test:integration": "vitest --run --project integration",
     "test:ui": "vitest --ui",
+    "test:unit": "vitest --run --project unit",
     "test:watch": "vitest",
     "typecheck": "tsc --noEmit"
   },

src/builder/ConfigBuilder.ts

@@ -9,16 +9,36 @@ import type {
   JobDefinitionNormalized,
   JobDefinitionOutput,
   JobOptions,
+  Spec,
   ValidationError,
   Variables,
   Workflow,
 } from "../schema"
 import { mergeJobDefinitions } from "../merge"
 import { PipelineState } from "../model"
 import { resolveExtends } from "../resolution"
-import { DefaultsSchema, IncludeSchema, JobDefinitionParseSchema, WorkflowSchema } from "../schema"
+import {
+  DefaultsSchema,
+  IncludeSchema,
+  JobDefinitionParseSchema,
+  SpecSchema,
+  WorkflowSchema,
+} from "../schema"
 import { serializeToYaml } from "../serializer"
 
+/**
+ * Reserved top-level keywords that cannot be used as job names
+ * @see https://docs.gitlab.com/ee/ci/yaml/#keywords
+ */
+const RESERVED_JOB_NAMES = new Set([
+  "default",
+  "include",
+  "stages",
+  "variables",
+  "workflow",
+  "spec",
+])
+
 /**
  * Macro args type
  */
@@ -175,6 +195,20 @@ export class ConfigBuilder {
     return this
   }
 
+  /**
+   * Set spec configuration (pipeline inputs for CI/CD components)
+   * @see https://docs.gitlab.com/ee/ci/yaml/#spec
+   */
+  public spec(spec: Spec) {
+    const validated = SpecSchema.parse(spec)
+    this.state.setSpec(validated)
+    return this
+  }
+
+  /**
+   * Define a template (hidden job starting with dot)
+  }
+
   /**
    * Define a template (hidden job starting with dot)
    *
@@ -213,6 +247,13 @@ export class ConfigBuilder {
    * Define a job or template
    */
   public job(name: string, definition: JobDefinitionInput, options: JobOptions = {}) {
+    // Validate job name is not a reserved keyword
+    if (RESERVED_JOB_NAMES.has(name)) {
+      throw new Error(
+        `Job name "${name}" is a reserved keyword and cannot be used as a job name. Reserved keywords: ${[...RESERVED_JOB_NAMES].join(", ")}`,
+      )
+    }
+
     // Parse and normalize (extends is automatically normalized to array)
     const normalized = JobDefinitionParseSchema.parse(definition)
 
@@ -360,6 +401,7 @@ export class ConfigBuilder {
 
     // Build final output
     const pipeline: PipelineOutput = {
+      spec: plain.spec,
       stages: plain.stages,
       workflow: plain.workflow,
       default: plain.default,

src/generate-types.ts

@@ -44,35 +44,42 @@ async function generateTypes(): Promise<void> {
   ]
 
   const generatedTypes: string[] = [
+    "/* eslint-disable @typescript-eslint/no-redundant-type-constituents */",
     "// Generated types from Zod schemas",
     "// Do not edit manually - run 'pnpm generate:types' to regenerate",
     "",
   ]
 
   for (const { name, schema } of schemas) {
-    // Convert Zod schema to JSON Schema with inline expansion
-    const jsonSchema = toJSONSchema(schema, {
-      reused: "inline",
-      unrepresentable: "any",
-    })
+    try {
+      // Convert Zod schema to JSON Schema with inline expansion
+      const jsonSchema = toJSONSchema(schema, {
+        reused: "inline",
+        unrepresentable: "any",
+      })
 
-    // Convert JSON Schema to TypeScript
-    let tsType = await compile(jsonSchema as typeof JSONSchema, name, {
-      bannerComment: "",
-      style: {
-        printWidth: 100,
-        semi: false,
-        singleQuote: false,
-        tabWidth: 2,
-      },
-    })
+      // Convert JSON Schema to TypeScript
+      let tsType = await compile(jsonSchema as typeof JSONSchema, name, {
+        bannerComment: "",
+        style: {
+          printWidth: 100,
+          semi: false,
+          singleQuote: false,
+          tabWidth: 2,
+        },
+      })
 
-    // Post-process: Only replace empty object types
-    // Let ESLint fix the index signatures automatically
-    tsType = tsType.replace(/\| \{\}/g, "| Record<string, unknown>")
-    tsType = tsType.replace(/\{\}\[\]/g, "Record<string, unknown>[]")
+      // Post-process: Only replace empty object types
+      // Let ESLint fix the index signatures automatically
+      tsType = tsType.replace(/\| \{\}/g, "| Record<string, unknown>")
+      tsType = tsType.replace(/\{\}\[\]/g, "Record<string, unknown>[]")
 
-    generatedTypes.push(tsType)
+      generatedTypes.push(tsType)
+    } catch (error) {
+      // eslint-disable-next-line no-console
+      console.error(`❌ Failed to generate type for ${name}:`, error)
+      throw error
+    }
   }
 
   // Write to file