@catladder/cli 0.0.0-main-4d1a3af5 → 0.0.0-main-0b5c90c3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (36) hide show
  1. package/dist/bundles/catenv/index.js +82 -49
  2. package/dist/bundles/cli/index.js +65 -31
  3. package/dist/cli/src/apps/catenv/catenv.js +5 -4
  4. package/dist/cli/src/apps/catenv/catenv.js.map +1 -1
  5. package/dist/cli/src/apps/catenv/printVariables.d.ts +2 -2
  6. package/dist/cli/src/apps/catenv/printVariables.js +2 -2
  7. package/dist/cli/src/apps/catenv/printVariables.js.map +1 -1
  8. package/dist/cli/src/apps/catenv/writeDotEnvFiles.d.ts +2 -2
  9. package/dist/cli/src/apps/catenv/writeDotEnvFiles.js +5 -6
  10. package/dist/cli/src/apps/catenv/writeDotEnvFiles.js.map +1 -1
  11. package/dist/cli/src/apps/catenv/writeEnvDTs.d.ts +2 -2
  12. package/dist/cli/src/apps/catenv/writeEnvDTs.js +5 -6
  13. package/dist/cli/src/apps/catenv/writeEnvDTs.js.map +1 -1
  14. package/dist/pipeline/src/catenv/index.d.ts +7 -0
  15. package/dist/pipeline/src/catenv/index.js +12 -0
  16. package/dist/pipeline/src/catenv/index.js.map +1 -0
  17. package/dist/pipeline/src/index.d.ts +1 -0
  18. package/dist/pipeline/src/index.js +1 -0
  19. package/dist/pipeline/src/index.js.map +1 -1
  20. package/dist/pipeline/src/pipeline/generatePipelineFiles.d.ts +2 -1
  21. package/dist/pipeline/src/pipeline/generatePipelineFiles.js +3 -4
  22. package/dist/pipeline/src/pipeline/generatePipelineFiles.js.map +1 -1
  23. package/dist/pipeline/src/types/config.d.ts +5 -0
  24. package/dist/pipeline/src/types/config.js.map +1 -1
  25. package/dist/pipeline/src/types/hooks.d.ts +26 -0
  26. package/dist/pipeline/src/types/hooks.js +3 -0
  27. package/dist/pipeline/src/types/hooks.js.map +1 -0
  28. package/dist/pipeline/src/utils/writeFiles.d.ts +12 -4
  29. package/dist/pipeline/src/utils/writeFiles.js +42 -27
  30. package/dist/pipeline/src/utils/writeFiles.js.map +1 -1
  31. package/dist/tsconfig.tsbuildinfo +1 -1
  32. package/package.json +1 -1
  33. package/src/apps/catenv/catenv.ts +11 -5
  34. package/src/apps/catenv/printVariables.ts +6 -3
  35. package/src/apps/catenv/writeDotEnvFiles.ts +21 -8
  36. package/src/apps/catenv/writeEnvDTs.ts +15 -6
@@ -5,6 +5,7 @@ import type { ComponentContext } from "./context";
5
5
  import type { PartialDeep } from "./utils";
6
6
  import type { PipelineType, WorkspaceBuildConfig } from "..";
7
7
  import type { AgentConfig } from "./agent";
8
+ import type { Hooks } from "./hooks";
8
9
  export declare const ALL_PIPELINE_TRIGGERS: readonly ["mainBranch", "mr", "taggedRelease"];
9
10
  export type PipelineTrigger = (typeof ALL_PIPELINE_TRIGGERS)[number];
10
11
  /**
@@ -183,5 +184,9 @@ export type Config<C extends ConfigProps = never> = {
183
184
  * additional vars only for the runner in all jobs.
184
185
  */
185
186
  runnerVariables?: Record<string, string>;
187
+ /**
188
+ * hook into catladder generation
189
+ */
190
+ hooks?: Hooks;
186
191
  };
187
192
  export {};
@@ -1 +1 @@
1
- {"version":3,"file":"config.js","sourceRoot":"","sources":["../../../../../pipeline/src/types/config.ts"],"names":[],"mappings":";;;AASa,QAAA,qBAAqB,GAAG;IACnC,YAAY;IACZ,IAAI;IACJ,eAAe;CACP,CAAC;AAGX;;;GAGG;AACU,QAAA,SAAS,GAAG;IACvB,GAAG,EAAE;QACH,QAAQ,EAAE,CAAC,YAAY,CAAC;KACzB;IACD,MAAM,EAAE;QACN,QAAQ,EAAE,CAAC,IAAI,CAAC;KACjB;IACD,KAAK,EAAE;QACL,QAAQ,EAAE,CAAC,eAAe,CAAC;KAC5B;IACD,IAAI,EAAE;QACJ,QAAQ,EAAE,CAAC,eAAe,CAAC;KAC5B;IACD,KAAK,EAAE;QACL,QAAQ,EAAE,EAAE;KACb;CACO,CAAC;AAEX;;;;GAIG;AACI,MAAM,oBAAoB,GAAG,CAAC,OAAwB,EAAE,EAAE,CAC/D,MAAM,CAAC,OAAO,CAAC,iBAAS,CAAC;KACtB,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CACf,CAAC,CAAC,QAAuC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAC7D;KACA,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAY,CAAC,CAAC;AALnB,QAAA,oBAAoB,wBAKD;AAEnB,QAAA,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC,iBAAS,CAAC,CAAC;AACtC,QAAA,iBAAiB,GAAG,oBAAyB,CAAC;AAGpD,MAAM,aAAa,GAAG,CAAC,GAAW,EAAkB,EAAE;IAC3D,OAAO,GAAG,IAAI,iBAAS,CAAC;AAC1B,CAAC,CAAC;AAFW,QAAA,aAAa,iBAExB"}
1
+ {"version":3,"file":"config.js","sourceRoot":"","sources":["../../../../../pipeline/src/types/config.ts"],"names":[],"mappings":";;;AAUa,QAAA,qBAAqB,GAAG;IACnC,YAAY;IACZ,IAAI;IACJ,eAAe;CACP,CAAC;AAGX;;;GAGG;AACU,QAAA,SAAS,GAAG;IACvB,GAAG,EAAE;QACH,QAAQ,EAAE,CAAC,YAAY,CAAC;KACzB;IACD,MAAM,EAAE;QACN,QAAQ,EAAE,CAAC,IAAI,CAAC;KACjB;IACD,KAAK,EAAE;QACL,QAAQ,EAAE,CAAC,eAAe,CAAC;KAC5B;IACD,IAAI,EAAE;QACJ,QAAQ,EAAE,CAAC,eAAe,CAAC;KAC5B;IACD,KAAK,EAAE;QACL,QAAQ,EAAE,EAAE;KACb;CACO,CAAC;AAEX;;;;GAIG;AACI,MAAM,oBAAoB,GAAG,CAAC,OAAwB,EAAE,EAAE,CAC/D,MAAM,CAAC,OAAO,CAAC,iBAAS,CAAC;KACtB,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CACf,CAAC,CAAC,QAAuC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAC7D;KACA,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAY,CAAC,CAAC;AALnB,QAAA,oBAAoB,wBAKD;AAEnB,QAAA,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC,iBAAS,CAAC,CAAC;AACtC,QAAA,iBAAiB,GAAG,oBAAyB,CAAC;AAGpD,MAAM,aAAa,GAAG,CAAC,GAAW,EAAkB,EAAE;IAC3D,OAAO,GAAG,IAAI,iBAAS,CAAC;AAC1B,CAAC,CAAC;AAFW,QAAA,aAAa,iBAExB"}
@@ -0,0 +1,26 @@
1
+ export type FileHookContext = {
2
+ /**
3
+ * the filename of the file
4
+ */
5
+ filename: string;
6
+ /**
7
+ * the extension of the file
8
+ */
9
+ extension: string;
10
+ /**
11
+ * the path of the file
12
+ */
13
+ path: string;
14
+ /**
15
+ * the content of the file
16
+ */
17
+ content: string;
18
+ };
19
+ type MaybePromise<T> = T | Promise<T>;
20
+ export type Hooks = {
21
+ /**
22
+ * transform the file before it is written. If undefined is returned, the file is not modified
23
+ */
24
+ transformFileBeforeWrite: (fileHookContext: FileHookContext) => MaybePromise<string | undefined>;
25
+ };
26
+ export {};
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=hooks.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"hooks.js","sourceRoot":"","sources":["../../../../../pipeline/src/types/hooks.ts"],"names":[],"mappings":""}
@@ -1,9 +1,17 @@
1
1
  import { stringify } from "yaml";
2
- export declare const getAutoGeneratedHeader: (commentChar: string) => string;
3
- export declare const writeGeneratedFile: (path: string, content: string, { commentChar, }: {
2
+ import type { Config } from "../types";
3
+ type WriteFileOptions = {
4
4
  commentChar: string;
5
- }) => Promise<void>;
5
+ };
6
6
  type StringifyOptions = Exclude<Parameters<typeof stringify>[2], null | undefined | string | number>;
7
7
  export declare const yamlStringifyOptions: StringifyOptions;
8
- export declare const writeYamlfile: (path: string, data: any) => Promise<void>;
8
+ export declare class FileWriter {
9
+ private readonly config;
10
+ static create(config: Config): FileWriter;
11
+ constructor(config: Config);
12
+ protected writeTheFile(path: string, content: string): Promise<void>;
13
+ writeGeneratedFile(path: string, content: string, options: WriteFileOptions): Promise<void>;
14
+ writeYamlfile(path: string, data: any): Promise<void>;
15
+ protected getAutoGeneratedHeader(commentChar: string): string;
16
+ }
9
17
  export {};
@@ -1,28 +1,8 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.writeYamlfile = exports.yamlStringifyOptions = exports.writeGeneratedFile = exports.getAutoGeneratedHeader = void 0;
3
+ exports.FileWriter = exports.yamlStringifyOptions = void 0;
4
4
  const promises_1 = require("fs/promises");
5
5
  const yaml_1 = require("yaml");
6
- const getAutoGeneratedHeader = (commentChar) => {
7
- return [
8
- "-------------------------------------------------",
9
- `🐱 🔨 This file is generated by catladder`,
10
- `🚨 Do not edit this file manually 🚨`,
11
- "-------------------------------------------------",
12
- ]
13
- .map((line) => `${commentChar} ${line}`)
14
- .join("\n")
15
- .concat("\n");
16
- };
17
- exports.getAutoGeneratedHeader = getAutoGeneratedHeader;
18
- const writeGeneratedFile = async (path, content, { commentChar, }) => {
19
- await (0, promises_1.writeFile)(path,
20
- // need to spread out the jobs, forgot why
21
- [(0, exports.getAutoGeneratedHeader)(commentChar), content].join("\n"), {
22
- encoding: "utf-8",
23
- });
24
- };
25
- exports.writeGeneratedFile = writeGeneratedFile;
26
6
  exports.yamlStringifyOptions = {
27
7
  // prevents colapsing long command statements into multiple lines
28
8
  lineWidth: 0,
@@ -31,10 +11,45 @@ exports.yamlStringifyOptions = {
31
11
  // Better readability when bash commands most often use double quotes
32
12
  singleQuote: true,
33
13
  };
34
- const writeYamlfile = async (path, data) => {
35
- await (0, exports.writeGeneratedFile)(path, (0, yaml_1.stringify)(data, exports.yamlStringifyOptions), {
36
- commentChar: "#",
37
- });
38
- };
39
- exports.writeYamlfile = writeYamlfile;
14
+ class FileWriter {
15
+ static create(config) {
16
+ return new FileWriter(config);
17
+ }
18
+ constructor(config) {
19
+ this.config = config;
20
+ this.config = config;
21
+ }
22
+ async writeTheFile(path, content) {
23
+ var _a, _b;
24
+ const transformedContent = await ((_a = this.config.hooks) === null || _a === void 0 ? void 0 : _a.transformFileBeforeWrite({
25
+ filename: path,
26
+ content,
27
+ extension: (_b = path.split(".").pop()) !== null && _b !== void 0 ? _b : "",
28
+ path,
29
+ }));
30
+ await (0, promises_1.writeFile)(path, transformedContent !== null && transformedContent !== void 0 ? transformedContent : content, {
31
+ encoding: "utf-8",
32
+ });
33
+ }
34
+ async writeGeneratedFile(path, content, options) {
35
+ await this.writeTheFile(path, [this.getAutoGeneratedHeader(options.commentChar), content].join("\n"));
36
+ }
37
+ writeYamlfile(path, data) {
38
+ return this.writeGeneratedFile(path, (0, yaml_1.stringify)(data, exports.yamlStringifyOptions), {
39
+ commentChar: "#",
40
+ });
41
+ }
42
+ getAutoGeneratedHeader(commentChar) {
43
+ return [
44
+ "-------------------------------------------------",
45
+ `🐱 🔨 This file is generated by catladder`,
46
+ `🚨 Do not edit this file manually 🚨`,
47
+ "-------------------------------------------------",
48
+ ]
49
+ .map((line) => `${commentChar} ${line}`)
50
+ .join("\n")
51
+ .concat("\n");
52
+ }
53
+ }
54
+ exports.FileWriter = FileWriter;
40
55
  //# sourceMappingURL=writeFiles.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"writeFiles.js","sourceRoot":"","sources":["../../../../../pipeline/src/utils/writeFiles.ts"],"names":[],"mappings":";;;AAAA,0CAAwC;AACxC,+BAAiC;AAE1B,MAAM,sBAAsB,GAAG,CAAC,WAAmB,EAAE,EAAE;IAC5D,OAAO;QACL,mDAAmD;QACnD,2CAA2C;QAC3C,sCAAsC;QACtC,mDAAmD;KACpD;SACE,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,WAAW,IAAI,IAAI,EAAE,CAAC;SACvC,IAAI,CAAC,IAAI,CAAC;SACV,MAAM,CAAC,IAAI,CAAC,CAAC;AAClB,CAAC,CAAC;AAVW,QAAA,sBAAsB,0BAUjC;AAEK,MAAM,kBAAkB,GAAG,KAAK,EACrC,IAAY,EACZ,OAAe,EACf,EACE,WAAW,GAGZ,EACD,EAAE;IACF,MAAM,IAAA,oBAAS,EACb,IAAI;IACJ,0CAA0C;IAC1C,CAAC,IAAA,8BAAsB,EAAC,WAAW,CAAC,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EACzD;QACE,QAAQ,EAAE,OAAO;KAClB,CACF,CAAC;AACJ,CAAC,CAAC;AAjBW,QAAA,kBAAkB,sBAiB7B;AAMW,QAAA,oBAAoB,GAAqB;IACpD,iEAAiE;IACjE,SAAS,EAAE,CAAC;IACZ,4DAA4D;IAC5D,kBAAkB,EAAE,IAAI;IACxB,qEAAqE;IACrE,WAAW,EAAE,IAAI;CAClB,CAAC;AAEK,MAAM,aAAa,GAAG,KAAK,EAAE,IAAY,EAAE,IAAS,EAAE,EAAE;IAC7D,MAAM,IAAA,0BAAkB,EAAC,IAAI,EAAE,IAAA,gBAAS,EAAC,IAAI,EAAE,4BAAoB,CAAC,EAAE;QACpE,WAAW,EAAE,GAAG;KACjB,CAAC,CAAC;AACL,CAAC,CAAC;AAJW,QAAA,aAAa,iBAIxB"}
1
+ {"version":3,"file":"writeFiles.js","sourceRoot":"","sources":["../../../../../pipeline/src/utils/writeFiles.ts"],"names":[],"mappings":";;;AAAA,0CAAwC;AACxC,+BAAiC;AAWpB,QAAA,oBAAoB,GAAqB;IACpD,iEAAiE;IACjE,SAAS,EAAE,CAAC;IACZ,4DAA4D;IAC5D,kBAAkB,EAAE,IAAI;IACxB,qEAAqE;IACrE,WAAW,EAAE,IAAI;CAClB,CAAC;AAEF,MAAa,UAAU;IACd,MAAM,CAAC,MAAM,CAAC,MAAc;QACjC,OAAO,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;IAChC,CAAC;IAED,YAA6B,MAAc;QAAd,WAAM,GAAN,MAAM,CAAQ;QACzC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAES,KAAK,CAAC,YAAY,CAAC,IAAY,EAAE,OAAe;;QACxD,MAAM,kBAAkB,GACtB,MAAM,CAAA,MAAA,IAAI,CAAC,MAAM,CAAC,KAAK,0CAAE,wBAAwB,CAAC;YAChD,QAAQ,EAAE,IAAI;YACd,OAAO;YACP,SAAS,EAAE,MAAA,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,mCAAI,EAAE;YACtC,IAAI;SACL,CAAC,CAAA,CAAC;QACL,MAAM,IAAA,oBAAS,EAAC,IAAI,EAAE,kBAAkB,aAAlB,kBAAkB,cAAlB,kBAAkB,GAAI,OAAO,EAAE;YACnD,QAAQ,EAAE,OAAO;SAClB,CAAC,CAAC;IACL,CAAC;IAEM,KAAK,CAAC,kBAAkB,CAC7B,IAAY,EACZ,OAAe,EACf,OAAyB;QAEzB,MAAM,IAAI,CAAC,YAAY,CACrB,IAAI,EACJ,CAAC,IAAI,CAAC,sBAAsB,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CACvE,CAAC;IACJ,CAAC;IAEM,aAAa,CAAC,IAAY,EAAE,IAAS;QAC1C,OAAO,IAAI,CAAC,kBAAkB,CAC5B,IAAI,EACJ,IAAA,gBAAS,EAAC,IAAI,EAAE,4BAAoB,CAAC,EACrC;YACE,WAAW,EAAE,GAAG;SACjB,CACF,CAAC;IACJ,CAAC;IAES,sBAAsB,CAAC,WAAmB;QAClD,OAAO;YACL,mDAAmD;YACnD,2CAA2C;YAC3C,sCAAsC;YACtC,mDAAmD;SACpD;aACE,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,WAAW,IAAI,IAAI,EAAE,CAAC;aACvC,IAAI,CAAC,IAAI,CAAC;aACV,MAAM,CAAC,IAAI,CAAC,CAAC;IAClB,CAAC;CACF;AAtDD,gCAsDC"}