feat: transform as module (#37)

* refactor: convert to module * cleanup * fix: missing imports * Update docs/content/docs/1.getting-started/2.installation.md * chore: add prepack script * Create .nuxtrc --------- Co-authored-by: Sébastien Chopin <[email protected]>
nuxt-hub · Apr 3, 2024 · add1a3d · add1a3d
1 parent dc8f203
commit add1a3d
Show file tree

Hide file tree

Showing 34 changed files with 472 additions and 254 deletions.
diff --git a/.nuxtrc b/.nuxtrc
@@ -1,4 +1,4 @@
-# imports.autoImport=false
+imports.autoImport=false
 typescript.includeWorkspace=true
 
 # enable TypeScript bundler module resolution - https://www.typescriptlang.org/docs/handbook/modules/reference.html#bundler

diff --git a/README.md b/README.md
@@ -38,11 +38,11 @@ npx nypm@latest add @nuxthub/core
 npx nypm@latest add -D wrangler
 ```
 
-3. Add `@nuxthub/core` to the `extends` section of `nuxt.config.ts`
+3. Add `@nuxthub/core` to the `modules` section of `nuxt.config.ts`
 
 ```js
 export default defineNuxtConfig({
-  extends: [
+  modules: [
     '@nuxthub/core'
   ]
 })

diff --git a/docs/.nuxtrc b/docs/.nuxtrc
@@ -0,0 +1 @@
+imports.autoImport=true
diff --git a/docs/content/docs/1.getting-started/2.installation.md b/docs/content/docs/1.getting-started/2.installation.md
@@ -17,7 +17,7 @@ npx nuxthub init my-app
 
 ## Add to a Nuxt project
 
-1. Install the NuxtHub package to your project:
+1. Install the NuxtHub module to your project:
 
 ::code-group
 
@@ -61,11 +61,11 @@ bun add --dev wrangler
 
 ::
 
-3. Add `@nuxthub/core` to your `extends` section in your `nuxt.config`:
+3. Add `@nuxthub/core` to your `modules` section in your `nuxt.config`:
 
 ```ts [nuxt.config.ts]
 export default defineNuxtConfig({
-  extends: ['@nuxthub/core']
+  modules: ['@nuxthub/core']
 })
 ```
 
@@ -81,7 +81,7 @@ Configure options in your `nuxt.config.ts` as such:
 
 ```ts [nuxt.config.ts]
 export default defineNuxtConfig({
-  extends: ['@nuxthub/core'],
+  modules: ['@nuxthub/core'],
   hub: {
     // NuxtHub options
   }

diff --git a/nuxt.config.ts b/nuxt.config.ts
diff --git a/package.json b/package.json
@@ -9,11 +9,11 @@
   },
   "license": "Apache-2.0",
   "type": "module",
-  "main": "./nuxt.config.ts",
+  "main": "./dist/module.cjs",
+  "module": "./dist/module.mjs",
   "homepage": "https://hub.nuxt.com",
   "files": [
-    "src",
-    "nuxt.config.ts"
+    "dist"
   ],
   "keywords": [
     "nuxt",
@@ -24,7 +24,8 @@
     "blob"
   ],
   "scripts": {
-    "dev:prepare": "nuxi prepare playground",
+    "prepack": "nuxt-module-build build",
+    "dev:prepare": "nuxt-module-build build --stub; nuxi prepare playground",
     "dev": "nuxi dev playground",
     "dev:build": "nuxi build playground",
     "docs": "PORT=4000 nuxi dev docs",
@@ -60,6 +61,7 @@
   "devDependencies": {
     "@nuxt/devtools": "^1.1.4",
     "@nuxt/eslint-config": "^0.2.0",
+    "@nuxt/module-builder": "^0.5.5",
     "@nuxt/schema": "^3.11.1",
     "@nuxt/test-utils": "^3.12.0",
     "@types/node": "^20.11.30",
@@ -70,4 +72,4 @@
     "vitest": "^1.4.0",
     "wrangler": "^3.39.0"
   }
-}
+}
diff --git a/playground/.nuxtrc b/playground/.nuxtrc
@@ -0,0 +1 @@
+imports.autoImport=true
diff --git a/playground/nuxt.config.ts b/playground/nuxt.config.ts
@@ -1,11 +1,11 @@
+import module from '../src/module'
+
 export default defineNuxtConfig({
   devtools: { enabled: true },
-  extends: [
-    '../'
-  ],
   modules: [
     '@nuxt/ui',
-    '@kgierke/nuxt-basic-auth'
+    '@kgierke/nuxt-basic-auth',
+    module
   ],
   ui: {
     icons: ['heroicons', 'simple-icons']