feat: Support Workflow level env: (#19)

* chore: Implement envJSON

* chore: Implement removeUndefinedKeys function

* feat: Support workflow level env

Author: koki-develop

lib/package/env.spec.ts

@@ -0,0 +1,20 @@
+import { describe, expect, test } from "bun:test";
+import { envJSON } from "./env";
+
+describe("envJSON", () => {
+  test("should return undefined if env is undefined", () => {
+    expect(envJSON()).toBeUndefined();
+  });
+
+  test("should return env as a record", () => {
+    expect(
+      envJSON({
+        HOGE: "hoge",
+        FUGA: "fuga",
+      }),
+    ).toEqual({
+      HOGE: "hoge",
+      FUGA: "fuga",
+    });
+  });
+});

lib/package/env.ts

@@ -0,0 +1,8 @@
+export type Env = {
+  [key: string]: string;
+};
+
+export function envJSON(env?: Env): Record<string, unknown> | undefined {
+  if (env == null) return undefined;
+  return env;
+}

lib/package/workflow.spec.ts

@@ -12,6 +12,29 @@ describe("Workflow", () => {
       "run-name": undefined,
       on: "push",
       permissions: undefined,
+      env: undefined,
+      jobs: {},
+    });
+  });
+
+  test("workflow with env", () => {
+    const workflow = new Workflow("simple", {
+      on: "push",
+      env: {
+        FOO: "foo",
+        BAR: "bar",
+      },
+    });
+
+    expect(workflow.toJSON()).toEqual({
+      name: "simple",
+      "run-name": undefined,
+      on: "push",
+      env: {
+        FOO: "foo",
+        BAR: "bar",
+      },
+      permissions: undefined,
       jobs: {},
     });
   });

lib/package/workflow.ts

@@ -1,4 +1,5 @@
 import { type Concurrency, concurrencyJSON } from "./concurrency";
+import { type Env, envJSON } from "./env";
 import { Job } from "./job";
 import { type On, onJSON } from "./on";
 import { type Permissions, permissionsJSON } from "./permission";
@@ -8,6 +9,7 @@ export type WorkflowConfig = {
   concurrency?: Concurrency;
   on: On;
   permissions?: Permissions;
+  env?: Env;
 };
 
 export class Workflow {
@@ -31,8 +33,7 @@ export class Workflow {
       "run-name": this._config.runName,
       on: onJSON(this._config.on),
       permissions: permissionsJSON(this._config.permissions),
-
-      // TODO: env
+      env: envJSON(this._config.env),
 
       // TODO: defaults
 

lib/util/util.spec.ts

@@ -1,5 +1,5 @@
 import { describe, expect, test } from "bun:test";
-import { toUpperCamelCase } from "./util";
+import { removeUndefinedKeys, toUpperCamelCase } from "./util";
 
 describe("toUpperCamelCase", () => {
   test.each([
@@ -30,3 +30,12 @@ describe("toUpperCamelCase", () => {
     expect(toUpperCamelCase(input)).toBe(expected);
   });
 });
+
+describe("removeUndefinedKeys", () => {
+  test.each([
+    [{ foo: "bar", baz: undefined }, ["foo"]],
+    [{ foo: "bar", baz: undefined, hoge: "fuga" }, ["foo", "hoge"]],
+  ])("removeUndefinedKeys(%j) returns %j", (input, expected) => {
+    expect(Object.keys(removeUndefinedKeys(input))).toEqual(expected);
+  });
+});

lib/util/util.ts

@@ -4,3 +4,11 @@ export function toUpperCamelCase(str: string): string {
     .map((word) => word.charAt(0).toUpperCase() + word.slice(1))
     .join("");
 }
+
+export function removeUndefinedKeys<T extends Record<string, unknown>>(
+  obj: T,
+): Partial<T> {
+  return Object.fromEntries(
+    Object.entries(obj).filter(([_, value]) => value !== undefined),
+  ) as Partial<T>;
+}