Merge pull request #32 from dimitrio-m/fix/follow-nuxt-author-guide

Modified the code so it follows the latest official Nuxt's Module Author Guide and bumped the medusa package version
nuxt-modules · Oct 25, 2023 · fe8d7c4 · fe8d7c4 · vercel · Oct 25, 2023
2 parents 6ac9f13 + 1fcee89
commit fe8d7c4
Show file tree

Hide file tree

Showing 8 changed files with 3,808 additions and 2,607 deletions.
diff --git a/package.json b/package.json
@@ -24,35 +24,37 @@
     "e-commerce"
   ],
   "scripts": {
-    "prepack": "nuxt-module-build",
+    "prepack": "nuxt-module-build build",
     "dev": "nuxi dev playground",
     "dev:build": "nuxi build playground",
     "docs": "cd docs && yarn dev",
     "medusa": "cd medusa && yarn start",
-    "dev:prepare": "nuxt-module-build --stub && nuxi prepare playground",
-    "release": "yarn run lint && yarn run test && yarn run prepack && changelogen --release --output=CHANGELOG.md && yarn publish && git push --follow-tags",
+    "dev:prepare": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxi prepare playground",
+    "release": "yarn run lint && yarn run test && yarn run dev:prepare && yarn run prepack && changelogen --release --output=CHANGELOG.md && yarn publish && git push --follow-tags",
     "lint": "eslint .",
     "test": "vitest run",
     "test:watch": "vitest watch",
     "stackblitz": "cd .stackblitz && yarn && yarn dev"
   },
   "dependencies": {
-    "@medusajs/medusa-js": "^1.3.10",
-    "@nuxt/kit": "^3.2.2",
+    "@medusajs/medusa-js": "^6.1.3",
+    "@nuxt/kit": "^3.8.0",
     "defu": "^6.1.2"
   },
   "devDependencies": {
-    "@nuxt/eslint-config": "^0.1.1",
-    "@nuxt/module-builder": "^0.2.1",
-    "@nuxt/schema": "^3.2.2",
-    "@nuxt/test-utils": "^3.2.2",
-    "changelogen": "^0.4.1",
-    "eslint": "^8.34.0",
-    "nuxt": "^3.2.2",
-    "vitest": "^0.28.5"
+    "@nuxt/devtools": "latest",
+    "@nuxt/eslint-config": "^0.2.0",
+    "@nuxt/module-builder": "^0.5.2",
+    "@nuxt/schema": "^3.8.0",
+    "@nuxt/test-utils": "^3.8.0",
+    "@types/node": "^18.18.6",
+    "changelogen": "^0.5.5",
+    "eslint": "^8.52.0",
+    "nuxt": "^3.8.0",
+    "vitest": "^0.33.0"
   },
   "stackblitz": {
     "installDependencies": false,
     "startCommand": "yarn stackblitz"
   }
-}
+}
diff --git a/playground/app.vue b/playground/app.vue
@@ -6,41 +6,57 @@ const { data } = await useFetch('/api/products')
 
 <template>
   <section>
-    <h2 class="text-2xl">Products fetched from Client</h2>
-  <div class="flex">
-    <div v-for="product in products" class="mx-2">
-      <div class="relative rounded-lg shadow-lg">
-        <img
-          :src="product.thumbnail"
-          class="shadow-lg rounded-lg opacity-1 hover:opacity-75 transition duration-300 ease-in-out w-full"
-        />
-        <div class="p-6">
-          <h5 class="font-bold text-lg mb-3">{{ product.title }}</h5>
-          <pre class="text-gray-500 mb-4">{{
+    <h2 class="text-2xl">
+      Products fetched from Client
+    </h2>
+    <div class="flex">
+      <div
+        v-for="product in products"
+        :key="product.key"
+        class="mx-2"
+      >
+        <div class="relative rounded-lg shadow-lg">
+          <img
+            :src="product.thumbnail"
+            class="shadow-lg rounded-lg opacity-1 hover:opacity-75 transition duration-300 ease-in-out w-full"
+          >
+          <div class="p-6">
+            <h5 class="font-bold text-lg mb-3">
+              {{ product.title }}
+            </h5>
+            <pre class="text-gray-500 mb-4">{{
             product.variants[0].prices[0].amount
-          }}</pre>
-          <p>{{ product.description }}</p>
+            }}</pre>
+            <p>{{ product.description }}</p>
+          </div>
         </div>
       </div>
     </div>
-  </div>
-  <h2 class="text-2xl">Products fetched from Server</h2>
-  <div class="flex">
-    <div v-for="product in data?.products" class="mx-2">
-      <div class="relative rounded-lg shadow-lg">
-        <img
-          :src="product.thumbnail"
-          class="shadow-lg rounded-lg opacity-1 hover:opacity-75 transition duration-300 ease-in-out w-full"
-        />
-        <div class="p-6">
-          <h5 class="font-bold text-lg mb-3">{{ product.title }}</h5>
-          <pre class="text-gray-500 mb-4">{{
+    <h2 class="text-2xl">
+      Products fetched from Server
+    </h2>
+    <div class="flex">
+      <div
+        v-for="product in data?.products"
+        :key="product.key"
+        class="mx-2"
+      >
+        <div class="relative rounded-lg shadow-lg">
+          <img
+            :src="product.thumbnail"
+            class="shadow-lg rounded-lg opacity-1 hover:opacity-75 transition duration-300 ease-in-out w-full"
+          >
+          <div class="p-6">
+            <h5 class="font-bold text-lg mb-3">
+              {{ product.title }}
+            </h5>
+            <pre class="text-gray-500 mb-4">{{
             product.variants[0].prices[0].amount
-          }}</pre>
-          <p>{{ product.description }}</p>
+            }}</pre>
+            <p>{{ product.description }}</p>
+          </div>
         </div>
       </div>
     </div>
-  </div>
   </section>
 </template>
diff --git a/playground/nuxt.config.ts b/playground/nuxt.config.ts
@@ -13,11 +13,12 @@ export default defineNuxtConfig({
   },
   modules: ['../src/module'],
   medusa: {
-  //   baseUrl: 'http://localhost:9000',
-  //   apiKey: 'test',
-  //   publishableApiKey: 'test',
-  //   maxRetries: 3
-  //   global: false
+    //   baseUrl: 'http://localhost:9000',
+    //   apiKey: 'test',
+    //   publishableApiKey: 'test',
+    //   maxRetries: 3
+    //   global: false
     server: true
-  }
+  },
+  devtools: { enabled: true }
 })
diff --git a/playground/package.json b/playground/package.json
@@ -1,4 +1,13 @@
 {
   "private": true,
-  "name": "my-module-playground"
-}
+  "name": "my-module-playground",
+  "type": "module",
+  "scripts": {
+    "dev": "nuxi dev",
+    "build": "nuxi build",
+    "generate": "nuxi generate"
+  },
+  "devDependencies": {
+    "nuxt": "latest"
+  }
+}
diff --git a/playground/server/tsconfig.json b/playground/server/tsconfig.json
@@ -0,0 +1,3 @@
+{
+  "extends": "../.nuxt/tsconfig.server.json"
+}
diff --git a/playground/tsconfig.json b/playground/tsconfig.json
@@ -0,0 +1,3 @@
+{
+  "extends": "./.nuxt/tsconfig.json"
+}
diff --git a/src/module.ts b/src/module.ts
@@ -1,7 +1,7 @@
 import { defineNuxtModule, addPlugin, createResolver, addImportsDir, extendViteConfig, addTemplate } from '@nuxt/kit'
 import { fileURLToPath } from 'url'
 import { defu } from 'defu'
-import { Config } from '@medusajs/medusa-js'
+import type { Config } from '@medusajs/medusa-js'
 
 export type ModuleOptions = Config & { global?: boolean, server: boolean }
 
@@ -16,7 +16,7 @@ export default defineNuxtModule<ModuleOptions>({
     global: true,
     server: false,
   },
-  setup (options, nuxt) {
+  setup(options, nuxt) {
     const resolver = createResolver(import.meta.url)
 
     nuxt.options.runtimeConfig.private = defu(nuxt.options.runtimeConfig.private, {