fix(examples): configuration of vite (#1449)

shopware · Nov 13, 2024 · 8ba9702 · 8ba9702
1 parent d4482d5
commit 8ba9702
Show file tree

Hide file tree

Showing 9 changed files with 41 additions and 2 deletions.
diff --git a/.changeset/six-snakes-joke.md b/.changeset/six-snakes-joke.md
@@ -0,0 +1,5 @@
+---
+"@shopware-pwa/composables-next": patch
+---
+
+Add configuration step to README.md
diff --git a/examples/b2b-quote-management/vite.config.js b/examples/b2b-quote-management/vite.config.js
@@ -6,6 +6,9 @@ import UnoCSS from "unocss/vite";
 
 export default defineConfig({
   plugins: [vue(), UnoCSS()],
+  optimizeDeps: {
+    exclude: ["@shopware-pwa/composables-next"],
+  },
   resolve: {
     alias: {
       "@": fileURLToPath(new URL("./src", import.meta.url)),

diff --git a/examples/blank-playground/vite.config.js b/examples/blank-playground/vite.config.js
@@ -6,6 +6,9 @@ import vue from "@vitejs/plugin-vue";
 // https://vitejs.dev/config/
 export default defineConfig({
   plugins: [vue()],
+  optimizeDeps: {
+    exclude: ["@shopware-pwa/composables-next"],
+  },
   resolve: {
     alias: {
       "@": fileURLToPath(new URL("./src", import.meta.url)),

diff --git a/examples/commercial-quick-order/vite.config.ts b/examples/commercial-quick-order/vite.config.ts
@@ -6,6 +6,9 @@ import vue from "@vitejs/plugin-vue";
 // https://vitejs.dev/config/
 export default defineConfig({
   plugins: [vue()],
+  optimizeDeps: {
+    exclude: ["@shopware-pwa/composables-next"],
+  },
   resolve: {
     alias: {
       "@": fileURLToPath(new URL("./src", import.meta.url)),

diff --git a/examples/express-checkout/vite.config.js b/examples/express-checkout/vite.config.js
@@ -6,6 +6,9 @@ import vue from "@vitejs/plugin-vue";
 // https://vitejs.dev/config/
 export default defineConfig({
   plugins: [vue()],
+  optimizeDeps: {
+    exclude: ["@shopware-pwa/composables-next"],
+  },
   resolve: {
     alias: {
       "@": fileURLToPath(new URL("./src", import.meta.url)),

diff --git a/examples/login-form/vite.config.js b/examples/login-form/vite.config.js
@@ -6,6 +6,9 @@ import vue from "@vitejs/plugin-vue";
 // https://vitejs.dev/config/
 export default defineConfig({
   plugins: [vue()],
+  optimizeDeps: {
+    exclude: ["@shopware-pwa/composables-next"],
+  },
   resolve: {
     alias: {
       "@": fileURLToPath(new URL("./src", import.meta.url)),

diff --git a/examples/responsive-images/vite.config.js b/examples/responsive-images/vite.config.js
@@ -6,6 +6,9 @@ import vue from "@vitejs/plugin-vue";
 // https://vitejs.dev/config/
 export default defineConfig({
   plugins: [vue()],
+  optimizeDeps: {
+    exclude: ["@shopware-pwa/composables-next"],
+  },
   resolve: {
     alias: {
       "@": fileURLToPath(new URL("./src", import.meta.url)),

diff --git a/packages/composables/README.md b/packages/composables/README.md
@@ -53,15 +53,29 @@ app.provide("apiClient", apiClient);
 Now, we can create a Vue 3 plugin to install a Shopware context in an app:
 
 ```js
-// app variable in type of App
+import { createShopwareContext } from "@shopware-pwa/composables-next";
 
+// app variable in type of App
 const shopwareContext = createShopwareContext(app, {
   devStorefrontUrl: "https://your-sales-channel-configured-domain.com",
 });
 // register a plugin in a Vue instance
 app.use(shopwareContext);
 ```
 
+Exclude `@shopware-pwa/composables-next` package from [pre-building](https://vite.dev/guide/dep-pre-bundling.html#customizing-the-behavior) process:
+
+```ts
+// vite.config.js or .ts
+...
+optimizeDeps: {
+  exclude: ["@shopware-pwa/composables-next"],
+},
+...
+```
+
+---
+
 > The example does not provide the session handling and that means you need to do few additional steps if you need to keep your session after the page reload (see the chapter below with 🍪)
 
 ## Basic usage

diff --git a/packages/composables/build.config.ts b/packages/composables/build.config.ts
@@ -4,6 +4,9 @@ import { resolve } from "pathe";
 export default defineBuildConfig({
   entries: ["src/index"],
   declaration: true,
+  rollup: {
+    inlineDependencies: true,
+  },
   externals: [
     "axios",
     "vue",
@@ -16,5 +19,4 @@ export default defineBuildConfig({
     "#imports": resolve("./src/index.ts"),
     "#shopware": resolve("./types/api-types.ts"),
   },
-  failOnWarn: false,
 });