@factorialco/gat 0.0.3 → 0.0.6

package/dist/job.d.ts

@@ -5,9 +5,9 @@ export interface ConcurrencyGroup {
 export interface Matrix {
     elements: Array<{
         id: string;
-        options: any[];
+        options: Array<string | number | boolean>;
     }>;
-    extra?: Array<Record<string, any>>;
+    extra?: Array<Record<string, string | number | boolean>>;
 }
 export interface Service {
     image: string;

package/dist/step.d.ts

@@ -11,5 +11,5 @@ export interface RunStep extends BaseStep {
 }
 export interface UseStep extends BaseStep {
     uses: string;
-    with?: any;
+    with?: Record<string, string | number | boolean>;
 }

package/dist/workflow.d.ts

@@ -1,6 +1,7 @@
 import { Job, JobOptions } from "./job";
 import type { Event, EventName, EventOptions } from "./event";
 import { BaseStep, Step } from "./step";
+declare const DEFAULT_RUNNERS: string[];
 interface DefaultOptions {
     workingDirectory: string;
 }
@@ -8,7 +9,7 @@ interface EnvVar {
     name: string;
     value: string;
 }
-export declare class Workflow<JobStep extends BaseStep = Step, Runner = "ubuntu-22.04", JobName = never> {
+export declare class Workflow<JobStep extends BaseStep = Step, Runner = typeof DEFAULT_RUNNERS, JobName = never> {
     name: string;
     events: Event[];
     jobs: Array<Job<JobStep, Runner, JobName>>;
@@ -18,8 +19,9 @@ export declare class Workflow<JobStep extends BaseStep = Step, Runner = "ubuntu-
     on<T extends EventName>(name: T, options?: EventOptions<T>): this;
     addDefaults(options: DefaultOptions): this;
     addJob<T extends string>(name: T, options: JobOptions<JobStep, Runner, JobName>): Workflow<JobStep, Runner, JobName | T>;
-    setEnv(name: string, value: any): this;
+    setEnv(name: string, value: string): this;
     defaultRunner(): string;
+    private assignRunner;
     compile(): string;
 }
 export {};

package/dist/workflow.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Workflow = void 0;
 const yaml_1 = require("yaml");
 const kebabCase_1 = __importDefault(require("lodash/kebabCase"));
+const DEFAULT_RUNNERS = ["ubuntu-22.04"];
 class Workflow {
     constructor(name) {
         this.name = name;
@@ -33,6 +34,11 @@ class Workflow {
     defaultRunner() {
         return "ubuntu-22.04";
     }
+    assignRunner(runsOn) {
+        const runnerName = runsOn ?? this.defaultRunner();
+        const isSelfHosted = !DEFAULT_RUNNERS.includes(runnerName);
+        return isSelfHosted ? ["self-hosted", runnerName] : runnerName;
+    }
     compile() {
         const result = {
             name: this.name,
@@ -47,11 +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: { ifExpression, runsOn, matrix, steps, dependsOn, services, timeout, concurrency, outputs, }, }) => [
+            jobs: Object.fromEntries(this.jobs.map(({ name, options: { ifExpression, runsOn, matrix, env, steps, dependsOn, services, timeout, concurrency, outputs, }, }) => [
                 name,
                 {
                     if: ifExpression,
-                    "runs-on": runsOn ?? this.defaultRunner(),
+                    "runs-on": this.assignRunner(runsOn),
                     "timeout-minutes": timeout ?? 15,
                     needs: dependsOn,
                     services,
@@ -70,6 +76,7 @@ class Workflow {
                             },
                         }
                         : undefined,
+                    env,
                     steps: steps.map(({ id, name, ifExpression, workingDirectory, ...options }) => ({
                         id,
                         name,

package/dist/workflow.spec.js

@@ -43,7 +43,7 @@ const workflow_1 = require("./workflow");
         workflow
             .on("push")
             .setEnv("NODE_VERSION", "16")
-            .setEnv("ENABLED", true)
+            .setEnv("ENABLED", "true")
             .addJob("job1", {
             steps: [
                 {
@@ -131,7 +131,7 @@ const workflow_1 = require("./workflow");
         workflow
             .on("push")
             .setEnv("NODE_VERSION", "16")
-            .setEnv("ENABLED", true)
+            .setEnv("ENABLED", "true")
             .addJob("job1", {
             steps: [
                 {
@@ -147,7 +147,7 @@ const workflow_1 = require("./workflow");
     (0, vitest_1.it)("allows custom types in a workflow", () => {
         const workflow = new workflow_1.Workflow("With custom types");
         workflow.on("push").addJob("job1", {
-            runsOn: ["self-hosted", "standard-runner"],
+            runsOn: "standard-runner",
             steps: [
                 {
                     run: "echo 'Do something'",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@factorialco/gat",
-  "version": "0.0.3",
+  "version": "0.0.6",
   "description": "TODO",
   "bin": {
     "gat": "dist/cli.js"
@@ -15,13 +15,21 @@
     "prepare": "npm run build",
     "prepublishOnly": "vitest run",
     "test": "vitest",
-    "coverage": "vitest run --coverage"
+    "coverage": "vitest run --coverage",
+    "lint": "eslint src/**/*.ts",
+    "format": "prettier --write .",
+    "format:check": "prettier --check ."
   },
   "author": "David Morcillo <david.morcillo@factorial.co>",
   "license": "ISC",
   "devDependencies": {
     "@types/lodash": "^4.14.184",
+    "@typescript-eslint/eslint-plugin": "^5.35.1",
+    "@typescript-eslint/parser": "^5.35.1",
     "commander": "^9.4.0",
+    "eslint": "^8.23.0",
+    "eslint-config-prettier": "^8.5.0",
+    "prettier": "2.7.1",
     "typescript": "^4.7.4",
     "vitest": "^0.18.1"
   },