@catladder/cli 0.0.0-next-95928577 → 0.0.0-next-e7541a00

package/dist/pipeline/src/backends/gitlab/getPipelineStages.js

@@ -0,0 +1,19 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getPipelineStages = void 0;
+const config_1 = require("../../config");
+const jobs_1 = require("../../types/jobs");
+/**
+ * while technically not required, we group different envs in its own stage
+ * each job from `createJobs` that is defined as `envMode: "stagePerEnv"` will have `deploy dev`, etc. instead of just `deploy`
+ * this is just so that it looks nicer in gitlab and makes running mutliple manual tasks more easy to use
+ */
+function getPipelineStages(config) {
+  const allEnvs = (0, config_1.getAllEnvsInAllComponents)(config).filter(e => e !== "local");
+  const stages = jobs_1.BASE_STAGES.reduce((acc, baseStage) => [...acc, baseStage, ...allEnvs.map(e => `${baseStage} ${e}`)], []);
+  return stages;
+}
+exports.getPipelineStages = getPipelineStages;

package/dist/pipeline/src/backends/gitlab/getPipelineStages.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getPipelineStages.js","sourceRoot":"","sources":["../../../../../../pipeline/src/backends/gitlab/getPipelineStages.ts"],"names":[],"mappings":";;;AAAA,yCAAyD;AAEzD,2CAA+C;AAE/C;;;;GAIG;AACH,SAAgB,iBAAiB,CAAC,MAAc;IAC9C,MAAM,OAAO,GAAG,IAAA,kCAAyB,EAAC,MAAM,CAAC,CAAC,MAAM,CACtD,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,OAAO,CACrB,CAAC;IACF,MAAM,MAAM,GAAG,kBAAW,CAAC,MAAM,CAC/B,CAAC,GAAG,EAAE,SAAS,EAAE,EAAE,CAAC;QAClB,GAAG,GAAG;QACN,SAAS;QACT,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,SAAS,IAAI,CAAC,EAAE,CAAC;KAC3C,EACD,EAAE,CACH,CAAC;IACF,OAAO,MAAM,CAAC;AAChB,CAAC;AAbD,8CAaC"}

package/dist/pipeline/src/backends/gitlab/gitlabReleaseJobs.d.ts

@@ -0,0 +1,36 @@
+import type { Config } from "../../types/config";
+export declare const getGitlabReleaseJobs: (config: Config) => {
+  "create release": {
+    stage: string;
+    image: string;
+    script: string[];
+    after_script: string[];
+    rules: {
+      if?: string;
+      changes?: import("../../types/gitlab-ci-yml").Changes;
+      exists?: import("../../types/gitlab-ci-yml").Exists;
+      variables?: import("../../types/gitlab-ci-yml").RulesVariables;
+      when?: import("../../types/gitlab-ci-yml").When;
+      start_in?: string;
+      allow_failure?: import("../../types/gitlab-ci-yml").AllowFailure;
+      needs?: import("../../types/gitlab-ci-yml").RulesNeeds;
+    }[];
+  };
+  "\u26A0\uFE0F force create release": {
+    stage: string;
+    image: string;
+    script: string[];
+    after_script: string[];
+    needs: any[];
+    rules: {
+      if?: string;
+      changes?: import("../../types/gitlab-ci-yml").Changes;
+      exists?: import("../../types/gitlab-ci-yml").Exists;
+      variables?: import("../../types/gitlab-ci-yml").RulesVariables;
+      when?: import("../../types/gitlab-ci-yml").When;
+      start_in?: string;
+      allow_failure?: import("../../types/gitlab-ci-yml").AllowFailure;
+      needs?: import("../../types/gitlab-ci-yml").RulesNeeds;
+    }[];
+  };
+};

package/dist/pipeline/src/backends/gitlab/gitlabReleaseJobs.js

@@ -0,0 +1,43 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getGitlabReleaseJobs = void 0;
+const rules_1 = require("../../rules");
+const runner_1 = require("../../runner");
+const EXPIRED_TOKEN_HELP = "echo '👉 If this job failed with access denied, the project access token might be invald - run `project-renew-token` in catladder CLI to fix.'";
+const baseReleaseRules = [rules_1.RULE_NEVER_ON_RELEASE_COMMIT, rules_1.RULE_NEVER_ON_AGENT_TRIGGER, rules_1.RULE_NEVER_ON_SCHEDULE];
+const getGitlabReleaseJobs = config => {
+  var _a;
+  return {
+    ["create release"]: {
+      stage: "release",
+      image: (0, runner_1.getRunnerImage)("semantic-release"),
+      script: ["semanticRelease"],
+      after_script: [EXPIRED_TOKEN_HELP],
+      rules: [...baseReleaseRules, {
+        if: rules_1.RULE_CONDITION_MAIN_BRANCH,
+        when: ((_a = config.releases) === null || _a === void 0 ? void 0 : _a.when) === "auto" ? "on_success" : "manual"
+      }, {
+        if: rules_1.RULE_CONDITION_HOTFIX_BRANCH,
+        when: "manual"
+      }]
+    },
+    ["⚠️ force create release"]: {
+      stage: "release",
+      image: (0, runner_1.getRunnerImage)("semantic-release"),
+      script: ["semanticRelease"],
+      after_script: [EXPIRED_TOKEN_HELP],
+      needs: [],
+      rules: [...baseReleaseRules, {
+        if: rules_1.RULE_CONDITION_MAIN_BRANCH,
+        when: "manual"
+      }, {
+        if: rules_1.RULE_CONDITION_HOTFIX_BRANCH,
+        when: "manual"
+      }]
+    }
+  };
+};
+exports.getGitlabReleaseJobs = getGitlabReleaseJobs;

package/dist/pipeline/src/backends/gitlab/gitlabReleaseJobs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"gitlabReleaseJobs.js","sourceRoot":"","sources":["../../../../../../pipeline/src/backends/gitlab/gitlabReleaseJobs.ts"],"names":[],"mappings":";;;AAAA,uCAMqB;AACrB,yCAA8C;AAI9C,MAAM,kBAAkB,GACtB,gJAAgJ,CAAC;AAEnJ,MAAM,gBAAgB,GAAG;IACvB,oCAA4B;IAC5B,mCAA2B;IAC3B,8BAAsB;CACvB,CAAC;AACK,MAAM,oBAAoB,GAAG,CAAC,MAAc,EAAE,EAAE;;IACrD,OAAO;QACL,CAAC,gBAAgB,CAAC,EAAE;YAClB,KAAK,EAAE,SAAS;YAChB,KAAK,EAAE,IAAA,uBAAc,EAAC,kBAAkB,CAAC;YACzC,MAAM,EAAE,CAAC,iBAAiB,CAAC;YAC3B,YAAY,EAAE,CAAC,kBAAkB,CAAC;YAClC,KAAK,EAAE;gBACL,GAAG,gBAAgB;gBACnB;oBACE,EAAE,EAAE,kCAA0B;oBAC9B,IAAI,EAAE,CAAA,MAAA,MAAM,CAAC,QAAQ,0CAAE,IAAI,MAAK,MAAM,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,QAAQ;iBACjE;gBACD;oBACE,EAAE,EAAE,oCAA4B;oBAChC,IAAI,EAAE,QAAQ;iBACf;aACqB;SACzB;QACD,CAAC,yBAAyB,CAAC,EAAE;YAC3B,KAAK,EAAE,SAAS;YAChB,KAAK,EAAE,IAAA,uBAAc,EAAC,kBAAkB,CAAC;YACzC,MAAM,EAAE,CAAC,iBAAiB,CAAC;YAC3B,YAAY,EAAE,CAAC,kBAAkB,CAAC;YAClC,KAAK,EAAE,EAAE;YACT,KAAK,EAAE;gBACL,GAAG,gBAAgB;gBACnB;oBACE,EAAE,EAAE,kCAA0B;oBAC9B,IAAI,EAAE,QAAQ;iBACf;gBACD;oBACE,EAAE,EAAE,oCAA4B;oBAChC,IAAI,EAAE,QAAQ;iBACf;aACqB;SACzB;KACF,CAAC;AACJ,CAAC,CAAC;AAtCW,QAAA,oBAAoB,wBAsC/B"}

package/dist/pipeline/src/backends/gitlab/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./GitlabBackend";
+export * from "./gitlabReleaseJobs";

package/dist/pipeline/src/backends/gitlab/index.js

@@ -0,0 +1,26 @@
+"use strict";
+
+var __createBinding = this && this.__createBinding || (Object.create ? function (o, m, k, k2) {
+  if (k2 === undefined) k2 = k;
+  var desc = Object.getOwnPropertyDescriptor(m, k);
+  if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+    desc = {
+      enumerable: true,
+      get: function () {
+        return m[k];
+      }
+    };
+  }
+  Object.defineProperty(o, k2, desc);
+} : function (o, m, k, k2) {
+  if (k2 === undefined) k2 = k;
+  o[k2] = m[k];
+});
+var __exportStar = this && this.__exportStar || function (m, exports) {
+  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+__exportStar(require("./GitlabBackend"), exports);
+__exportStar(require("./gitlabReleaseJobs"), exports);

package/dist/pipeline/src/backends/gitlab/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../pipeline/src/backends/gitlab/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,kDAAgC;AAChC,sDAAoC"}

package/dist/pipeline/src/{pipeline → backends}/gitlab/sortGitLabJobDefProps.d.ts

@@ -4,4 +4,4 @@ import type { GitlabJobDef } from "../../types";
  *
  * This is only useful when generating a GitLab pipeline YAML file.
  */
-export declare const sortGitLabJobDefProps: (jobDef: GitlabJobDef) => GitlabJobDef;
+export declare const sortGitLabJobDefProps: (jobDef: GitlabJobDef) => GitlabJobDef;

package/dist/pipeline/src/backends/gitlab/sortGitLabJobDefProps.js

@@ -0,0 +1,20 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.sortGitLabJobDefProps = void 0;
+/**
+ * The desired order of GitLab job definition keys.
+ */
+const jobDefOrder = ["stage", "tags", "image", "services", "variables", "before_script", "script", "after_script", "cache", "coverage", "environment", "release", "artifacts", "rules", "only", "except", "needs", "dependencies", "trigger", "retry", "interruptible", "allow_failure", "parallel", "hooks", "resource_group"];
+const sortGitLabJobDefKeys = jobDef => Object.keys(jobDef).sort((a, b) => jobDefOrder.indexOf(a) === -1 && jobDefOrder.indexOf(b) === -1 ? 0 : jobDefOrder.indexOf(a) === -1 ? 1 : jobDefOrder.indexOf(b) === -1 ? -1 : jobDefOrder.indexOf(a) - jobDefOrder.indexOf(b));
+/**
+ * Sorts the properties of a GitLab job definition based on the desired order.
+ *
+ * This is only useful when generating a GitLab pipeline YAML file.
+ */
+const sortGitLabJobDefProps = jobDef => sortGitLabJobDefKeys(jobDef).reduce((acc, key) => jobDef[key] !== undefined ? Object.assign(acc, {
+  [key]: jobDef[key]
+}) : acc, {});
+exports.sortGitLabJobDefProps = sortGitLabJobDefProps;

package/dist/pipeline/src/{pipeline → backends}/gitlab/sortGitLabJobDefProps.js.map

@@ -1 +1 @@
-{"version":3,"file":"sortGitLabJobDefProps.js","sourceRoot":"","sources":["../../../../../../pipeline/src/pipeline/gitlab/sortGitLabJobDefProps.ts"],"names":[],"mappings":";;;AAIA;;GAEG;AACH,MAAM,WAAW,GAAsB;IACrC,OAAO;IACP,MAAM;IACN,OAAO;IACP,UAAU;IACV,WAAW;IACX,eAAe;IACf,QAAQ;IACR,cAAc;IACd,OAAO;IACP,UAAU;IACV,aAAa;IACb,SAAS;IACT,WAAW;IACX,OAAO;IACP,MAAM;IACN,QAAQ;IACR,OAAO;IACP,cAAc;IACd,SAAS;IACT,OAAO;IACP,eAAe;IACf,eAAe;IACf,UAAU;IACV,OAAO;IACP,gBAAgB;CACjB,CAAC;AAEF,MAAM,oBAAoB,GAAG,CAAC,MAAoB,EAAqB,EAAE,CACtE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAuB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CACvD,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;IAC5D,CAAC,CAAC,CAAC;IACH,CAAC,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QAC7B,CAAC,CAAC,CAAC;QACH,CAAC,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;YAC7B,CAAC,CAAC,CAAC,CAAC;YACJ,CAAC,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,CACxD,CAAC;AAEJ;;;;GAIG;AACI,MAAM,qBAAqB,GAAG,CAAC,MAAoB,EAAgB,EAAE,CAC1E,oBAAoB,CAAC,MAAM,CAAC,CAAC,MAAM,CACjC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CACX,MAAM,CAAC,GAAG,CAAC,KAAK,SAAS;IACvB,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;IAC5C,CAAC,CAAC,GAAG,EACT,EAAkB,CACnB,CAAC;AAPS,QAAA,qBAAqB,yBAO9B"}
+{"version":3,"file":"sortGitLabJobDefProps.js","sourceRoot":"","sources":["../../../../../../pipeline/src/backends/gitlab/sortGitLabJobDefProps.ts"],"names":[],"mappings":";;;AAIA;;GAEG;AACH,MAAM,WAAW,GAAsB;IACrC,OAAO;IACP,MAAM;IACN,OAAO;IACP,UAAU;IACV,WAAW;IACX,eAAe;IACf,QAAQ;IACR,cAAc;IACd,OAAO;IACP,UAAU;IACV,aAAa;IACb,SAAS;IACT,WAAW;IACX,OAAO;IACP,MAAM;IACN,QAAQ;IACR,OAAO;IACP,cAAc;IACd,SAAS;IACT,OAAO;IACP,eAAe;IACf,eAAe;IACf,UAAU;IACV,OAAO;IACP,gBAAgB;CACjB,CAAC;AAEF,MAAM,oBAAoB,GAAG,CAAC,MAAoB,EAAqB,EAAE,CACtE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAuB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CACvD,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;IAC5D,CAAC,CAAC,CAAC;IACH,CAAC,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QAC7B,CAAC,CAAC,CAAC;QACH,CAAC,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;YAC7B,CAAC,CAAC,CAAC,CAAC;YACJ,CAAC,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,CACxD,CAAC;AAEJ;;;;GAIG;AACI,MAAM,qBAAqB,GAAG,CAAC,MAAoB,EAAgB,EAAE,CAC1E,oBAAoB,CAAC,MAAM,CAAC,CAAC,MAAM,CACjC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CACX,MAAM,CAAC,GAAG,CAAC,KAAK,SAAS;IACvB,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;IAC5C,CAAC,CAAC,GAAG,EACT,EAAkB,CACnB,CAAC;AAPS,QAAA,qBAAqB,yBAO9B"}

package/dist/pipeline/src/backends/index.d.ts

@@ -0,0 +1,5 @@
+import type { PipelineType } from "../types";
+import type { PipelineBackend } from "./types";
+export * from "./types";
+export * from "./gitlab";
+export declare const getPipelineBackend: (type: PipelineType) => PipelineBackend;

package/dist/pipeline/src/backends/index.js

@@ -0,0 +1,39 @@
+"use strict";
+
+var __createBinding = this && this.__createBinding || (Object.create ? function (o, m, k, k2) {
+  if (k2 === undefined) k2 = k;
+  var desc = Object.getOwnPropertyDescriptor(m, k);
+  if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+    desc = {
+      enumerable: true,
+      get: function () {
+        return m[k];
+      }
+    };
+  }
+  Object.defineProperty(o, k2, desc);
+} : function (o, m, k, k2) {
+  if (k2 === undefined) k2 = k;
+  o[k2] = m[k];
+});
+var __exportStar = this && this.__exportStar || function (m, exports) {
+  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getPipelineBackend = void 0;
+const gitlab_1 = require("./gitlab");
+__exportStar(require("./types"), exports);
+__exportStar(require("./gitlab"), exports);
+const BACKENDS = {
+  gitlab: () => new gitlab_1.GitlabBackend()
+};
+const getPipelineBackend = type => {
+  const createBackend = BACKENDS[type];
+  if (!createBackend) {
+    throw new Error(`Pipeline type not supported: ${type}`);
+  }
+  return createBackend();
+};
+exports.getPipelineBackend = getPipelineBackend;

package/dist/pipeline/src/backends/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../pipeline/src/backends/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AACA,qCAAyC;AAGzC,0CAAwB;AACxB,2CAAyB;AAEzB,MAAM,QAAQ,GAAmD;IAC/D,MAAM,EAAE,GAAG,EAAE,CAAC,IAAI,sBAAa,EAAE;CAClC,CAAC;AAEK,MAAM,kBAAkB,GAAG,CAAC,IAAkB,EAAmB,EAAE;IACxE,MAAM,aAAa,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;IACrC,IAAI,CAAC,aAAa,EAAE,CAAC;QACnB,MAAM,IAAI,KAAK,CAAC,gCAAgC,IAAI,EAAE,CAAC,CAAC;IAC1D,CAAC;IACD,OAAO,aAAa,EAAE,CAAC;AACzB,CAAC,CAAC;AANW,QAAA,kBAAkB,sBAM7B"}

package/dist/pipeline/src/backends/types.d.ts

@@ -0,0 +1,30 @@
+import type { Config, PipelineType } from "../types";
+export type PipelineFile = {
+  path: string;
+  content: Record<string, unknown>;
+};
+/**
+ * A pipeline backend renders catladder jobs into the files of a concrete
+ * CI system (gitlab today, github actions in the future).
+ *
+ * Everything that is specific to a CI system (job yaml shapes, rules,
+ * stages, file layout, includes, ...) belongs behind this interface.
+ * The rest of the codebase should only produce platform-neutral jobs.
+ *
+ * Multiple backends can be active for the same repository (e.g. during a
+ * step-by-step migration from gitlab to github): each backend owns its
+ * `generatedFolder` and generates its own set of files.
+ */
+export interface PipelineBackend {
+  readonly type: PipelineType;
+  /**
+   * the folder where the generated files are placed.
+   * It is cleaned before the files are written.
+   */
+  readonly generatedFolder: string;
+  /**
+   * create all pipeline files for this backend.
+   * Paths are relative to the repository root.
+   */
+  createFiles(config: Config): Promise<PipelineFile[]>;
+}

package/dist/pipeline/src/backends/types.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/dist/pipeline/src/backends/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../../pipeline/src/backends/types.ts"],"names":[],"mappings":""}

package/dist/pipeline/src/bash/BashExpression.d.ts

@@ -4,23 +4,23 @@
  * you can do basic transforms like lowercase, but that does not return you a lowercase string, but instead an experssion represeting a lowercase string
  */
 export declare class BashExpression {
-    private value;
-    constructor(value: string | BashExpression);
-    toJSON(): string;
-    toString(): string;
-    replace(searchValue: any, replacer: (substring: string, ...args: any[]) => string): BashExpression;
-    /**
-     *
-     * @returns a bash expression to lowercase the string
-     */
-    toLowerCase(): BashExpression;
-    /**
-     * concats a value to this one and returns a new BashExpression
-     * @param value
-     * @returns
-     */
-    concat(...values: Array<string | BashExpression>): BashExpression;
-    transformWithCommand(command: string): BashExpression;
+  private value;
+  constructor(value: string | BashExpression);
+  toJSON(): string;
+  toString(): string;
+  replace(searchValue: any, replacer: (substring: string, ...args: any[]) => string): BashExpression;
+  /**
+   *
+   * @returns a bash expression to lowercase the string
+   */
+  toLowerCase(): BashExpression;
+  /**
+   * concats a value to this one and returns a new BashExpression
+   * @param value
+   * @returns
+   */
+  concat(...values: Array<string | BashExpression>): BashExpression;
+  transformWithCommand(command: string): BashExpression;
 }
 export type StringOrBashExpression = string | BashExpression;
 export declare const getBashVariable: (name: string) => BashExpression;
@@ -33,4 +33,4 @@ export declare const getBashVariable: (name: string) => BashExpression;
  * @param joiner
  * @returns
  */
-export declare const joinBashExpressions: (parts: Array<StringOrBashExpression>, joiner?: string) => StringOrBashExpression;
+export declare const joinBashExpressions: (parts: Array<StringOrBashExpression>, joiner?: string) => StringOrBashExpression;

package/dist/pipeline/src/bash/BashExpression.js

@@ -1,5 +1,8 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
 exports.joinBashExpressions = exports.getBashVariable = exports.BashExpression = void 0;
 /**
  * this class represents a string that can be evaluated in bash scripts.
@@ -7,41 +10,41 @@ exports.joinBashExpressions = exports.getBashVariable = exports.BashExpression =
  * you can do basic transforms like lowercase, but that does not return you a lowercase string, but instead an experssion represeting a lowercase string
  */
 class BashExpression {
-    constructor(value) {
-        this.value = value;
-    }
-    toJSON() {
-        return this.toString();
-    }
-    toString() {
-        return this.value.toString();
-    }
-    replace(searchValue, replacer) {
-        return new BashExpression(this.value.toString().replace(searchValue, replacer));
-    }
-    /**
-     *
-     * @returns a bash expression to lowercase the string
-     */
-    toLowerCase() {
-        return this.transformWithCommand("awk '{print tolower($0)}'");
-    }
-    /**
-     * concats a value to this one and returns a new BashExpression
-     * @param value
-     * @returns
-     */
-    concat(...values) {
-        return new BashExpression(this.toString().concat(...values.map((v) => v.toString())));
-    }
-    transformWithCommand(command) {
-        return new BashExpression(
-        // see https://stackoverflow.com/a/2264537
-        `$(printf %s "${this.toString()}" | ${command})`);
-    }
+  constructor(value) {
+    this.value = value;
+  }
+  toJSON() {
+    return this.toString();
+  }
+  toString() {
+    return this.value.toString();
+  }
+  replace(searchValue, replacer) {
+    return new BashExpression(this.value.toString().replace(searchValue, replacer));
+  }
+  /**
+   *
+   * @returns a bash expression to lowercase the string
+   */
+  toLowerCase() {
+    return this.transformWithCommand("awk '{print tolower($0)}'");
+  }
+  /**
+   * concats a value to this one and returns a new BashExpression
+   * @param value
+   * @returns
+   */
+  concat(...values) {
+    return new BashExpression(this.toString().concat(...values.map(v => v.toString())));
+  }
+  transformWithCommand(command) {
+    return new BashExpression(
+    // see https://stackoverflow.com/a/2264537
+    `$(printf %s "${this.toString()}" | ${command})`);
+  }
 }
 exports.BashExpression = BashExpression;
-const getBashVariable = (name) => new BashExpression(`$${name}`);
+const getBashVariable = name => new BashExpression(`$${name}`);
 exports.getBashVariable = getBashVariable;
 /**
  * joins bash expressions together with a joiner
@@ -53,15 +56,11 @@ exports.getBashVariable = getBashVariable;
  * @returns
  */
 const joinBashExpressions = (parts, joiner = "") => {
-    const anyIsBashExpression = parts.some((p) => p instanceof BashExpression);
-    if (anyIsBashExpression) {
-        return new BashExpression(parts
-            .map((p) => (p instanceof BashExpression ? p.toString() : p))
-            .join(joiner));
-    }
-    else {
-        return parts.join(joiner);
-    }
+  const anyIsBashExpression = parts.some(p => p instanceof BashExpression);
+  if (anyIsBashExpression) {
+    return new BashExpression(parts.map(p => p instanceof BashExpression ? p.toString() : p).join(joiner));
+  } else {
+    return parts.join(joiner);
+  }
 };
-exports.joinBashExpressions = joinBashExpressions;
-//# sourceMappingURL=BashExpression.js.map
+exports.joinBashExpressions = joinBashExpressions;

package/dist/pipeline/src/bash/bashEscape.d.ts

@@ -2,17 +2,24 @@ import type { VariableValue } from "../variables/VariableValue";
 import { BashExpression } from "./BashExpression";
 export type QuotesEscapeMode = "single" | "double";
 export type EscapeOptions = {
-    quotes?: QuotesEscapeMode | false;
+  quotes?: QuotesEscapeMode | false;
 };
 /**
  * escapes a string or bash expression for bash
  * it either can escape single or double quotes (double is default)
  */
 export declare const bashEscape: (value: VariableValue | any, options?: EscapeOptions) => string | BashExpression;
-export declare const escapeString: (value: string | null | undefined, { quotes }?: EscapeOptions) => string;
+export declare const escapeString: (value: string | null | undefined, {
+  quotes
+}?: EscapeOptions) => string;
 export declare const escapeBashExpression: (value: BashExpression, options: EscapeOptions) => BashExpression;
 export declare const escapeDoubleQuotes: (value: string | null | undefined) => string;
 export declare const escapeSingleQuotes: (value: string | null | undefined) => string;
+export declare const escapeBackTicks: (value: string | null | undefined) => string;
+export declare const escapeNewlines: (value: string | null | undefined) => string;
+export type EscapeForDotEnvOptions = {
+  quoteMode: "auto" | "always";
+};
 /**
  *
  * escape env vars for .env files.
@@ -29,4 +36,4 @@ export declare const escapeSingleQuotes: (value: string | null | undefined) => s
  *
  * - other languages are currently only partially supported, since most .env implementations are slightly different
  */
-export declare const escapeForDotEnv: (value: VariableValue | undefined | null) => string;
+export declare const escapeForDotEnv: (value: VariableValue | undefined | null, options?: EscapeForDotEnvOptions) => string;

package/dist/pipeline/src/bash/bashEscape.js

@@ -1,6 +1,9 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.escapeForDotEnv = exports.escapeSingleQuotes = exports.escapeDoubleQuotes = exports.escapeBashExpression = exports.escapeString = exports.bashEscape = void 0;
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.escapeForDotEnv = exports.escapeNewlines = exports.escapeBackTicks = exports.escapeSingleQuotes = exports.escapeDoubleQuotes = exports.escapeBashExpression = exports.escapeString = exports.bashEscape = void 0;
 const globalScriptFunctions_1 = require("../globalScriptFunctions");
 const VariableValueContainingReferences_1 = require("../variables/VariableValueContainingReferences");
 const BashExpression_1 = require("./BashExpression");
@@ -9,38 +12,40 @@ const BashExpression_1 = require("./BashExpression");
  * it either can escape single or double quotes (double is default)
  */
 const bashEscape = (value, options = {
-    quotes: "double",
+  quotes: "double"
 }) => {
-    if (value instanceof BashExpression_1.BashExpression) {
-        // no need to escape
-        return (0, exports.escapeBashExpression)(value, options);
-    }
-    if (value instanceof VariableValueContainingReferences_1.VariableValueContainingReferences) {
-        return value.toString(options);
-    }
-    return (0, exports.escapeString)(value, options);
+  if (value instanceof BashExpression_1.BashExpression) {
+    // no need to escape
+    return (0, exports.escapeBashExpression)(value, options);
+  }
+  if (value instanceof VariableValueContainingReferences_1.VariableValueContainingReferences) {
+    return value.toString(options);
+  }
+  return (0, exports.escapeString)(value, options);
 };
 exports.bashEscape = bashEscape;
-const escapeString = (value, { quotes } = {
-    quotes: "double",
+const escapeString = (value, {
+  quotes
+} = {
+  quotes: "double"
 }) => {
-    const quoteEscaped = quotes
-        ? quotes === "single"
-            ? (0, exports.escapeSingleQuotes)(value)
-            : (0, exports.escapeDoubleQuotes)(value)
-        : value;
-    return quoteEscaped;
+  const quoteEscaped = quotes ? quotes === "single" ? (0, exports.escapeSingleQuotes)(value) : (0, exports.escapeDoubleQuotes)(value) : value;
+  return quoteEscaped;
 };
 exports.escapeString = escapeString;
 const escapeBashExpression = (value, options) => {
-    // no need to escape, we just return the string
-    return value;
+  // no need to escape, we just return the string
+  return value;
 };
 exports.escapeBashExpression = escapeBashExpression;
-const escapeDoubleQuotes = (value) => value === null || value === void 0 ? void 0 : value.toString().replace(/"/g, '\\"');
+const escapeDoubleQuotes = value => value === null || value === void 0 ? void 0 : value.toString().replace(/"/g, '\\"');
 exports.escapeDoubleQuotes = escapeDoubleQuotes;
-const escapeSingleQuotes = (value) => value === null || value === void 0 ? void 0 : value.toString().replace(/'/g, "\\'");
+const escapeSingleQuotes = value => value === null || value === void 0 ? void 0 : value.toString().replace(/'/g, "\\'");
 exports.escapeSingleQuotes = escapeSingleQuotes;
+const escapeBackTicks = value => value === null || value === void 0 ? void 0 : value.toString().replace(/`/g, "\\`");
+exports.escapeBackTicks = escapeBackTicks;
+const escapeNewlines = value => value === null || value === void 0 ? void 0 : value.toString().replace(/\n/g, "\\n");
+exports.escapeNewlines = escapeNewlines;
 /**
  *
  * escape env vars for .env files.
@@ -57,53 +62,45 @@ exports.escapeSingleQuotes = escapeSingleQuotes;
  *
  * - other languages are currently only partially supported, since most .env implementations are slightly different
  */
-const escapeForDotEnv = (value) => {
-    if (value === undefined || value === null) {
-        return "";
-    }
-    if (typeof value === "string") {
-        // if string contains newlines, we need to wrap it in quotes
-        // we additionaly escape newlines, that give best compatibility
-        if (value.includes("\n")) {
-            const newlinesReplaces = value.replace(/\n/g, "\\n");
-            // default to ", but if this is not possible, we try to use ' or `
-            const quote = value.includes(`"`)
-                ? value.includes(`'`)
-                    ? value.includes("`")
-                        ? // If all quote types are present, default to double quotes. This works in dotenv, but not in node.js because of the bug mentioned abouve
-                            '"'
-                        : "`"
-                    : "'"
-                : '"';
-            // if we found a quote, we can wrap the string in it
-            return `${quote}${newlinesReplaces}${quote}`;
-        }
-        else {
-            // otherwise we can return as is
-            return value;
-        }
-    }
-    else if (value instanceof BashExpression_1.BashExpression) {
-        return escapeBashExpressionForDotEnv(value);
-    }
-    else if (value instanceof VariableValueContainingReferences_1.VariableValueContainingReferences) {
-        // instead of doing it part-wise, we just do it all at once
-        const containsAnyBashExpression = value.parts.some((part) => part instanceof BashExpression_1.BashExpression);
-        if (!containsAnyBashExpression) {
-            return (0, exports.escapeForDotEnv)(value.toString({
-                quotes: "double",
-            }));
-        }
-        else {
-            const result = escapeBashExpressionForDotEnv(new BashExpression_1.BashExpression(value.toString({
-                quotes: "double",
-            })));
-            return result;
-        }
+const escapeForDotEnv = (value, options = {
+  quoteMode: "auto"
+}) => {
+  if (value === undefined || value === null) {
+    return "";
+  }
+  if (typeof value === "string") {
+    // if string contains newlines, we need to wrap it in quotes
+    // we additionaly escape newlines, that give best compatibility
+    if (options.quoteMode === "always" || value.includes("\n")) {
+      const newlinesReplaces = value.replace(/\n/g, "\\n");
+      // default to ", but if this is not possible, we try to use ' or `
+      const quote = value.includes(`"`) ? value.includes(`'`) ? value.includes("`") ?
+      // If all quote types are present, default to double quotes. This works in dotenv, but not in node.js because of the bug mentioned abouve
+      '"' : "`" : "'" : '"';
+      // if we found a quote, we can wrap the string in it
+      return `${quote}${newlinesReplaces}${quote}`;
+    } else {
+      // otherwise we can return as is
+      return value;
     }
-    else {
-        return value;
+  } else if (value instanceof BashExpression_1.BashExpression) {
+    return escapeBashExpressionForDotEnv(value);
+  } else if (value instanceof VariableValueContainingReferences_1.VariableValueContainingReferences) {
+    // instead of doing it part-wise, we just do it all at once
+    const containsAnyBashExpression = value.parts.some(part => part instanceof BashExpression_1.BashExpression);
+    if (!containsAnyBashExpression) {
+      return (0, exports.escapeForDotEnv)(value.toString({
+        quotes: "double"
+      }));
+    } else {
+      const result = escapeBashExpressionForDotEnv(new BashExpression_1.BashExpression(value.toString({
+        quotes: "double"
+      })));
+      return result;
     }
+  } else {
+    return value;
+  }
 };
 exports.escapeForDotEnv = escapeForDotEnv;
 // basically the same thing as above for bash
@@ -125,7 +122,6 @@ const escapeForDotEnvScript = (0, globalScriptFunctions_1.registerGlobalScriptFu
     printf "%s\\n" "$input"
   fi
   `);
-const escapeBashExpressionForDotEnv = (value) => {
-    return value.transformWithCommand(escapeForDotEnvScript.name).toString();
-};
-//# sourceMappingURL=bashEscape.js.map
+const escapeBashExpressionForDotEnv = value => {
+  return value.transformWithCommand(escapeForDotEnvScript.name).toString();
+};