Sync open source content 🐝 (from 6598e8aa14dd1fcbb2fa9b7b69c03db48dd3a6a6)

Author: beezythebot

guides/sdks/pnpm-default.mdx

@@ -5,13 +5,15 @@ image: "/assets/examples/generic.png"
 date: 2024-12-05
 authors:
   - name: Logan Gingerich
-  - image_url: '/assets/author-headshots/logan.jpg'
+  - image_url: "/assets/author-headshots/logan.jpg"
 tags:
   - SDK Generation
 is_featured: false
 featured_image: "/assets/examples/generic.png"
 ---
 
+import { Callout } from "@/mdx/components";
+
 # Switching default package manager to `pnpm`
 
 ## Prerequisite
@@ -32,7 +34,7 @@ permissions:
   contents: write
   pull-requests: write
   statuses: write
-'on':
+"on":
   workflow_dispatch:
     inputs:
       force:
@@ -51,12 +53,13 @@ jobs:
       set_version: ${{ github.event.inputs.set_version }}
       speakeasy_version: latest
       working_directory: packages/sdk
-      pnpm_version: "9.19.4"  # Specify the required pnpm version
+      pnpm_version: "9.19.4" # Specify the required pnpm version
     secrets:
       github_access_token: ${{ secrets.GITHUB_TOKEN }}
       npm_token: ${{ secrets.NPM_TOKEN_ELEVATED }}
       speakeasy_api_key: ${{ secrets.SPEAKEASY_API_KEY }}
 ```
+
 ## (Optional) Verifying `pnpm` Installation
 
 Ensure pnpm is used in the workflow by adding a step to verify its presence:
@@ -72,4 +75,40 @@ This outputs the installed `pnpm` version for confirmation during workflow execu
 ## Additional Notes
 
 - Use the same `pnpm_version` as used in local development for consistency.
-- Ensure any `package.json` files are compatible with pnpm. Run `pnpm install` locally to verify.
+- Ensure any `package.json` files are compatible with pnpm. Run `pnpm install` locally to verify.
+
+## Using PNPM in Monorepos
+
+When working with monorepos, pnpm offers several advantages including strict module resolution and efficient workspace management. To configure Speakeasy to use pnpm in your monorepo:
+
+### Local Development Configuration
+
+Add the `compileCommand` configuration to your `gen.yaml` file:
+
+```yaml
+typescript:
+  compileCommand:
+    - pnpm
+    - install
+```
+
+### Workspace Configuration
+
+Ensure your `pnpm-workspace.yaml` includes the SDK directory:
+
+```yaml
+packages:
+  - "packages/*"
+  - "sdk/*" # Include your SDK location
+```
+
+### Benefits for Monorepos
+
+- **Strict module resolution**: Prevents dependency confusion between packages
+- **Efficient storage**: Shared dependencies across workspace packages
+- **Better workspace support**: Built-in monorepo tooling
+
+<Callout title="Related Guide">
+  For comprehensive monorepo setup and troubleshooting tips, see our [TypeScript
+  Monorepo Tips guide](/guides/sdks/typescript-monorepo-tips).
+</Callout>

guides/sdks/typescript-monorepo-tips.mdx

@@ -7,8 +7,9 @@ import { Callout } from "@/mdx/components";
 
 # Tips for Integrating a TypeScript SDK into a Monorepo
 
-<Callout title="Get Started" >
-If you're looking to set up a monorepo from scratch, check out our [Create a monorepo](/guides/sdks/creating-a-monorepo) guide first.
+<Callout title="Get Started">
+  If you're looking to set up a monorepo from scratch, check out our [Create a
+  monorepo](/guides/sdks/creating-a-monorepo) guide first.
 </Callout>
 
 ## Dependency Confusion
@@ -23,10 +24,11 @@ Let's say a developer have Zod installed in their monorepo's root, and their Spe
 try {
   const result = await sdk.products.create({
     name: "Cool Product",
-    price: "not a number" // This should fail validation
+    price: "not a number", // This should fail validation
   });
 } catch (err) {
-  if (err instanceof ZodError) { // 🚨 This check fails!
+  if (err instanceof ZodError) {
+    // 🚨 This check fails!
     console.log("Validation error:", err.errors);
   }
 }
@@ -131,7 +133,7 @@ For example, one might see errors about missing dependencies that they know are
 
 ### How to fix it
 
-Fortunately, this one's easy to solve. Just customize the compile command in your `gen.yaml`:
+Configure Speakeasy to use your preferred package manager when building the SDK. For pnpm (recommended for monorepos), customize the compile command in your `gen.yaml`:
 
 ```yaml
 # For pnpm
@@ -141,7 +143,12 @@ typescript:
     - install
 ```
 
-This tells Speakeasy to use the preferred package manager when building the SDK.
+This tells Speakeasy to use pnpm instead of npm when building the SDK, which is especially important in monorepos where pnpm's strict module resolution helps prevent dependency confusion issues.
+
+<Callout title="Related Guide">
+  For more detailed information about configuring pnpm as your default package
+  manager, see our [Using PNPM guide](/guides/sdks/pnpm-default).
+</Callout>
 
 ## Putting it all together - a real-world example
 
@@ -166,12 +173,14 @@ my-monorepo/
 ```
 
 pnpm-workspace.yaml:
+
 ```yaml
 packages:
-  - 'packages/*'
+  - "packages/*"
 ```
 
 frontend/package.json:
+
 ```json
 {
   "dependencies": {
@@ -181,6 +190,7 @@ frontend/package.json:
 ```
 
 gen.yaml:
+
 ```yaml
 typescript:
   moduleFormat: esm
@@ -193,6 +203,7 @@ typescript:
 ```
 
 This setup gives:
+
 1. A consistent dependency tree with pnpm's strict module resolution
 2. ESM modules for maximum compatibility
 3. pnpm for package management