Update catalog handling (#385)

Author: ecraig12345

.vscode/settings.json

@@ -15,5 +15,9 @@
     "*.json5": "jsonc",
     "api-extractor*.json": "jsonc"
   },
-  "typescript.tsdk": "node_modules/typescript/lib"
+  "typescript.tsdk": "node_modules/typescript/lib",
+  "jest.runMode": "on-demand",
+  "jest.jestCommandLine": "yarn test",
+  // For now, only support tests in workspace-tools package
+  "jest.rootPath": "packages/workspace-tools"
 }

change/change-240e8a99-5367-4f28-936c-84e07ca3c1fd.json

@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "type": "patch",
+      "comment": "Update handling of \"catalog:\" vs \"catalog:default\" and add catalogsToYaml utility",
+      "packageName": "workspace-tools",
+      "email": "[email protected]",
+      "dependentChangeType": "patch"
+    }
+  ]
+}

package.json

@@ -41,6 +41,7 @@
     "lage": "^2.6.2",
     "prettier": "^3.0.0",
     "tmp": "^0.2.1",
+    "ts-dedent": "^2.2.0",
     "ts-jest": "^29.1.0",
     "typedoc": "^0.25.2",
     "typescript": "~5.2.2"

packages/workspace-tools/etc/workspace-tools.api.md

@@ -37,6 +37,11 @@ export interface Catalogs {
     named?: NamedCatalogs;
 }
 
+// @public
+export function catalogsToYaml(catalogs: Catalogs, options?: {
+    indent?: number | string;
+}): string;
+
 // @public
 export function clearGitObservers(): void;
 

packages/workspace-tools/src/__tests__/workspaces/catalogs.test.ts

@@ -0,0 +1,98 @@
+import { describe, it, expect } from "@jest/globals";
+import { catalogsToYaml } from "../../workspaces/catalogsToYaml";
+import type { Catalogs } from "../../types/Catalogs";
+import dedent from "ts-dedent";
+
+describe("catalogsToYaml", () => {
+  it("returns empty string for empty catalogs", () => {
+    const catalogs: Catalogs = {};
+
+    const result = catalogsToYaml(catalogs);
+    expect(result).toBe("");
+  });
+
+  it("converts default catalog to yaml format", () => {
+    const catalogs: Catalogs = {
+      default: {
+        react: "^18.0.0",
+        typescript: "~5.0.0",
+      },
+    };
+
+    const result = catalogsToYaml(catalogs);
+    expect(result).toEqual(dedent`
+      catalog:
+        react: ^18.0.0
+        typescript: ~5.0.0`);
+  });
+
+  it("converts named catalogs to yaml format", () => {
+    const catalogs: Catalogs = {
+      named: {
+        react18: {
+          react: "^18.0.0",
+          "react-dom": "^18.0.0",
+        },
+        react17: {
+          react: "^17.0.0",
+          "react-dom": "^17.0.0",
+        },
+      },
+    };
+
+    const result = catalogsToYaml(catalogs);
+    expect(result).toEqual(dedent`
+      catalogs:
+        react18:
+          react: ^18.0.0
+          react-dom: ^18.0.0
+        react17:
+          react: ^17.0.0
+          react-dom: ^17.0.0`);
+  });
+
+  it("converts both default and named catalogs", () => {
+    const catalogs: Catalogs = {
+      default: {
+        typescript: "~5.0.0",
+      },
+      named: {
+        testing: {
+          jest: "^29.0.0",
+        },
+      },
+    };
+
+    const result = catalogsToYaml(catalogs);
+    expect(result).toEqual(dedent`
+      catalog:
+        typescript: ~5.0.0
+      catalogs:
+        testing:
+          jest: ^29.0.0`);
+  });
+
+  it("respects indent with tab", () => {
+    const catalogs: Catalogs = {
+      named: { test: { pkg: "1.0.0" } },
+    };
+
+    const result = catalogsToYaml(catalogs, { indent: "\t" });
+    expect(result).toEqual(dedent`
+      catalogs:
+      	test:
+      		pkg: 1.0.0`);
+  });
+
+  it("respects indent with 4 spaces", () => {
+    const catalogs: Catalogs = {
+      named: { test: { pkg: "1.0.0" } },
+    };
+
+    const result = catalogsToYaml(catalogs, { indent: 4 });
+    expect(result).toEqual(dedent`
+      catalogs:
+          test:
+              pkg: 1.0.0`);
+  });
+});