feat(job): Support defaults (#41)

Author: koki-develop

lib/package/job.spec.ts

@@ -4,14 +4,16 @@ import { Job } from "./job";
 describe("Job", () => {
   test.each<[Job, Record<string, unknown>]>([
     [
-      new Job("test", { runsOn: "ubuntu-latest" }).run("echo 'Hello, world!'"),
+      new Job("simple-job", { runsOn: "ubuntu-latest" }).run(
+        "echo 'Hello, world!'",
+      ),
       {
         "runs-on": "ubuntu-latest",
         steps: [{ run: "echo 'Hello, world!'" }],
       },
     ],
     [
-      new Job("test", {
+      new Job("with-permissions", {
         runsOn: "ubuntu-latest",
         permissions: {
           contents: "read",
@@ -28,7 +30,7 @@ describe("Job", () => {
       },
     ],
     [
-      new Job("test", {
+      new Job("with-timeout-minutes", {
         runsOn: "ubuntu-latest",
         timeoutMinutes: 10,
       }),
@@ -39,7 +41,7 @@ describe("Job", () => {
       },
     ],
     [
-      new Job("test", {
+      new Job("with-timeout-minutes", {
         runsOn: "ubuntu-latest",
         timeoutMinutes: "${{ foo }}",
       }),
@@ -50,7 +52,7 @@ describe("Job", () => {
       },
     ],
     [
-      new Job("test", {
+      new Job("with-outputs", {
         runsOn: "ubuntu-latest",
         outputs: {
           "output-name": "output-value",
@@ -63,7 +65,7 @@ describe("Job", () => {
       },
     ],
     [
-      new Job("test", {
+      new Job("with-needs", {
         runsOn: "ubuntu-latest",
         needs: "job-name",
       }).run("echo 'Hello, world!'"),
@@ -74,7 +76,7 @@ describe("Job", () => {
       },
     ],
     [
-      new Job("test", {
+      new Job("with-if", {
         runsOn: "ubuntu-latest",
         if: "always()",
       }).run("echo 'Hello, world!'"),
@@ -85,7 +87,7 @@ describe("Job", () => {
       },
     ],
     [
-      new Job("test", {
+      new Job("with-concurrency", {
         runsOn: "ubuntu-latest",
         concurrency: "group-name",
       }).run("echo 'Hello, world!'"),
@@ -96,7 +98,7 @@ describe("Job", () => {
       },
     ],
     [
-      new Job("test", {
+      new Job("with-concurrency", {
         runsOn: "ubuntu-latest",
         concurrency: { group: "group-name", cancelInProgress: true },
       }).run("echo 'Hello, world!'"),
@@ -106,6 +108,17 @@ describe("Job", () => {
         steps: [{ run: "echo 'Hello, world!'" }],
       },
     ],
+    [
+      new Job("with-defaults", {
+        runsOn: "ubuntu-latest",
+        defaults: { run: { shell: "bash" } },
+      }).run("echo 'Hello, world!'"),
+      {
+        "runs-on": "ubuntu-latest",
+        defaults: { run: { shell: "bash" } },
+        steps: [{ run: "echo 'Hello, world!'" }],
+      },
+    ],
   ])("job.toJSON(%j) -> %j", (job, expected) => {
     expect(job.toJSON()).toEqual(expected);
   });

lib/package/job.ts

@@ -1,7 +1,9 @@
 import { concurrencyJSON } from "../internal/concurrency";
+import { defaultsJSON } from "../internal/defaults";
 import { permissionsJSON } from "../internal/permissions";
 import { stepJSON } from "../internal/step";
 import { type Concurrency } from "./concurrency";
+import type { Defaults } from "./defaults";
 import type { Expression } from "./expression";
 import { type Permissions } from "./permissions";
 import { type RunStep, type Step, type UsesStep } from "./step";
@@ -17,7 +19,7 @@ export type JobConfig = {
   concurrency?: Concurrency;
   // TODO: outputs
   // TODO: env
-  // TODO: defaults
+  defaults?: Defaults;
   // TODO: strategy
   // TODO: continue-on-error
   // TODO: container
@@ -87,6 +89,10 @@ export class Job {
         concurrency: concurrencyJSON(this._config.concurrency),
       }),
 
+      ...(this._config.defaults != null && {
+        defaults: defaultsJSON(this._config.defaults),
+      }),
+
       steps: this._steps.map((step) => stepJSON(step)),
     };
   }