Skip to content

Commit 190ef65

Browse files
docs: update line numbers and add tempCompilationDir option details
1 parent b0ebd3d commit 190ef65

1 file changed

Lines changed: 13 additions & 2 deletions

File tree

docs/docs/reference/dashboard/vite-plugin/vendure-dashboard-plugin.mdx

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ generated: true
44
---
55
## vendureDashboardPlugin
66

7-
<GenerationInfo sourceFile="packages/dashboard/vite/vite-plugin-vendure-dashboard.ts" sourceLine="242" packageName="@vendure/dashboard" since="3.4.0" />
7+
<GenerationInfo sourceFile="packages/dashboard/vite/vite-plugin-vendure-dashboard.ts" sourceLine="254" packageName="@vendure/dashboard" since="3.4.0" />
88

99
This is the Vite plugin which powers the Vendure Dashboard, including:
1010

@@ -23,7 +23,7 @@ Parameters
2323

2424
## VitePluginVendureDashboardOptions
2525

26-
<GenerationInfo sourceFile="packages/dashboard/vite/vite-plugin-vendure-dashboard.ts" sourceLine="39" packageName="@vendure/dashboard" since="3.4.0" />
26+
<GenerationInfo sourceFile="packages/dashboard/vite/vite-plugin-vendure-dashboard.ts" sourceLine="40" packageName="@vendure/dashboard" since="3.4.0" />
2727

2828
Options for the [vendureDashboardPlugin](/reference/dashboard/vite-plugin/vendure-dashboard-plugin#venduredashboardplugin) Vite plugin.
2929

@@ -85,6 +85,17 @@ type VitePluginVendureDashboardOptions = {
8585
* The path to the directory where the generated GraphQL Tada files will be output.
8686
*/
8787
gqlOutputPath?: string;
88+
/**
89+
* @description
90+
* The directory into which the VendureConfig is transpiled and loaded in order
91+
* to introspect the configuration during the dashboard build.
92+
*
93+
* Defaults to `<project>/node_modules/.cache/vendure-dashboard-temp`. It must
94+
* not be located inside a `"type": "module"` package (such as
95+
* `@vendure/dashboard` itself), because the config is compiled to CommonJS and
96+
* Node would then load it as ESM, failing with
97+
* `exports is not defined in ES module scope`.
98+
*/
8899
tempCompilationDir?: string;
89100
/**
90101
* @description

0 commit comments

Comments
 (0)