Skip to content

Commit c603540

Browse files
authored
docs: add troubleshooting guide for pnpm installations (medusajs#13351)
1 parent f39ba53 commit c603540

File tree

7 files changed

+63
-13
lines changed

7 files changed

+63
-13
lines changed

www/apps/book/public/llms-full.txt

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -41235,7 +41235,7 @@ Connection to Redis in module 'workflow-engine-redis' established
4123541235
- [fetchShippingOptionForOrderWorkflow](https://docs.medusajs.com/references/medusa-workflows/fetchShippingOptionForOrderWorkflow/index.html.md)
4123641236
- [getOrderDetailWorkflow](https://docs.medusajs.com/references/medusa-workflows/getOrderDetailWorkflow/index.html.md)
4123741237
- [getOrdersListWorkflow](https://docs.medusajs.com/references/medusa-workflows/getOrdersListWorkflow/index.html.md)
41238-
- [listShippingOptionsForOrderWorkflow](https://docs.medusajs.com/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.listShippingOptionsForOrderWorkflow/index.html.md)
41238+
- [listShippingOptionsForOrderWorkflow](https://docs.medusajs.com/references/medusa-workflows/listShippingOptionsForOrderWorkflow/index.html.md)
4123941239
- [markOrderFulfillmentAsDeliveredWorkflow](https://docs.medusajs.com/references/medusa-workflows/markOrderFulfillmentAsDeliveredWorkflow/index.html.md)
4124041240
- [markPaymentCollectionAsPaid](https://docs.medusajs.com/references/medusa-workflows/markPaymentCollectionAsPaid/index.html.md)
4124141241
- [maybeRefreshShippingMethodsWorkflow](https://docs.medusajs.com/references/medusa-workflows/maybeRefreshShippingMethodsWorkflow/index.html.md)
@@ -41392,11 +41392,11 @@ Connection to Redis in module 'workflow-engine-redis' established
4139241392
- [deleteSalesChannelsWorkflow](https://docs.medusajs.com/references/medusa-workflows/deleteSalesChannelsWorkflow/index.html.md)
4139341393
- [linkProductsToSalesChannelWorkflow](https://docs.medusajs.com/references/medusa-workflows/linkProductsToSalesChannelWorkflow/index.html.md)
4139441394
- [updateSalesChannelsWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateSalesChannelsWorkflow/index.html.md)
41395-
- [createViewConfigurationWorkflow](https://docs.medusajs.com/references/core_flows/Settings/Workflows_Settings/functions/core_flows.Settings.Workflows_Settings.createViewConfigurationWorkflow/index.html.md)
41396-
- [updateViewConfigurationWorkflow](https://docs.medusajs.com/references/core_flows/Settings/Workflows_Settings/functions/core_flows.Settings.Workflows_Settings.updateViewConfigurationWorkflow/index.html.md)
41397-
- [createShippingOptionTypesWorkflow](https://docs.medusajs.com/references/core_flows/Shipping_Options/Workflows_Shipping_Options/functions/core_flows.Shipping_Options.Workflows_Shipping_Options.createShippingOptionTypesWorkflow/index.html.md)
41398-
- [deleteShippingOptionTypesWorkflow](https://docs.medusajs.com/references/core_flows/Shipping_Options/Workflows_Shipping_Options/functions/core_flows.Shipping_Options.Workflows_Shipping_Options.deleteShippingOptionTypesWorkflow/index.html.md)
41399-
- [updateShippingOptionTypesWorkflow](https://docs.medusajs.com/references/core_flows/Shipping_Options/Workflows_Shipping_Options/functions/core_flows.Shipping_Options.Workflows_Shipping_Options.updateShippingOptionTypesWorkflow/index.html.md)
41395+
- [createViewConfigurationWorkflow](https://docs.medusajs.com/references/medusa-workflows/createViewConfigurationWorkflow/index.html.md)
41396+
- [updateViewConfigurationWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateViewConfigurationWorkflow/index.html.md)
41397+
- [createShippingOptionTypesWorkflow](https://docs.medusajs.com/references/medusa-workflows/createShippingOptionTypesWorkflow/index.html.md)
41398+
- [deleteShippingOptionTypesWorkflow](https://docs.medusajs.com/references/medusa-workflows/deleteShippingOptionTypesWorkflow/index.html.md)
41399+
- [updateShippingOptionTypesWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateShippingOptionTypesWorkflow/index.html.md)
4140041400
- [deleteShippingProfileWorkflow](https://docs.medusajs.com/references/medusa-workflows/deleteShippingProfileWorkflow/index.html.md)
4140141401
- [validateStepShippingProfileDelete](https://docs.medusajs.com/references/medusa-workflows/validateStepShippingProfileDelete/index.html.md)
4140241402
- [createLocationFulfillmentSetWorkflow](https://docs.medusajs.com/references/medusa-workflows/createLocationFulfillmentSetWorkflow/index.html.md)
@@ -41668,13 +41668,13 @@ Connection to Redis in module 'workflow-engine-redis' established
4166841668
- [detachLocationsFromSalesChannelsStep](https://docs.medusajs.com/references/medusa-workflows/steps/detachLocationsFromSalesChannelsStep/index.html.md)
4166941669
- [detachProductsFromSalesChannelsStep](https://docs.medusajs.com/references/medusa-workflows/steps/detachProductsFromSalesChannelsStep/index.html.md)
4167041670
- [updateSalesChannelsStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateSalesChannelsStep/index.html.md)
41671-
- [createViewConfigurationStep](https://docs.medusajs.com/references/core_flows/Settings/Steps_Settings/functions/core_flows.Settings.Steps_Settings.createViewConfigurationStep/index.html.md)
41672-
- [setActiveViewConfigurationStep](https://docs.medusajs.com/references/core_flows/Settings/Steps_Settings/functions/core_flows.Settings.Steps_Settings.setActiveViewConfigurationStep/index.html.md)
41673-
- [updateViewConfigurationStep](https://docs.medusajs.com/references/core_flows/Settings/Steps_Settings/functions/core_flows.Settings.Steps_Settings.updateViewConfigurationStep/index.html.md)
41674-
- [createShippingOptionTypesStep](https://docs.medusajs.com/references/core_flows/Shipping_Options/Steps_Shipping_Options/functions/core_flows.Shipping_Options.Steps_Shipping_Options.createShippingOptionTypesStep/index.html.md)
41675-
- [deleteShippingOptionTypesStep](https://docs.medusajs.com/references/core_flows/Shipping_Options/Steps_Shipping_Options/functions/core_flows.Shipping_Options.Steps_Shipping_Options.deleteShippingOptionTypesStep/index.html.md)
41671+
- [createViewConfigurationStep](https://docs.medusajs.com/references/medusa-workflows/steps/createViewConfigurationStep/index.html.md)
41672+
- [setActiveViewConfigurationStep](https://docs.medusajs.com/references/medusa-workflows/steps/setActiveViewConfigurationStep/index.html.md)
41673+
- [updateViewConfigurationStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateViewConfigurationStep/index.html.md)
41674+
- [createShippingOptionTypesStep](https://docs.medusajs.com/references/medusa-workflows/steps/createShippingOptionTypesStep/index.html.md)
41675+
- [deleteShippingOptionTypesStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteShippingOptionTypesStep/index.html.md)
4167641676
- [listShippingOptionsForContextStep](https://docs.medusajs.com/references/medusa-workflows/steps/listShippingOptionsForContextStep/index.html.md)
41677-
- [updateShippingOptionTypesStep](https://docs.medusajs.com/references/core_flows/Shipping_Options/Steps_Shipping_Options/functions/core_flows.Shipping_Options.Steps_Shipping_Options.updateShippingOptionTypesStep/index.html.md)
41677+
- [updateShippingOptionTypesStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateShippingOptionTypesStep/index.html.md)
4167841678
- [deleteShippingProfilesStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteShippingProfilesStep/index.html.md)
4167941679
- [createStockLocations](https://docs.medusajs.com/references/medusa-workflows/steps/createStockLocations/index.html.md)
4168041680
- [deleteStockLocationsStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteStockLocationsStep/index.html.md)
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
If you use `pnpm` as a package manager in your Medusa application, you might face errors about missing packages. For example:
2+
3+
```bash
4+
can't resolve @medusajs/dashboard
5+
```
6+
7+
## Why This Error Occurred
8+
9+
Medusa doesn't officially support `pnpm` as a package manager, which may lead to unexpected errors, including issues with package resolution.
10+
11+
---
12+
13+
## How to Fix it
14+
15+
To resolve this error and other potential errors, consider switching to `yarn` as your package manager.
16+
17+
If you still want to use `pnpm`, you must manually install the following packages in your project:
18+
19+
```bash
20+
pnpm add @medusajs/dashboard @medusajs/icons @meduasjs/types @medusajs/draft-order @medusajs/ui
21+
```
22+
23+
Make sure to also update these packages whenever you update your Medusa application.
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
import PnpmSection from "../_sections/common-installation-errors/pnpm.mdx"
2+
3+
export const metadata = {
4+
title: `Errors with pnpm`,
5+
}
6+
7+
# {metadata.title}
8+
9+
<PnpmSection />

www/apps/resources/generated/edit-dates.mjs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6570,5 +6570,6 @@ export const generatedEditDates = {
65706570
"app/integrations/guides/payload/page.mdx": "2025-08-21T05:24:11.537Z",
65716571
"references/js_sdk/admin/Client/methods/js_sdk.admin.Client.getToken/page.mdx": "2025-08-14T12:59:55.678Z",
65726572
"app/commerce-modules/order/draft-orders/page.mdx": "2025-08-26T09:21:49.780Z",
6573-
"app/troubleshooting/scheduled-job-not-running/page.mdx": "2025-08-29T11:32:54.117Z"
6573+
"app/troubleshooting/scheduled-job-not-running/page.mdx": "2025-08-29T11:32:54.117Z",
6574+
"app/troubleshooting/pnpm/page.mdx": "2025-08-29T12:21:24.692Z"
65746575
}

www/apps/resources/generated/files-map.mjs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1423,6 +1423,10 @@ export const filesMap = [
14231423
"filePath": "/www/apps/resources/app/troubleshooting/payment/page.mdx",
14241424
"pathname": "/troubleshooting/payment"
14251425
},
1426+
{
1427+
"filePath": "/www/apps/resources/app/troubleshooting/pnpm/page.mdx",
1428+
"pathname": "/troubleshooting/pnpm"
1429+
},
14261430
{
14271431
"filePath": "/www/apps/resources/app/troubleshooting/query/expression-type-error/page.mdx",
14281432
"pathname": "/troubleshooting/query/expression-type-error"

www/apps/resources/generated/generated-troubleshooting-sidebar.mjs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,14 @@ const generatedgeneratedTroubleshootingSidebarSidebar = {
4343
"path": "/troubleshooting/general-errors",
4444
"title": "General Errors",
4545
"children": []
46+
},
47+
{
48+
"loaded": true,
49+
"isPathHref": true,
50+
"type": "link",
51+
"path": "/troubleshooting/pnpm",
52+
"title": "pnpm Errors",
53+
"children": []
4654
}
4755
]
4856
},

www/apps/resources/sidebars/troubleshooting.mjs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,11 @@ export const troubleshootingSidebar = [
2828
path: "/troubleshooting/general-errors",
2929
title: "General Errors",
3030
},
31+
{
32+
type: "link",
33+
path: "/troubleshooting/pnpm",
34+
title: "pnpm Errors",
35+
},
3136
],
3237
},
3338
{

0 commit comments

Comments
 (0)