.github/workflows/ci.yml

@@ -19,6 +19,8 @@ jobs:
           node-version: 16
           cache: 'pnpm'
       - run: pnpm install
+      - run: pnpm -r dev:prepare
       - run: pnpm lint
+      - run: pnpm test -- --coverage
       - run: pnpm build
       - run: pnpm example:build

.gitignore

@@ -6,3 +6,4 @@ coverage
 dist
 types
 package-lock.json
+.nuxt

CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [0.3.1](https://github.com/nuxt/module-builder/compare/v0.3.0...v0.3.1) (2023-05-01)
+
+
+### Bug Fixes
+
+* extend `nuxt/schema` as well ([796d6ab](https://github.com/nuxt/module-builder/commit/796d6ab161f753b3cce66ebf182f1f46b22f2a7c))
+
 ## [0.3.0](https://github.com/nuxt/module-builder/compare/v0.2.1...v0.3.0) (2023-04-11)
 
 ### [0.2.1](https://github.com/nuxt/module-builder/compare/v0.2.0...v0.2.1) (2022-11-16)

example/.nuxtrc

@@ -0,0 +1,2 @@
+imports.autoImport=false
+typescript.includeWorkspace=true

example/package.json

@@ -2,8 +2,10 @@
   "name": "my-module",
   "license": "MIT",
   "version": "1.0.0",
+  "type": "module",
   "exports": {
     ".": {
+      "types": "./dist/types.d.ts",
       "import": "./dist/module.mjs",
       "require": "./dist/module.cjs"
     },
@@ -15,15 +17,19 @@
     "dist"
   ],
   "scripts": {
-    "prepack": "nuxt-module-build"
+    "prepack": "jiti ../src/cli.ts",
+    "dev": "nuxi dev playground",
+    "dev:build": "nuxi build playground",
+    "dev:prepare": "jiti ../src/cli.ts --stub && nuxi prepare playground"
   },
   "dependencies": {
-    "@nuxt/kit": "^3.4.0"
+    "@nuxt/kit": "^3.4.3"
   },
   "devDependencies": {
-    "@nuxt/schema": "^3.4.0",
-    "@nuxt/module-builder": "..",
-    "nuxt": "^3.4.0"
+    "@types/node": "^18.16.3",
+    "@nuxt/module-builder": "workspace:*",
+    "@nuxt/schema": "^3.4.3",
+    "nuxt": "^3.4.3"
   },
   "build": {
     "entries": [

example/playground/app.vue

@@ -0,0 +1,8 @@
+<template>
+  <div>
+    Nuxt module playground!
+  </div>
+</template>
+
+<script setup>
+</script>

example/playground/nuxt.config.ts

@@ -0,0 +1,4 @@
+export default defineNuxtConfig({
+  modules: ['../src/module'],
+  myModule: {}
+})

example/playground/package.json

@@ -0,0 +1,8 @@
+{
+  "private": true,
+  "name": "my-module-playground",
+  "dependencies": {
+    "my-module": "workspace:*",
+    "nuxt": "latest"
+  }
+}

example/src/module.ts

@@ -1,5 +1,6 @@
-import { defineNuxtModule } from '@nuxt/kit'
+import { defineNuxtModule, addPlugin, createResolver } from '@nuxt/kit'
 
+// Module options TypeScript interface definition
 export interface ModuleOptions {
   apiKey: string
 }
@@ -21,8 +22,14 @@ export default defineNuxtModule<ModuleOptions>({
     name: 'my-module',
     configKey: 'myModule'
   },
+  // Default configuration options of the Nuxt module
   defaults: {
     apiKey: ''
   },
-  setup (_options, _nuxt) {}
+  setup (_options, _nuxt) {
+    const resolver = createResolver(import.meta.url)
+
+    // Do not add the extension since the `.ts` will be transpiled to `.mjs` after `npm run prepack`
+    addPlugin(resolver.resolve('./runtime/plugin'))
+  }
 })

example/src/runtime/plugin.ts

@@ -1,7 +1,6 @@
-// @ts-ignore
 import { defineNuxtPlugin } from '#app'
 
 export default defineNuxtPlugin((_nuxtApp) => {
   // eslint-disable-next-line no-console
-  console.log('Plugin by my-module!')
+  console.log('Plugin injected by my-module!')
 })

example/tsconfig.json

@@ -0,0 +1,3 @@
+{
+  "extends": "./playground/.nuxt/tsconfig.json"
+}

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nuxt/module-builder",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "Complete solution to build Nuxt Modules",
   "license": "MIT",
   "type": "module",
@@ -25,24 +25,26 @@
     "nuxt-module-build": "jiti ./src/cli.ts",
     "prepack": "pnpm build",
     "release": "pnpm test && standard-version && git push --follow-tags && npm publish",
-    "test": "pnpm lint"
+    "test": "pnpm vitest"
   },
   "dependencies": {
-    "consola": "^3.0.1",
+    "consola": "^3.1.0",
     "mlly": "^1.2.0",
     "mri": "^1.2.0",
     "pathe": "^1.1.0",
-    "unbuild": "^1.2.0"
+    "unbuild": "^1.2.1"
   },
   "devDependencies": {
-    "@nuxt/kit": "^3.4.0",
-    "@nuxt/schema": "^3.4.0",
+    "@nuxt/kit": "^3.4.3",
+    "@nuxt/schema": "^3.4.3",
     "@nuxtjs/eslint-config-typescript": "^12.0.0",
     "@types/mri": "^1.1.1",
-    "@types/node": "^18.15.11",
-    "eslint": "^8.38.0",
+    "@types/node": "^18.16.3",
+    "@vitest/coverage-c8": "^0.30.1",
+    "eslint": "^8.39.0",
     "jiti": "^1.18.2",
-    "nuxt": "^3.4.0",
-    "standard-version": "^9.5.0"
+    "nuxt": "^3.4.3",
+    "standard-version": "^9.5.0",
+    "vitest": "^0.30.1"
   }
 }