feat: serializable return values

Thinkmill · Aug 26, 2024 · 14d3848 · 14d3848
1 parent 045f7d7
commit 14d3848
Show file tree

Hide file tree

Showing 6 changed files with 35 additions and 20 deletions.
diff --git a/.changeset/chilly-bottles-eat.md b/.changeset/chilly-bottles-eat.md
@@ -0,0 +1,5 @@
+---
+"@manypkg/find-root": minor
+---
+
+feat: export DEFAULT_TOOLS
diff --git a/.changeset/chilly-moles-grow.md b/.changeset/chilly-moles-grow.md
@@ -0,0 +1,5 @@
+---
+"@manypkg/tools": major
+---
+
+feat: serializable return values
diff --git a/packages/find-root/src/index.test.ts b/packages/find-root/src/index.test.ts
@@ -15,7 +15,7 @@ const runTests = (findRoot: FindRoot) => {
       path.join(tmpPath, "packages", "package-one", "src")
     );
     expect(monorepoRoot).toEqual({
-      tool: YarnTool,
+      tool: YarnTool.type,
       rootDir: tmpPath,
     });
   });
@@ -26,7 +26,7 @@ const runTests = (findRoot: FindRoot) => {
       path.join(tmpPath, "packages", "package-one", "src")
     );
     expect(monorepoRoot).toEqual({
-      tool: LernaTool,
+      tool: LernaTool.type,
       rootDir: tmpPath,
     });
   });
@@ -40,7 +40,7 @@ const runTests = (findRoot: FindRoot) => {
       path.join(tmpPath, "packages", "package-one", "src")
     );
     expect(monorepoRoot).toEqual({
-      tool: YarnTool,
+      tool: YarnTool.type,
       rootDir: tmpPath,
     });
   });
@@ -51,7 +51,7 @@ const runTests = (findRoot: FindRoot) => {
       path.join(tmpPath, "packages", "package-one", "src")
     );
     expect(monorepoRoot).toEqual({
-      tool: PnpmTool,
+      tool: PnpmTool.type,
       rootDir: tmpPath,
     });
   });
@@ -60,7 +60,7 @@ const runTests = (findRoot: FindRoot) => {
     let tmpPath = f.copy("single-pkg");
     let monorepoRoot = await findRoot(path.join(tmpPath, "src"));
     expect(monorepoRoot).toEqual({
-      tool: RootTool,
+      tool: RootTool.type,
       rootDir: tmpPath,
     });
   });

diff --git a/packages/find-root/src/index.ts b/packages/find-root/src/index.ts
@@ -20,7 +20,7 @@ import {
  * monorepo implementations first, with tools based on custom file schemas
  * checked last.
  */
-const DEFAULT_TOOLS: Tool[] = [
+export const DEFAULT_TOOLS: Tool[] = [
   YarnTool,
   PnpmTool,
   LernaTool,
@@ -83,7 +83,7 @@ export async function findRoot(
       tools.map(async (tool): Promise<MonorepoRoot | undefined> => {
         if (await tool.isMonorepoRoot(directory)) {
           return {
-            tool: tool,
+            tool: tool.type,
             rootDir: directory,
           };
         }
@@ -125,7 +125,7 @@ export async function findRoot(
   }
 
   return {
-    tool: RootTool,
+    tool: RootTool.type,
     rootDir,
   };
 }
@@ -144,7 +144,7 @@ export function findRootSync(
     for (const tool of tools) {
       if (tool.isMonorepoRootSync(directory)) {
         monorepoRoot = {
-          tool: tool,
+          tool: tool.type,
           rootDir: directory,
         };
         return directory;
@@ -173,7 +173,7 @@ export function findRootSync(
   }
 
   return {
-    tool: RootTool,
+    tool: RootTool.type,
     rootDir,
   };
 }

diff --git a/packages/get-packages/src/index.ts b/packages/get-packages/src/index.ts
@@ -1,5 +1,10 @@
 import path from "path";
-import { findRoot, findRootSync, FindRootOptions } from "@manypkg/find-root";
+import {
+  findRoot,
+  findRootSync,
+  FindRootOptions,
+  DEFAULT_TOOLS,
+} from "@manypkg/find-root";
 import { Packages, MonorepoRoot, Tool } from "@manypkg/tools";
 
 export type { Tool, Package, Packages } from "@manypkg/tools";
@@ -36,12 +41,12 @@ export async function getPackages(
   options?: GetPackagesOptions
 ): Promise<Packages> {
   const monorepoRoot: MonorepoRoot = await findRoot(dir, options);
-  const packages: Packages = await monorepoRoot.tool.getPackages(
-    monorepoRoot.rootDir
-  );
+  const tools = options?.tools || DEFAULT_TOOLS;
+  const tool = tools.find((t) => t.type === monorepoRoot.tool);
+  if (!tool) throw new Error(`Could not find ${monorepoRoot.tool} tool`);
 
+  const packages: Packages = await tool.getPackages(monorepoRoot.rootDir);
   validatePackages(packages);
-
   return packages;
 }
 
@@ -53,12 +58,12 @@ export function getPackagesSync(
   options?: GetPackagesOptions
 ): Packages {
   const monorepoRoot: MonorepoRoot = findRootSync(dir, options);
-  const packages: Packages = monorepoRoot.tool.getPackagesSync(
-    monorepoRoot.rootDir
-  );
+  const tools = options?.tools || DEFAULT_TOOLS;
+  const tool = tools.find((t) => t.type === monorepoRoot.tool);
+  if (!tool) throw new Error(`Could not find ${monorepoRoot.tool} tool`);
 
+  const packages: Packages = tool.getPackagesSync(monorepoRoot.rootDir);
   validatePackages(packages);
-
   return packages;
 }
 

diff --git a/packages/tools/src/Tool.ts b/packages/tools/src/Tool.ts
@@ -97,7 +97,7 @@ export interface MonorepoRoot {
   /**
    * The underlying tool implementation for this monorepo.
    */
-  tool: Tool;
+  tool: string;
 }
 
 /**