@intentius/chant-lexicon-github 0.0.18 → 0.0.24

package/src/composites/checkout.ts

@@ -1,4 +1,5 @@
-import { Composite } from "@intentius/chant";
+import { Composite, mergeDefaults } from "@intentius/chant";
+import type { Step } from "../generated/index";
 
 export interface CheckoutProps {
   ref?: string;
@@ -7,9 +8,13 @@ export interface CheckoutProps {
   token?: string;
   submodules?: boolean | string;
   sshKey?: string;
+  defaults?: {
+    step?: Partial<ConstructorParameters<typeof Step>[0]>;
+  };
 }
 
 export const Checkout = Composite<CheckoutProps>((props) => {
+  const { defaults } = props;
   const withObj: Record<string, string> = {};
   if (props.ref !== undefined) withObj.ref = props.ref;
   if (props.repository !== undefined) withObj.repository = props.repository;
@@ -21,11 +26,11 @@ export const Checkout = Composite<CheckoutProps>((props) => {
   // Import Step lazily to avoid circular dependency at module load time
   const { createProperty } = require("@intentius/chant/runtime");
   const StepClass = createProperty("GitHub::Actions::Step", "github");
-  const step = new StepClass({
+  const step = new StepClass(mergeDefaults({
     name: "Checkout",
     uses: "actions/checkout@v4",
     ...(Object.keys(withObj).length > 0 ? { with: withObj } : {}),
-  });
+  }, defaults?.step));
 
   return { step };
 }, "Checkout");

package/src/composites/composites.test.ts

@@ -673,3 +673,109 @@ describe("GoCI", () => {
     expect(result.testJob.props["runs-on"]).toBe("macos-latest");
   });
 });
+
+// ── Defaults overrides ─────────────────────────────────────────────
+
+describe("defaults overrides", () => {
+  test("Checkout defaults override step props", () => {
+    const result = Checkout({
+      ref: "main",
+      defaults: { step: { id: "my-checkout" } },
+    });
+    expect(result.step.props.id).toBe("my-checkout");
+    expect(result.step.props.uses).toBe("actions/checkout@v4");
+  });
+
+  test("SetupNode defaults override step props", () => {
+    const result = SetupNode({
+      nodeVersion: "20",
+      defaults: { step: { id: "setup" } },
+    });
+    expect(result.step.props.id).toBe("setup");
+    expect(result.step.props.name).toBe("Setup Node.js");
+  });
+
+  test("NodeCI defaults override job and workflow props", () => {
+    const result = NodeCI({
+      defaults: {
+        job: { "timeout-minutes": 30 } as any,
+        workflow: { concurrency: "ci-${{ github.ref }}" } as any,
+      },
+    });
+    expect(result.job.props["timeout-minutes"]).toBe(30);
+    expect(result.workflow.props.concurrency).toBe("ci-${{ github.ref }}");
+  });
+
+  test("NodePipeline defaults override individual jobs", () => {
+    const result = NodePipeline({
+      defaults: {
+        buildJob: { "timeout-minutes": 15 } as any,
+        testJob: { "timeout-minutes": 20 } as any,
+      },
+    });
+    expect(result.buildJob.props["timeout-minutes"]).toBe(15);
+    expect(result.testJob.props["timeout-minutes"]).toBe(20);
+  });
+
+  test("DockerBuild defaults override job and workflow", () => {
+    const result = DockerBuild({
+      defaults: {
+        job: { "timeout-minutes": 60 } as any,
+        workflow: { concurrency: "docker" } as any,
+      },
+    });
+    expect(result.job.props["timeout-minutes"]).toBe(60);
+    expect(result.workflow.props.concurrency).toBe("docker");
+  });
+
+  test("DeployEnvironment defaults override deploy and cleanup jobs", () => {
+    const result = DeployEnvironment({
+      name: "staging",
+      deployScript: "npm run deploy",
+      defaults: {
+        deployJob: { "timeout-minutes": 30 } as any,
+        cleanupJob: { "timeout-minutes": 10 } as any,
+      },
+    });
+    expect(result.deployJob.props["timeout-minutes"]).toBe(30);
+    expect(result.cleanupJob.props["timeout-minutes"]).toBe(10);
+  });
+
+  test("GoCI defaults override workflow name", () => {
+    const result = GoCI({
+      defaults: {
+        workflow: { name: "Custom Go CI" } as any,
+      },
+    });
+    expect(result.workflow.props.name).toBe("Custom Go CI");
+  });
+
+  test("PythonCI defaults override testJob", () => {
+    const result = PythonCI({
+      defaults: {
+        testJob: { "timeout-minutes": 45 } as any,
+      },
+    });
+    expect(result.testJob.props["timeout-minutes"]).toBe(45);
+  });
+
+  test("UploadArtifact defaults override step props", () => {
+    const result = UploadArtifact({
+      name: "build",
+      path: "dist/",
+      defaults: { step: { id: "upload" } },
+    });
+    expect(result.step.props.id).toBe("upload");
+    expect(result.step.props.uses).toBe("actions/upload-artifact@v4");
+  });
+
+  test("CacheAction defaults override step props", () => {
+    const result = CacheAction({
+      path: "node_modules",
+      key: "cache-key",
+      defaults: { step: { id: "cache-step" } },
+    });
+    expect(result.step.props.id).toBe("cache-step");
+    expect(result.step.props.uses).toBe("actions/cache@v4");
+  });
+});

package/src/composites/deploy-environment.ts

@@ -1,4 +1,5 @@
-import { Composite } from "@intentius/chant";
+import { Composite, mergeDefaults } from "@intentius/chant";
+import type { Job } from "../generated/index";
 
 export interface DeployEnvironmentProps {
   /** Environment name. Required. */
@@ -15,6 +16,10 @@ export interface DeployEnvironmentProps {
   cancelInProgress?: boolean;
   /** Runner label. Default: "ubuntu-latest" */
   runsOn?: string;
+  defaults?: {
+    deployJob?: Partial<ConstructorParameters<typeof Job>[0]>;
+    cleanupJob?: Partial<ConstructorParameters<typeof Job>[0]>;
+  };
 }
 
 export const DeployEnvironment = Composite<DeployEnvironmentProps>((props) => {
@@ -26,6 +31,7 @@ export const DeployEnvironment = Composite<DeployEnvironmentProps>((props) => {
     concurrencyGroup,
     cancelInProgress = true,
     runsOn = "ubuntu-latest",
+    defaults,
   } = props;
 
   const group = concurrencyGroup ?? `deploy-${name}`;
@@ -49,7 +55,7 @@ export const DeployEnvironment = Composite<DeployEnvironmentProps>((props) => {
     environment.url = url;
   }
 
-  const deployJob = new JobClass({
+  const deployJob = new JobClass(mergeDefaults({
     "runs-on": runsOn,
     environment,
     concurrency: {
@@ -57,7 +63,7 @@ export const DeployEnvironment = Composite<DeployEnvironmentProps>((props) => {
       "cancel-in-progress": cancelInProgress,
     },
     steps: deploySteps,
-  });
+  }, defaults?.deployJob));
 
   // ── Cleanup job ────────────────────────────────────────────────────
   const cleanupSteps = [
@@ -67,11 +73,11 @@ export const DeployEnvironment = Composite<DeployEnvironmentProps>((props) => {
     ),
   ];
 
-  const cleanupJob = new JobClass({
+  const cleanupJob = new JobClass(mergeDefaults({
     "runs-on": runsOn,
     environment: { name },
     steps: cleanupSteps,
-  });
+  }, defaults?.cleanupJob));
 
   return { deployJob, cleanupJob };
 }, "DeployEnvironment");

package/src/composites/docker-build.ts

@@ -1,4 +1,5 @@
-import { Composite } from "@intentius/chant";
+import { Composite, mergeDefaults } from "@intentius/chant";
+import type { Job, Workflow } from "../generated/index";
 
 export interface DockerBuildProps {
   /** Image tag. Default: "${{ github.sha }}" */
@@ -21,6 +22,10 @@ export interface DockerBuildProps {
   platforms?: string[];
   /** Runner label. Default: "ubuntu-latest" */
   runsOn?: string;
+  defaults?: {
+    job?: Partial<ConstructorParameters<typeof Job>[0]>;
+    workflow?: Partial<ConstructorParameters<typeof Workflow>[0]>;
+  };
 }
 
 export const DockerBuild = Composite<DockerBuildProps>((props) => {
@@ -35,6 +40,7 @@ export const DockerBuild = Composite<DockerBuildProps>((props) => {
     push = true,
     platforms,
     runsOn = "ubuntu-latest",
+    defaults,
   } = props;
 
   const { createProperty, createResource } = require("@intentius/chant/runtime");
@@ -100,12 +106,12 @@ export const DockerBuild = Composite<DockerBuildProps>((props) => {
     with: buildPushWith,
   });
 
-  const job = new JobClass({
+  const job = new JobClass(mergeDefaults({
     "runs-on": runsOn,
     steps: [checkout, login, setupBuildx, metadata, buildPush],
-  });
+  }, defaults?.job));
 
-  const workflow = new WorkflowClass({
+  const workflow = new WorkflowClass(mergeDefaults({
     name: "Docker Build",
     on: {
       push: { branches: ["main"] },
@@ -114,7 +120,7 @@ export const DockerBuild = Composite<DockerBuildProps>((props) => {
       contents: "read",
       packages: "write",
     },
-  });
+  }, defaults?.workflow));
 
   return { workflow, job };
 }, "DockerBuild");

package/src/composites/download-artifact.ts

@@ -1,12 +1,17 @@
-import { Composite } from "@intentius/chant";
+import { Composite, mergeDefaults } from "@intentius/chant";
+import type { Step } from "../generated/index";
 
 export interface DownloadArtifactProps {
   name?: string;
   path?: string;
   mergeMultiple?: boolean;
+  defaults?: {
+    step?: Partial<ConstructorParameters<typeof Step>[0]>;
+  };
 }
 
 export const DownloadArtifact = Composite<DownloadArtifactProps>((props) => {
+  const { defaults } = props;
   const withObj: Record<string, string> = {};
   if (props.name !== undefined) withObj.name = props.name;
   if (props.path !== undefined) withObj.path = props.path;
@@ -14,11 +19,11 @@ export const DownloadArtifact = Composite<DownloadArtifactProps>((props) => {
 
   const { createProperty } = require("@intentius/chant/runtime");
   const StepClass = createProperty("GitHub::Actions::Step", "github");
-  const step = new StepClass({
+  const step = new StepClass(mergeDefaults({
     name: "Download Artifact",
     uses: "actions/download-artifact@v4",
     ...(Object.keys(withObj).length > 0 ? { with: withObj } : {}),
-  });
+  }, defaults?.step));
 
   return { step };
 }, "DownloadArtifact");

package/src/composites/go-ci.ts

@@ -1,4 +1,5 @@
-import { Composite } from "@intentius/chant";
+import { Composite, mergeDefaults } from "@intentius/chant";
+import type { Job, Workflow } from "../generated/index";
 
 export interface GoCIProps {
   /** Go version. Default: "1.22" */
@@ -11,6 +12,12 @@ export interface GoCIProps {
   lintCommand?: string | null;
   /** Runner label. Default: "ubuntu-latest" */
   runsOn?: string;
+  defaults?: {
+    buildJob?: Partial<ConstructorParameters<typeof Job>[0]>;
+    testJob?: Partial<ConstructorParameters<typeof Job>[0]>;
+    lintJob?: Partial<ConstructorParameters<typeof Job>[0]>;
+    workflow?: Partial<ConstructorParameters<typeof Workflow>[0]>;
+  };
 }
 
 export const GoCI = Composite<GoCIProps>((props) => {
@@ -20,6 +27,7 @@ export const GoCI = Composite<GoCIProps>((props) => {
     buildCommand = "go build ./...",
     lintCommand = "golangci-lint run",
     runsOn = "ubuntu-latest",
+    defaults,
   } = props;
 
   const { createProperty, createResource } = require("@intentius/chant/runtime");
@@ -28,7 +36,7 @@ export const GoCI = Composite<GoCIProps>((props) => {
   const WorkflowClass = createResource("GitHub::Actions::Workflow", "github", {});
 
   // ── Build job ──────────────────────────────────────────────────────
-  const buildJob = new JobClass({
+  const buildJob = new JobClass(mergeDefaults({
     "runs-on": runsOn,
     steps: [
       new StepClass({ name: "Checkout", uses: "actions/checkout@v4" }),
@@ -39,10 +47,10 @@ export const GoCI = Composite<GoCIProps>((props) => {
       }),
       new StepClass({ name: "Build", run: buildCommand }),
     ],
-  });
+  }, defaults?.buildJob));
 
   // ── Test job ───────────────────────────────────────────────────────
-  const testJob = new JobClass({
+  const testJob = new JobClass(mergeDefaults({
     "runs-on": runsOn,
     steps: [
       new StepClass({ name: "Checkout", uses: "actions/checkout@v4" }),
@@ -53,12 +61,12 @@ export const GoCI = Composite<GoCIProps>((props) => {
       }),
       new StepClass({ name: "Test", run: testCommand }),
     ],
-  });
+  }, defaults?.testJob));
 
   // ── Lint job (optional) ────────────────────────────────────────────
   const lintJob =
     lintCommand !== null
-      ? new JobClass({
+      ? new JobClass(mergeDefaults({
           "runs-on": runsOn,
           steps: [
             new StepClass({ name: "Checkout", uses: "actions/checkout@v4" }),
@@ -73,16 +81,16 @@ export const GoCI = Composite<GoCIProps>((props) => {
               with: { args: lintCommand },
             }),
           ],
-        })
+        }, defaults?.lintJob))
       : undefined;
 
-  const workflow = new WorkflowClass({
+  const workflow = new WorkflowClass(mergeDefaults({
     name: "Go CI",
     on: {
       push: { branches: ["main"] },
       pull_request: { branches: ["main"] },
     },
-  });
+  }, defaults?.workflow));
 
   if (lintJob) {
     return { workflow, buildJob, testJob, lintJob };

package/src/composites/node-ci.ts

@@ -1,4 +1,5 @@
-import { Composite } from "@intentius/chant";
+import { Composite, mergeDefaults } from "@intentius/chant";
+import type { Job, Workflow } from "../generated/index";
 
 export interface NodeCIProps {
   nodeVersion?: string;
@@ -6,6 +7,10 @@ export interface NodeCIProps {
   buildScript?: string;
   testScript?: string;
   installCommand?: string;
+  defaults?: {
+    job?: Partial<ConstructorParameters<typeof Job>[0]>;
+    workflow?: Partial<ConstructorParameters<typeof Workflow>[0]>;
+  };
 }
 
 export const NodeCI = Composite<NodeCIProps>((props) => {
@@ -15,6 +20,7 @@ export const NodeCI = Composite<NodeCIProps>((props) => {
     buildScript = "build",
     testScript = "test",
     installCommand,
+    defaults,
   } = props;
 
   const install = installCommand ?? (packageManager === "npm" ? "npm ci" : `${packageManager} install`);
@@ -54,18 +60,18 @@ export const NodeCI = Composite<NodeCIProps>((props) => {
     run: `${run} ${testScript}`,
   });
 
-  const job = new JobClass({
+  const job = new JobClass(mergeDefaults({
     "runs-on": "ubuntu-latest",
     steps: [checkoutStep, setupNodeStep, installStep, buildStep, testStep],
-  });
+  }, defaults?.job));
 
-  const workflow = new WorkflowClass({
+  const workflow = new WorkflowClass(mergeDefaults({
     name: "CI",
     on: {
       push: { branches: ["main"] },
       pull_request: { branches: ["main"] },
     },
-  });
+  }, defaults?.workflow));
 
   return { workflow, job };
 }, "NodeCI");

package/src/composites/node-pipeline.ts

@@ -1,4 +1,5 @@
-import { Composite, withDefaults } from "@intentius/chant";
+import { Composite, withDefaults, mergeDefaults } from "@intentius/chant";
+import type { Job, Workflow } from "../generated/index";
 
 export interface NodePipelineProps {
   /** Node.js version. Default: "22" */
@@ -19,6 +20,11 @@ export interface NodePipelineProps {
   artifactRetentionDays?: number;
   /** Runner label. Default: "ubuntu-latest" */
   runsOn?: string;
+  defaults?: {
+    buildJob?: Partial<ConstructorParameters<typeof Job>[0]>;
+    testJob?: Partial<ConstructorParameters<typeof Job>[0]>;
+    workflow?: Partial<ConstructorParameters<typeof Workflow>[0]>;
+  };
 }
 
 const cacheConfig = {
@@ -59,6 +65,7 @@ export const NodePipeline = Composite<NodePipelineProps>((props) => {
     artifactName = "build-output",
     artifactRetentionDays = 1,
     runsOn = "ubuntu-latest",
+    defaults,
   } = props;
 
   const pm = cacheConfig[packageManager];
@@ -97,10 +104,10 @@ export const NodePipeline = Composite<NodePipelineProps>((props) => {
     },
   });
 
-  const buildJob = new JobClass({
+  const buildJob = new JobClass(mergeDefaults({
     "runs-on": runsOn,
     steps: [buildCheckout, buildSetup, buildInstall, buildRun, buildUpload],
-  });
+  }, defaults?.buildJob));
 
   // ── Test job steps ─────────────────────────────────────────────────
   const testCheckout = new StepClass({ name: "Checkout", uses: "actions/checkout@v4" });
@@ -123,20 +130,20 @@ export const NodePipeline = Composite<NodePipelineProps>((props) => {
 
   const testRun = new StepClass({ name: "Test", run: `${run} ${testScript}` });
 
-  const testJob = new JobClass({
+  const testJob = new JobClass(mergeDefaults({
     "runs-on": runsOn,
     needs: ["build"],
     steps: [testCheckout, testSetup, testInstall, testDownload, testRun],
-  });
+  }, defaults?.testJob));
 
   // ── Workflow ───────────────────────────────────────────────────────
-  const workflow = new WorkflowClass({
+  const workflow = new WorkflowClass(mergeDefaults({
     name: "Node Pipeline",
     on: {
       push: { branches: ["main"] },
       pull_request: { branches: ["main"] },
     },
-  });
+  }, defaults?.workflow));
 
   return { workflow, buildJob, testJob };
 }, "NodePipeline");

package/src/composites/python-ci.ts

@@ -1,4 +1,5 @@
-import { Composite } from "@intentius/chant";
+import { Composite, mergeDefaults } from "@intentius/chant";
+import type { Job, Workflow } from "../generated/index";
 
 export interface PythonCIProps {
   /** Python version. Default: "3.12" */
@@ -13,6 +14,11 @@ export interface PythonCIProps {
   usePoetry?: boolean;
   /** Runner label. Default: "ubuntu-latest" */
   runsOn?: string;
+  defaults?: {
+    testJob?: Partial<ConstructorParameters<typeof Job>[0]>;
+    lintJob?: Partial<ConstructorParameters<typeof Job>[0]>;
+    workflow?: Partial<ConstructorParameters<typeof Workflow>[0]>;
+  };
 }
 
 export const PythonCI = Composite<PythonCIProps>((props) => {
@@ -23,6 +29,7 @@ export const PythonCI = Composite<PythonCIProps>((props) => {
     requirementsFile = "requirements.txt",
     usePoetry = false,
     runsOn = "ubuntu-latest",
+    defaults,
   } = props;
 
   const { createProperty, createResource } = require("@intentius/chant/runtime");
@@ -41,7 +48,7 @@ export const PythonCI = Composite<PythonCIProps>((props) => {
       ];
 
   // ── Test job ───────────────────────────────────────────────────────
-  const testJob = new JobClass({
+  const testJob = new JobClass(mergeDefaults({
     "runs-on": runsOn,
     steps: [
       new StepClass({ name: "Checkout", uses: "actions/checkout@v4" }),
@@ -53,12 +60,12 @@ export const PythonCI = Composite<PythonCIProps>((props) => {
       ...installSteps,
       new StepClass({ name: "Test", run: testCommand }),
     ],
-  });
+  }, defaults?.testJob));
 
   // ── Lint job (optional) ────────────────────────────────────────────
   const lintJob =
     lintCommand !== null
-      ? new JobClass({
+      ? new JobClass(mergeDefaults({
           "runs-on": runsOn,
           steps: [
             new StepClass({ name: "Checkout", uses: "actions/checkout@v4" }),
@@ -73,17 +80,17 @@ export const PythonCI = Composite<PythonCIProps>((props) => {
             }),
             new StepClass({ name: "Lint", run: lintCommand }),
           ],
-        })
+        }, defaults?.lintJob))
       : undefined;
 
   // ── Workflow ───────────────────────────────────────────────────────
-  const workflow = new WorkflowClass({
+  const workflow = new WorkflowClass(mergeDefaults({
     name: "Python CI",
     on: {
       push: { branches: ["main"] },
       pull_request: { branches: ["main"] },
     },
-  });
+  }, defaults?.workflow));
 
   if (lintJob) {
     return { workflow, testJob, lintJob };

package/src/composites/setup-go.ts

@@ -1,12 +1,17 @@
-import { Composite } from "@intentius/chant";
+import { Composite, mergeDefaults } from "@intentius/chant";
+import type { Step } from "../generated/index";
 
 export interface SetupGoProps {
   goVersion?: string;
   goVersionFile?: string;
   cache?: boolean;
+  defaults?: {
+    step?: Partial<ConstructorParameters<typeof Step>[0]>;
+  };
 }
 
 export const SetupGo = Composite<SetupGoProps>((props) => {
+  const { defaults } = props;
   const withObj: Record<string, string> = {};
   if (props.goVersion !== undefined) withObj["go-version"] = props.goVersion;
   if (props.goVersionFile !== undefined) withObj["go-version-file"] = props.goVersionFile;
@@ -14,11 +19,11 @@ export const SetupGo = Composite<SetupGoProps>((props) => {
 
   const { createProperty } = require("@intentius/chant/runtime");
   const StepClass = createProperty("GitHub::Actions::Step", "github");
-  const step = new StepClass({
+  const step = new StepClass(mergeDefaults({
     name: "Setup Go",
     uses: "actions/setup-go@v5",
     ...(Object.keys(withObj).length > 0 ? { with: withObj } : {}),
-  });
+  }, defaults?.step));
 
   return { step };
 }, "SetupGo");

package/src/composites/setup-node.ts

@@ -1,13 +1,18 @@
-import { Composite } from "@intentius/chant";
+import { Composite, mergeDefaults } from "@intentius/chant";
+import type { Step } from "../generated/index";
 
 export interface SetupNodeProps {
   nodeVersion?: string;
   registryUrl?: string;
   cache?: string;
   cacheFilePath?: string;
+  defaults?: {
+    step?: Partial<ConstructorParameters<typeof Step>[0]>;
+  };
 }
 
 export const SetupNode = Composite<SetupNodeProps>((props) => {
+  const { defaults } = props;
   const withObj: Record<string, string> = {};
   if (props.nodeVersion !== undefined) withObj["node-version"] = props.nodeVersion;
   if (props.registryUrl !== undefined) withObj["registry-url"] = props.registryUrl;
@@ -16,11 +21,11 @@ export const SetupNode = Composite<SetupNodeProps>((props) => {
 
   const { createProperty } = require("@intentius/chant/runtime");
   const StepClass = createProperty("GitHub::Actions::Step", "github");
-  const step = new StepClass({
+  const step = new StepClass(mergeDefaults({
     name: "Setup Node.js",
     uses: "actions/setup-node@v4",
     ...(Object.keys(withObj).length > 0 ? { with: withObj } : {}),
-  });
+  }, defaults?.step));
 
   return { step };
 }, "SetupNode");

package/src/composites/setup-python.ts

@@ -1,12 +1,17 @@
-import { Composite } from "@intentius/chant";
+import { Composite, mergeDefaults } from "@intentius/chant";
+import type { Step } from "../generated/index";
 
 export interface SetupPythonProps {
   pythonVersion?: string;
   cache?: string;
   architecture?: string;
+  defaults?: {
+    step?: Partial<ConstructorParameters<typeof Step>[0]>;
+  };
 }
 
 export const SetupPython = Composite<SetupPythonProps>((props) => {
+  const { defaults } = props;
   const withObj: Record<string, string> = {};
   if (props.pythonVersion !== undefined) withObj["python-version"] = props.pythonVersion;
   if (props.cache !== undefined) withObj.cache = props.cache;
@@ -14,11 +19,11 @@ export const SetupPython = Composite<SetupPythonProps>((props) => {
 
   const { createProperty } = require("@intentius/chant/runtime");
   const StepClass = createProperty("GitHub::Actions::Step", "github");
-  const step = new StepClass({
+  const step = new StepClass(mergeDefaults({
     name: "Setup Python",
     uses: "actions/setup-python@v5",
     ...(Object.keys(withObj).length > 0 ? { with: withObj } : {}),
-  });
+  }, defaults?.step));
 
   return { step };
 }, "SetupPython");