@intentius/chant-lexicon-gitlab 0.120.0 → 0.121.1

package/dist/import/generator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"generator.d.ts","sourceRoot":"","sources":["../../src/import/generator.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,mBAAmB,EAAE,aAAa,EAAE,MAAM,mCAAmC,CAAC;AAC5F,OAAO,KAAK,EAAE,UAAU,EAAc,MAAM,gCAAgC,CAAC;AAsC7E;;GAEG;AACH,qBAAa,eAAgB,YAAW,mBAAmB;IACzD,QAAQ,CAAC,EAAE,EAAE,UAAU,GAAG,aAAa,EAAE,CA0DxC;IAED,OAAO,CAAC,yBAAyB;IAYjC,OAAO,CAAC,SAAS;IAejB,OAAO,CAAC,SAAS;IA2BjB,OAAO,CAAC,WAAW;CA2BpB"}
+{"version":3,"file":"generator.d.ts","sourceRoot":"","sources":["../../src/import/generator.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,mBAAmB,EAAE,aAAa,EAAE,MAAM,mCAAmC,CAAC;AAC5F,OAAO,KAAK,EAAE,UAAU,EAAc,MAAM,gCAAgC,CAAC;AA0C7E;;GAEG;AACH,qBAAa,eAAgB,YAAW,mBAAmB;IACzD,QAAQ,CAAC,EAAE,EAAE,UAAU,GAAG,aAAa,EAAE,CA8DxC;IAED,OAAO,CAAC,yBAAyB;IAejC,OAAO,CAAC,SAAS;IAejB,OAAO,CAAC,SAAS;IAqCjB,OAAO,CAAC,WAAW;CA2BpB"}

package/dist/import/parser.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"parser.d.ts","sourceRoot":"","sources":["../../src/import/parser.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,UAAU,EAAc,MAAM,gCAAgC,CAAC;AA6B7F;;GAEG;AACH,qBAAa,YAAa,YAAW,cAAc;IACjD,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,UAAU,CA4DjC;CACF"}
+{"version":3,"file":"parser.d.ts","sourceRoot":"","sources":["../../src/import/parser.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,UAAU,EAAc,MAAM,gCAAgC,CAAC;AA6B7F;;GAEG;AACH,qBAAa,YAAa,YAAW,cAAc;IACjD,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,UAAU,CA4EjC;CACF"}

package/dist/integrity.json

@@ -1,7 +1,7 @@
 {
   "algorithm": "sha256",
   "artifacts": {
-    "manifest.json": "b2e850bbb36b4d9288070eaa6c6f240149f2487a1534b498184d9282a1f0982e",
+    "manifest.json": "694e53b8684573c4917b2ffe236247835db6e58188b8b44e5a381e401ca35a08",
     "meta.json": "db082fbf90c5941c498b2bee0f106103449c1a4c257716ca2220f0dd490450b2",
     "types/index.d.ts": "a048a66ebe20da0cb5fc889054cac69044d9bf882e2c56b5c5bf113d1f3ba57c",
     "rules/artifact-no-expiry.ts": "3f3cabf9792cbf8207e53a25f506715466b19ec25e9c3b4d0d77fed6b2eb4542",
@@ -55,5 +55,5 @@
     "skills/chant-gitlab-migrate.md": "4853d04980560b379e5b0f7267dcb0a1e5d5879cb9e9931681ce76b2a5fe69d8",
     "skills/chant-gitlab-patterns.md": "6d9a44e9e8de4c3820be9d65381b0d2ede4cb3626aaaf0011e21838a9fbf556e"
   },
-  "composite": "c0d291cbf1bda2ce61c417054a931919434b86868d2022cb9d6efc9d5f0175b2"
+  "composite": "773f17febcc5969a1d05fc81090404f1950d2258d388c3d8932224be38dbc460"
 }

package/dist/manifest.json

@@ -1,6 +1,6 @@
 {
   "name": "gitlab",
-  "version": "0.120.0",
+  "version": "0.121.1",
   "chantVersion": ">=0.1.0",
   "namespace": "GitLab",
   "intrinsics": [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@intentius/chant-lexicon-gitlab",
-  "version": "0.120.0",
+  "version": "0.121.1",
   "description": "GitLab CI lexicon for chant — declarative IaC in TypeScript",
   "license": "Apache-2.0",
   "homepage": "https://intentius.io/chant",
@@ -67,8 +67,8 @@
     "typescript": "^5.9.3"
   },
   "peerDependencies": {
-    "@intentius/chant": "^0.120.0",
-    "@intentius/chant-lexicon-github": "^0.120.0",
+    "@intentius/chant": "^0.121.1",
+    "@intentius/chant-lexicon-github": "^0.121.1",
     "typescript": "^5.9.3"
   },
   "peerDependenciesMeta": {

package/src/import/generator.test.ts

@@ -148,4 +148,14 @@ describe("GitLabGenerator", () => {
     const files = generator.generate(ir);
     expect(files[0].content).toContain("Pipeline stages: build, test, deploy");
   });
+
+  test("a key that is not an identifier is quoted", () => {
+    const ir: TemplateIR = {
+      resources: [{ logicalId: "pipeline", type: "GitLab::CI::Pipeline", properties: { variables: { "MY-VAR": "x", GIT_DEPTH: "0" } } }],
+      parameters: [],
+    };
+    const content = generator.generate(ir)[0]!.content;
+    expect(content).toContain('"MY-VAR": "x"');
+    expect(content).toContain('GIT_DEPTH: "0"');
+  });
 });

package/src/import/generator.ts

@@ -15,6 +15,7 @@ const TYPE_TO_CLASS: Record<string, string> = {
   "GitLab::CI::Job": "Job",
   "GitLab::CI::Default": "Default",
   "GitLab::CI::Workflow": "Workflow",
+  "GitLab::CI::Pipeline": "Pipeline",
 };
 
 /**
@@ -44,6 +45,9 @@ const PROPERTY_CONSTRUCTORS: Record<string, string> = {
   inherit: "Inherit",
 };
 
+/** An object key as TypeScript accepts it: bare when it is an identifier, quoted otherwise. */
+const tsKey = (key: string): string => (/^[A-Za-z_$][A-Za-z0-9_$]*$/.test(key) ? key : JSON.stringify(key));
+
 /**
  * Generate TypeScript source code from a GitLab CI IR.
  */
@@ -68,14 +72,18 @@ export class GitLabGenerator implements TypeScriptGenerator {
     lines.push(`import { ${imports} } from "@intentius/chant-lexicon-gitlab";`);
     lines.push("");
 
+    // A Pipeline resource declares the stages and includes (#3742); without
+    // one, the metadata is written as comments.
+    const hasPipeline = ir.resources.some((r) => r.type === "GitLab::CI::Pipeline");
+
     // Emit stages if present in metadata
-    if (ir.metadata?.stages && Array.isArray(ir.metadata.stages)) {
+    if (!hasPipeline && ir.metadata?.stages && Array.isArray(ir.metadata.stages)) {
       lines.push(`// Pipeline stages: ${(ir.metadata.stages as string[]).join(", ")}`);
       lines.push("");
     }
 
     // Emit includes as comments
-    if (ir.metadata?.include) {
+    if (!hasPipeline && ir.metadata?.include) {
       lines.push("// Imported includes (not converted):");
       const includes = Array.isArray(ir.metadata.include) ? ir.metadata.include : [ir.metadata.include];
       for (const inc of includes) {
@@ -117,6 +125,9 @@ export class GitLabGenerator implements TypeScriptGenerator {
       if (key === "rules" && Array.isArray(value)) {
         used.add("Rule");
       }
+      if (key === "include" && (Array.isArray(value) ? value : [value]).some((i) => typeof i === "object" && i !== null)) {
+        used.add("Include");
+      }
     }
   }
 
@@ -128,7 +139,7 @@ export class GitLabGenerator implements TypeScriptGenerator {
     for (const [key, value] of Object.entries(props)) {
       if (value === undefined || value === null) continue;
       const emitted = this.emitValue(key, value, depth + 1);
-      entries.push(`${innerIndent}${key}: ${emitted},`);
+      entries.push(`${innerIndent}${tsKey(key)}: ${emitted},`);
     }
 
     if (entries.length === 0) return "{}";
@@ -145,6 +156,16 @@ export class GitLabGenerator implements TypeScriptGenerator {
       return `new ${constructor}(${propsStr})`;
     }
 
+    // A Pipeline's include: each object is an Include, a string stays a string.
+    if (key === "include") {
+      const item = (i: unknown, d: number) =>
+        typeof i === "object" && i !== null && !Array.isArray(i) ? `new Include(${this.emitProps(i as Record<string, unknown>, d)})` : this.emitLiteral(i, d);
+      if (!Array.isArray(value)) return item(value, depth);
+      const indent = "  ".repeat(depth);
+      const innerIndent = "  ".repeat(depth + 1);
+      return `[\n${value.map((i) => `${innerIndent}${item(i, depth + 1)},`).join("\n")}\n${indent}]`;
+    }
+
     // Rules array — wrap each item in Rule constructor
     if (key === "rules" && Array.isArray(value)) {
       const items = value.map((item) => {
@@ -183,7 +204,7 @@ export class GitLabGenerator implements TypeScriptGenerator {
       if (entries.length === 0) return "{}";
       const indent = "  ".repeat(depth);
       const innerIndent = "  ".repeat(depth + 1);
-      const items = entries.map(([k, v]) => `${innerIndent}${k}: ${this.emitLiteral(v, depth + 1)},`);
+      const items = entries.map(([k, v]) => `${innerIndent}${tsKey(k)}: ${this.emitLiteral(v, depth + 1)},`);
       return `{\n${items.join("\n")}\n${indent}}`;
     }
 

package/src/import/parser.test.ts

@@ -15,10 +15,11 @@ test-job:
     - npm test
 `;
     const ir = parser.parse(yaml);
-    expect(ir.resources).toHaveLength(1);
-    expect(ir.resources[0].type).toBe("GitLab::CI::Job");
-    expect(ir.resources[0].properties.stage).toBe("test");
-    expect(ir.resources[0].properties.script).toEqual(["npm test"]);
+    expect(ir.resources).toHaveLength(2);
+    expect(ir.resources[0].type).toBe("GitLab::CI::Pipeline");
+    expect(ir.resources[1].type).toBe("GitLab::CI::Job");
+    expect(ir.resources[1].properties.stage).toBe("test");
+    expect(ir.resources[1].properties.script).toEqual(["npm test"]);
   });
 
   test("parses multiple jobs", () => {
@@ -134,9 +135,24 @@ test-job:
     - npm test
 `;
     const ir = parser.parse(yaml);
-    // Only the job should be in resources (not stages, variables, include)
+    // Only the job is a Job; stages, variables and include are the Pipeline (#3742)
     const jobs = ir.resources.filter((r) => r.type === "GitLab::CI::Job");
     expect(jobs).toHaveLength(1);
+    expect(ir.resources[0]).toEqual({
+      logicalId: "pipeline",
+      type: "GitLab::CI::Pipeline",
+      properties: { include: [{ local: "shared.yml" }], stages: ["test"], variables: { NODE_ENV: "production" } },
+    });
+  });
+
+  test("a job named pipeline keeps its name; the Pipeline takes another (#3742)", () => {
+    const ir = parser.parse(`stages: [test]\npipeline:\n  stage: test\n  script: [x]\n`);
+    expect(ir.resources.map((r) => r.logicalId)).toEqual(["pipelineConfig", "pipeline"]);
+  });
+
+  test("a file with no include, stages or variables has no Pipeline", () => {
+    const ir = parser.parse(`job:\n  script: [x]\n`);
+    expect(ir.resources.map((r) => r.type)).toEqual(["GitLab::CI::Job"]);
   });
 
   test("handles JSON input", () => {
@@ -145,7 +161,7 @@ test-job:
       "test-job": { stage: "test", script: ["npm test"] },
     });
     const ir = parser.parse(json);
-    expect(ir.resources).toHaveLength(1);
+    expect(ir.resources.map((r) => r.type)).toEqual(["GitLab::CI::Pipeline", "GitLab::CI::Job"]);
   });
 
   test("returns empty parameters (GitLab CI has no parameters)", () => {

package/src/import/parser.ts

@@ -87,7 +87,23 @@ export class GitLabParser implements TemplateParser {
       }
     }
 
-    // Record include references as metadata
+    // The file's top-level include, stages and variables are a Pipeline
+    // (#3742), so a rebuild writes them back: stages as written, a stage no
+    // job uses and the declared order included.
+    const pipeline: Record<string, unknown> = {};
+    if (doc.include !== undefined && doc.include !== null) pipeline.include = doc.include;
+    if (Array.isArray(doc.stages)) pipeline.stages = doc.stages;
+    if (doc.variables && typeof doc.variables === "object") pipeline.variables = doc.variables;
+    if (Object.keys(pipeline).length > 0) {
+      const taken = new Set(resources.map((r) => r.logicalId));
+      resources.unshift({
+        logicalId: taken.has("pipeline") ? "pipelineConfig" : "pipeline",
+        type: "GitLab::CI::Pipeline",
+        properties: pipeline,
+      });
+    }
+
+    // Also kept as metadata, for callers that read the IR without the Pipeline.
     const metadata: Record<string, unknown> = {};
     if (doc.stages) metadata.stages = doc.stages;
     if (doc.include) metadata.include = doc.include;

package/src/import/roundtrip.test.ts

@@ -65,7 +65,8 @@ deploy-prod:
     - deploy.sh
 `;
     const ir = parser.parse(yaml);
-    expect(ir.resources).toHaveLength(3);
+    // the Pipeline and 3 jobs
+    expect(ir.resources).toHaveLength(4);
 
     const files = generator.generate(ir);
     const content = files[0].content;
@@ -73,7 +74,8 @@ deploy-prod:
     expect(content).toContain("buildApp");
     expect(content).toContain("runTests");
     expect(content).toContain("deployProd");
-    expect(content).toContain("Pipeline stages: build, test, deploy");
+    expect(content).toContain("new Pipeline(");
+    expect(content).toContain('stages: ["build", "test", "deploy"]');
   });
 
   test("pipeline with defaults and workflow roundtrip", () => {
@@ -108,7 +110,8 @@ test-job:
     expect(files).toHaveLength(1);
     const content = files[0].content;
 
-    expect(ir.resources).toHaveLength(1);
+    // the Pipeline and 1 job
+    expect(ir.resources).toHaveLength(2);
     expect(content).toContain("new Job(");
     expect(content).toContain("npm ci");
     expect(content).toContain("npm test");
@@ -122,13 +125,13 @@ test-job:
 
     const content = files[0].content;
 
-    // 4 jobs: build-app, lint, unit-tests, deploy-staging
-    expect(ir.resources).toHaveLength(4);
+    // the Pipeline and 4 jobs: build-app, lint, unit-tests, deploy-staging
+    expect(ir.resources).toHaveLength(5);
     expect(content).toContain("buildApp");
     expect(content).toContain("lint");
     expect(content).toContain("unitTests");
     expect(content).toContain("deployStaging");
-    expect(content).toContain("Pipeline stages: build, test, deploy");
+    expect(content).toContain('stages: ["build", "test", "deploy"]');
     // Artifacts and cache references
     expect(content).toContain("dist/");
     expect(content).toContain("package-lock.json");
@@ -141,7 +144,8 @@ test-job:
 
     const content = files[0].content;
 
-    expect(ir.resources).toHaveLength(2);
+    // the Pipeline and 2 jobs
+    expect(ir.resources).toHaveLength(3);
     expect(content).toContain("buildImage");
     expect(content).toContain("pushLatest");
     expect(content).toContain("docker:27-cli");
@@ -157,8 +161,8 @@ test-job:
 
     const content = files[0].content;
 
-    // 5 jobs: build, deploy-review, stop-review, deploy-staging, deploy-production
-    expect(ir.resources).toHaveLength(5);
+    // the Pipeline and 5 jobs: build, deploy-review, stop-review, deploy-staging, deploy-production
+    expect(ir.resources).toHaveLength(6);
     expect(content).toContain("deployReview");
     expect(content).toContain("stopReview");
     expect(content).toContain("deployStaging");
@@ -179,7 +183,8 @@ test-job:
     // default + build + unit-test + integration-test + deploy
     expect(ir.resources.length).toBeGreaterThanOrEqual(3);
     expect(content).toContain("new Default(");
-    // Include references should be captured as comments
+    // Include references are the Pipeline's include (#3742)
+    expect(content).toContain("new Pipeline(");
     expect(content).toContain("Auto-DevOps.gitlab-ci.yml");
     expect(content).toContain("interruptible");
   });
@@ -191,8 +196,8 @@ test-job:
 
     const content = files[0].content;
 
-    // frontend, backend, e2e-matrix, deploy-all
-    expect(ir.resources).toHaveLength(4);
+    // the Pipeline, frontend, backend, e2e-matrix, deploy-all
+    expect(ir.resources).toHaveLength(5);
     expect(content).toContain("frontend");
     expect(content).toContain("backend");
     expect(content).toContain("e2eMatrix");
@@ -219,3 +224,50 @@ test-job:
     }
   });
 });
+
+describe("roundtrip: parse → generate → build (#3742)", () => {
+  test("top-level include, variables and stages come back from the build, an unused stage and the order included", async () => {
+    const { mkdirSync, rmSync, writeFileSync } = await import("fs");
+    const { build } = await import("@intentius/chant/build");
+    const { gitlabSerializer } = await import("../serializer");
+    const { gitlabPlugin } = await import("../plugin");
+    const { parseYAML } = await import("@intentius/chant/yaml");
+
+    const yaml = `
+include:
+  - local: ci/shared.yml
+variables:
+  GIT_DEPTH: "0"
+stages: [review, apply, ops]
+
+plan:
+  stage: review
+  script: [plan.sh]
+
+apply:
+  stage: apply
+  script: [apply.sh]
+`;
+    const [file] = generator.generate(parser.parse(yaml));
+    expect(file!.content).toContain("new Pipeline(");
+    expect(file!.content).toContain("new Include(");
+
+    const dir = join(dirname(fileURLToPath(import.meta.url)), `.import-build-tmp-${process.pid}`);
+    try {
+      mkdirSync(join(dir, "src"), { recursive: true });
+      writeFileSync(join(dir, "src", file!.path), file!.content);
+      const result = await build(join(dir, "src"), [gitlabSerializer], undefined, {
+        intrinsics: gitlabPlugin.intrinsics!(),
+        lexicons: ["gitlab"],
+      });
+      expect(result.errors).toEqual([]);
+      const out = result.outputs.get("gitlab");
+      const doc = parseYAML(typeof out === "string" ? out : String((out as { primary?: string }).primary)) as Record<string, unknown>;
+      expect(doc.include).toEqual([{ local: "ci/shared.yml" }]);
+      expect(doc.variables).toEqual({ GIT_DEPTH: "0" });
+      expect(doc.stages).toEqual(["review", "apply", "ops"]);
+    } finally {
+      rmSync(dir, { recursive: true, force: true });
+    }
+  }, 120_000);
+});