@gearbox-protocol/cli-utils 5.33.0-next.2

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from "./resolveYamlFiles.js";

package/dist/index.js

@@ -0,0 +1 @@
+export * from "./resolveYamlFiles.js";

package/dist/resolveYamlFiles.d.ts

@@ -0,0 +1,23 @@
+import YAML from "yaml";
+/**
+ * Merges yaml files, respecting .extends references.
+ * Performs env variable substitution on the config.
+ * Respects YAML anchors and aliases, and merge keys - so that they can be shared across two files
+ *
+ * x-* anchors are removed from resulting document (a-la docker compose yaml)
+ *
+ * @param file
+ * @param templateData
+ * @returns
+ */
+export declare function resolveYamlFiles(file: string, templateData?: Record<string, string>): Promise<object>;
+/**
+ * Merges yaml documents, respecting .extends references.
+ * Optionally, performs env-style variable substitution on the config.
+ * Respects YAML anchors and aliases, and merge keys - so that they can be shared across two files
+ *
+ * @param file
+ * @param templateData
+ * @returns
+ */
+export declare function resolveYamlDoc(file: string, templateData?: Record<string, string>): Promise<YAML.Document>;

package/dist/resolveYamlFiles.js

@@ -0,0 +1,67 @@
+import { readFile } from "node:fs/promises";
+import { dirname, resolve as pathResolve } from "node:path";
+import { template } from "lodash-es";
+import YAML, { isPair, isScalar, isSeq } from "yaml";
+/**
+ * Merges yaml files, respecting .extends references.
+ * Performs env variable substitution on the config.
+ * Respects YAML anchors and aliases, and merge keys - so that they can be shared across two files
+ *
+ * x-* anchors are removed from resulting document (a-la docker compose yaml)
+ *
+ * @param file
+ * @param templateData
+ * @returns
+ */
+export async function resolveYamlFiles(file, templateData) {
+    const doc = await resolveYamlDoc(file, templateData);
+    const obj = doc.toJSON();
+    return Object.fromEntries(Object.entries(obj).filter(([k]) => !k.startsWith("x-")));
+}
+/**
+ * Merges yaml documents, respecting .extends references.
+ * Optionally, performs env-style variable substitution on the config.
+ * Respects YAML anchors and aliases, and merge keys - so that they can be shared across two files
+ *
+ * @param file
+ * @param templateData
+ * @returns
+ */
+export async function resolveYamlDoc(file, templateData) {
+    let content = await readFile(file, "utf-8");
+    if (templateData) {
+        const compiled = template(content);
+        content = compiled(templateData);
+    }
+    let cfgRaw = YAML.parseDocument(content, { merge: true });
+    // let cfgRaw = YAML.parse(content, { merge: true });
+    if (cfgRaw.has("extends")) {
+        const baseFile = cfgRaw.get("extends");
+        const extended = cfgRaw;
+        // extends is a relative path to the base file
+        cfgRaw = await resolveYamlDoc(pathResolve(dirname(file), baseFile), templateData);
+        YAML.visit(extended, {
+            Pair(_, pair, rawPath) {
+                const path = getNodesPath(rawPath);
+                if (isScalar(pair.key) && (isScalar(pair.value) || isSeq(pair.value))) {
+                    if (pair.key.value === "extends") {
+                        return;
+                    }
+                    cfgRaw.setIn([...path, pair.key.value], pair.value);
+                    return YAML.visit.SKIP;
+                }
+            },
+        });
+    }
+    return cfgRaw;
+}
+function getNodesPath(nodes) {
+    return nodes
+        .map(n => {
+        if (isPair(n) && isScalar(n.key)) {
+            return n.key.value;
+        }
+        return "";
+    })
+        .filter(Boolean);
+}

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@gearbox-protocol/cli-utils",
+  "description": "Utils for creating cli apps",
+  "version": "5.33.0-next.2",
+  "homepage": "https://gearbox.fi",
+  "keywords": [
+    "gearbox"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Gearbox-protocol/deploy-tools"
+  },
+  "type": "module",
+  "exports": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "license": "BUSL-1.1",
+  "scripts": {
+    "clean": "rm -rf ./dist",
+    "build": "tsc --p tsconfig.build.json",
+    "dev": "tsc --p tsconfig.build.json --watch",
+    "prettier": "prettier --write .",
+    "prettier:ci": "npx prettier --check .",
+    "lint": "eslint \"**/*.ts\" --fix",
+    "lint:ci": "eslint \"**/*.ts\"",
+    "typecheck:ci": "tsc --noEmit",
+    "test": "vitest",
+    "package:version": "yarn version"
+  },
+  "dependencies": {
+    "lodash-es": "^4.17.21",
+    "yaml": "^2.8.0",
+    "zod": "^3.25.42"
+  },
+  "devDependencies": {
+    "@types/lodash-es": "^4.17.12",
+    "@types/node": "^22.15.21"
+  },
+  "prettier": "@gearbox-protocol/prettier-config"
+}