@factorialco/gat 0.0.13 → 0.0.16

package/dist/cli.js

@@ -10,21 +10,31 @@ const child_process_1 = require("child_process");
 const commander_1 = require("commander");
 const util_1 = require("util");
 const execPromise = (0, util_1.promisify)(child_process_1.exec);
+const writeFilePromise = (0, util_1.promisify)(fs_1.default.writeFile);
+const parseFile = async (templateFile) => {
+    const { stdout } = await execPromise(`npx ts-node ${templateFile}`);
+    await writeFilePromise(path_1.default.join(process.cwd(), ".github", "workflows", templateFile.split("/").at(-1).replace(".ts", ".yml")), stdout);
+};
 const cli = new commander_1.Command();
 cli.version("0.0.1").description("TODO");
 cli
     .command("build")
     .description("TODO")
-    .action(async () => {
+    .argument("[file]", "TODO")
+    .action(async (file) => {
     const folder = path_1.default.join(process.cwd(), ".github", "templates");
     if (!fs_1.default.existsSync(path_1.default.join(folder, "..", "workflows"))) {
         fs_1.default.mkdirSync(path_1.default.join(folder, "..", "workflows"));
     }
-    for await (const templateFile of fs_1.default.readdirSync(folder)) {
-        if (!templateFile.match(/^shared$/)) {
-            const { stdout } = await execPromise(`npx ts-node ${path_1.default.join(folder, templateFile)}`);
-            fs_1.default.writeFileSync(path_1.default.join(folder, "..", "workflows", templateFile.replace(".ts", ".yml")), stdout);
-        }
+    if (file !== undefined) {
+        await parseFile(file);
+    }
+    else {
+        await Promise.all(fs_1.default.readdirSync(folder).map(async (templateFile) => {
+            if (!templateFile.match(/^shared$/)) {
+                await parseFile(`${path_1.default.join(folder, templateFile)}`);
+            }
+        }));
     }
     process.exit(0);
 });

package/dist/event.d.ts

@@ -1,4 +1,4 @@
-export declare type EventName = "push" | "pull_request" | "pull_request_review" | "workflow_run" | "workflow_dispatch" | "schedule";
+export declare type EventName = "push" | "pull_request" | "pull_request_review" | "workflow_run" | "workflow_dispatch" | "schedule" | "pull_request_target";
 export declare type EventOptions<T extends EventName> = T extends "push" ? PushEventOptions : T extends "pull_request" ? PullRequestEventOptions : T extends "pull_request_review" ? PullRequestReviewEventOptions : T extends "workflow_run" ? WorkflowRunEventOptions : T extends "workflow_dispatch" ? WorkflowDispatchEventOptions : T extends "schedule" ? ScheduleEventOptions : never;
 interface PushEventOptions {
     branches?: string[];

package/dist/job.d.ts

@@ -21,6 +21,7 @@ export interface Service {
 }
 export interface JobOptions<Step, Runner, Name> {
     prettyName?: string;
+    permissions?: object;
     ifExpression?: string;
     runsOn?: Runner;
     timeout?: number;

package/dist/workflow.js

@@ -4,7 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Workflow = void 0;
-const yaml_1 = require("yaml");
+const js_yaml_1 = require("js-yaml");
 const kebabCase_1 = __importDefault(require("lodash/kebabCase"));
 const DEFAULT_RUNNERS = ["ubuntu-22.04"];
 class Workflow {
@@ -53,10 +53,11 @@ class Workflow {
             env: this.env.length > 0
                 ? Object.fromEntries(this.env.map(({ name, value }) => [name, value]))
                 : undefined,
-            jobs: Object.fromEntries(this.jobs.map(({ name, options: { prettyName, ifExpression, runsOn, matrix, env, steps, dependsOn, services, timeout, concurrency, outputs, }, }) => [
+            jobs: Object.fromEntries(this.jobs.map(({ name, options: { prettyName, permissions, ifExpression, runsOn, matrix, env, steps, dependsOn, services, timeout, concurrency, outputs, }, }) => [
                 name,
                 {
                     name: prettyName,
+                    permissions,
                     if: ifExpression,
                     "runs-on": this.assignRunner(runsOn),
                     "timeout-minutes": timeout ?? 15,
@@ -90,10 +91,10 @@ class Workflow {
                 },
             ])),
         };
-        const compiled = `# Template automatically generated by gat\n# DO NOT CHANGE THIS FILE MANUALLY\n\n${(0, yaml_1.stringify)(result, {
-            singleQuote: true,
-            aliasDuplicateObjects: false,
+        const compiled = `# Template automatically generated by gat\n# DO NOT CHANGE THIS FILE MANUALLY\n\n${(0, js_yaml_1.dump)(result, {
+            noRefs: true,
             lineWidth: 150,
+            noCompatMode: true,
         })}`;
         console.log(compiled);
         return compiled;

package/dist/workflow.spec.js

@@ -200,4 +200,32 @@ const workflow_1 = require("./workflow");
         });
         (0, vitest_1.expect)(workflow.compile()).toMatchSnapshot();
     });
+    (0, vitest_1.it)("allows permissions into jobs", () => {
+        const workflow = new workflow_1.Workflow("Job with permissions")
+            .on("push")
+            .addJob("job1", {
+            permissions: {
+                contents: "read",
+                "pull-requests": "write",
+            },
+            steps: [{ name: "Do something", run: "exit 0" }],
+        });
+        (0, vitest_1.expect)(workflow.compile()).toMatchSnapshot();
+    });
+    (0, vitest_1.it)("allows multiline strings", () => {
+        const workflow = new workflow_1.Workflow("Multiline strings")
+            .on("push")
+            .addJob("job1", {
+            steps: [
+                {
+                    name: "Do something",
+                    run: `
+              echo foo
+              exit 0
+            `,
+                },
+            ],
+        });
+        (0, vitest_1.expect)(workflow.compile()).toMatchSnapshot();
+    });
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@factorialco/gat",
-  "version": "0.0.13",
+  "version": "0.0.16",
   "description": "TODO",
   "bin": {
     "gat": "dist/cli.js"
@@ -23,6 +23,7 @@
   "author": "David Morcillo <david.morcillo@factorial.co>",
   "license": "ISC",
   "devDependencies": {
+    "@types/js-yaml": "^4.0.5",
     "@types/lodash": "^4.14.184",
     "@typescript-eslint/eslint-plugin": "^5.35.1",
     "@typescript-eslint/parser": "^5.35.1",
@@ -34,8 +35,8 @@
     "vitest": "^0.18.1"
   },
   "dependencies": {
-    "lodash": "^4.17.21",
-    "yaml": "^2.1.1"
+    "js-yaml": "^4.1.0",
+    "lodash": "^4.17.21"
   },
   "repository": {
     "type": "git",