├── CODEOWNERS
├── .npmrc
├── example
    ├── src
    │   ├── utils.ts
    │   ├── runtime
    │   │   ├── components
    │   │   │   ├── JsxComponent.tsx
    │   │   │   ├── TestMeSetup.vue
    │   │   │   └── TestMe.vue
    │   │   ├── composables
    │   │   │   └── useWrappedFetch.ts
    │   │   └── plugins
    │   │   │   └── plugin.ts
    │   └── module.ts
    ├── .nuxtrc
    ├── playground
    │   ├── tsconfig.json
    │   ├── app.vue
    │   ├── package.json
    │   ├── nuxt.config.ts
    │   └── types.ts
    ├── tsconfig.json
    └── package.json
├── .attw.json
├── test
    ├── __snapshots__
    │   ├── JsxComponent.d.ts
    │   ├── JsxComponent.js
    │   ├── TestMeSetup.vue
    │   ├── plugin.d.ts
    │   ├── TestMe.vue
    │   ├── TestMeSetup.d.vue.ts
    │   ├── TestMeSetup.vue.d.ts
    │   └── TestMe.vue.d.ts
    └── build.spec.ts
├── src
    ├── index.ts
    ├── commands
    │   ├── _shared.ts
    │   ├── prepare.ts
    │   └── build.ts
    └── cli.ts
├── vitest.config.mts
├── pnpm-workspace.yaml
├── .gitignore
├── renovate.json
├── .editorconfig
├── eslint.config.js
├── .github
    ├── workflows
    │   ├── reproduction.yml
    │   ├── provenance.yml
    │   ├── release-nightly.yml
    │   └── ci.yml
    └── needs-reproduction.md
├── tsconfig.json
├── knip.json
├── LICENSE
├── package.json
├── README.md
└── CHANGELOG.md


/CODEOWNERS:
--------------------------------------------------------------------------------
1 | * @danielroe
2 | 


--------------------------------------------------------------------------------
/.npmrc:
--------------------------------------------------------------------------------
1 | shamefully-hoist=true
2 | shell-emulator=true
3 | 


--------------------------------------------------------------------------------
/example/src/utils.ts:
--------------------------------------------------------------------------------
1 | export const myModuleUtils = () => {}
2 | 


--------------------------------------------------------------------------------
/.attw.json:
--------------------------------------------------------------------------------
1 | {
2 |   "ignoreRules": ["cjs-resolves-to-esm"]
3 | }
4 | 


--------------------------------------------------------------------------------
/example/.nuxtrc:
--------------------------------------------------------------------------------
1 | imports.autoImport=false
2 | typescript.includeWorkspace=true
3 | 


--------------------------------------------------------------------------------
/example/playground/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 |   "extends": "./.nuxt/tsconfig.json"
3 | }
4 | 


--------------------------------------------------------------------------------
/test/__snapshots__/JsxComponent.d.ts:
--------------------------------------------------------------------------------
1 | export default function MyJSXComponent(): import("vue/jsx-runtime").JSX.Element;
2 | 


--------------------------------------------------------------------------------
/src/index.ts:
--------------------------------------------------------------------------------
1 | export { default as build } from './commands/build'
2 | export { default as prepare } from './commands/prepare'
3 | 


--------------------------------------------------------------------------------
/example/src/runtime/components/JsxComponent.tsx:
--------------------------------------------------------------------------------
1 | export default function MyJSXComponent() {
2 |   return <div>My JSX Component</div>
3 | }
4 | 


--------------------------------------------------------------------------------
/example/playground/app.vue:
--------------------------------------------------------------------------------
1 | <template>
2 |   <div>
3 |     Nuxt module playground!
4 |   </div>
5 | </template>
6 | 
7 | <script setup>
8 | </script>
9 | 


--------------------------------------------------------------------------------
/vitest.config.mts:
--------------------------------------------------------------------------------
1 | import { defineConfig } from 'vitest/config'
2 | 
3 | export default defineConfig({
4 |   test: {
5 |     coverage: {},
6 |   },
7 | })
8 | 


--------------------------------------------------------------------------------
/example/tsconfig.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "extends": "./.nuxt/tsconfig.json",
 3 |   "exclude": [
 4 |     "dist",
 5 |     "node_modules",
 6 |     "playground",
 7 |     "../src"
 8 |   ]
 9 | }
10 | 


--------------------------------------------------------------------------------
/pnpm-workspace.yaml:
--------------------------------------------------------------------------------
 1 | packages:
 2 |   - example
 3 |   - example/playground
 4 | 
 5 | ignoredBuiltDependencies:
 6 |   - '@parcel/watcher'
 7 |   - esbuild
 8 |   - unrs-resolver
 9 | 
10 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
 1 | .vscode
 2 | node_modules
 3 | *.log
 4 | .DS_Store
 5 | coverage
 6 | dist
 7 | types
 8 | package-lock.json
 9 | .nuxt
10 | .output
11 | .idea/
12 | example/playground/.nuxtrc
13 | .temp*
14 | 


--------------------------------------------------------------------------------
/test/__snapshots__/JsxComponent.js:
--------------------------------------------------------------------------------
1 | import { jsx } from "vue/jsx-runtime";
2 | export default function MyJSXComponent() {
3 |   return /* @__PURE__ */ jsx("div", { children: "My JSX Component" });
4 | }
5 | 


--------------------------------------------------------------------------------
/example/src/runtime/components/TestMeSetup.vue:
--------------------------------------------------------------------------------
 1 | <script setup lang="ts">
 2 | defineProps<{ count: number }>()
 3 | </script>
 4 | 
 5 | <template>
 6 |   <div>
 7 |     {{ count }}
 8 |   </div>
 9 | </template>
10 | 


--------------------------------------------------------------------------------
/test/__snapshots__/TestMeSetup.vue:
--------------------------------------------------------------------------------
 1 | <script setup>
 2 | defineProps({
 3 |   count: { type: Number, required: true }
 4 | });
 5 | </script>
 6 | 
 7 | <template>
 8 |   <div>
 9 |     {{ count }}
10 |   </div>
11 | </template>
12 | 


--------------------------------------------------------------------------------
/example/src/runtime/composables/useWrappedFetch.ts:
--------------------------------------------------------------------------------
1 | // TODO: investigate how to avoid the need for this import
2 | import type {} from 'ofetch'
3 | import { useFetch } from '#app'
4 | 
5 | export const useWrappedFetch = () => {
6 |   return useFetch('/api/applications')
7 | }
8 | 


--------------------------------------------------------------------------------
/test/__snapshots__/plugin.d.ts:
--------------------------------------------------------------------------------
1 | export type SharedTypeFromRuntime = 'shared-type';
2 | declare const _default: import("nuxt/app").Plugin<{
3 |     injection: "injected";
4 | }> & import("nuxt/app").ObjectPlugin<{
5 |     injection: "injected";
6 | }>;
7 | export default _default;
8 | 


--------------------------------------------------------------------------------
/renovate.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "$schema": "https://docs.renovatebot.com/renovate-schema.json",
 3 |   "extends": [
 4 |     "github>nuxt/renovate-config-nuxt"
 5 |   ],
 6 |   "baseBranches": [
 7 |     "main"
 8 |   ],
 9 |   "lockFileMaintenance": {
10 |     "enabled": true
11 |   }
12 | }
13 | 


--------------------------------------------------------------------------------
/.editorconfig:
--------------------------------------------------------------------------------
 1 | root = true
 2 | 
 3 | [*]
 4 | end_of_line = lf
 5 | insert_final_newline = true
 6 | trim_trailing_whitespace = true
 7 | charset = utf-8
 8 | 
 9 | [*.js]
10 | indent_style = space
11 | indent_size = 2
12 | 
13 | [{package.json,*.yml,*.cjson}]
14 | indent_style = space
15 | indent_size = 2
16 | 


--------------------------------------------------------------------------------
/test/__snapshots__/TestMe.vue:
--------------------------------------------------------------------------------
 1 | <script>
 2 | import { defineComponent } from "vue";
 3 | export default defineComponent({
 4 |   props: {
 5 |     count: {
 6 |       type: Number,
 7 |       required: true
 8 |     }
 9 |   }
10 | });
11 | </script>
12 | 
13 | <template>
14 |   <div>
15 |     {{ count }}
16 |   </div>
17 | </template>
18 | 


--------------------------------------------------------------------------------
/example/src/runtime/plugins/plugin.ts:
--------------------------------------------------------------------------------
 1 | import { defineNuxtPlugin } from '#app'
 2 | 
 3 | export type SharedTypeFromRuntime = 'shared-type'
 4 | 
 5 | export default defineNuxtPlugin(() => {
 6 |   console.log('Plugin injected by my-module!')
 7 |   return {
 8 |     provide: {
 9 |       injection: 'injected' as const,
10 |     },
11 |   }
12 | })
13 | 


--------------------------------------------------------------------------------
/example/src/runtime/components/TestMe.vue:
--------------------------------------------------------------------------------
 1 | <script lang="ts">
 2 | import { defineComponent } from 'vue'
 3 | 
 4 | export default defineComponent({
 5 |   props: {
 6 |     count: {
 7 |       type: Number,
 8 |       required: true,
 9 |     },
10 |   },
11 | })
12 | </script>
13 | 
14 | <template>
15 |   <div>
16 |     {{ count }}
17 |   </div>
18 | </template>
19 | 


--------------------------------------------------------------------------------
/example/playground/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "private": true,
 3 |   "name": "my-module-playground",
 4 |   "scripts": {
 5 |     "test:types": "nuxt prepare && vue-tsc --noEmit"
 6 |   },
 7 |   "dependencies": {
 8 |     "my-module": "workspace:*",
 9 |     "nuxt": "latest"
10 |   },
11 |   "devDependencies": {
12 |     "typescript": "^5.9.3",
13 |     "vue-tsc": "^3.1.7"
14 |   }
15 | }
16 | 


--------------------------------------------------------------------------------
/example/playground/nuxt.config.ts:
--------------------------------------------------------------------------------
 1 | export default defineNuxtConfig({
 2 |   modules: ['my-module'],
 3 |   hooks: {
 4 |     'my-module:init'(sharedType) {
 5 |       // @ts-expect-error invalid assignment
 6 |       const _b: number = sharedType
 7 |     },
 8 |   },
 9 |   myModule: {
10 |     apiKey: '',
11 |     // @ts-expect-error invalid configuration key
12 |     api: '',
13 |   },
14 | })
15 | 


--------------------------------------------------------------------------------
/eslint.config.js:
--------------------------------------------------------------------------------
 1 | // @ts-check
 2 | import { createConfigForNuxt } from '@nuxt/eslint-config/flat'
 3 | 
 4 | export default createConfigForNuxt({
 5 |   features: {
 6 |     tooling: true,
 7 |     stylistic: true,
 8 |   },
 9 |   dirs: {
10 |     src: [
11 |       './example',
12 |       './example/playground',
13 |     ],
14 |   },
15 | }).append({
16 |   ignores: ['test/__snapshots__/*'],
17 | })
18 | 


--------------------------------------------------------------------------------
/.github/workflows/reproduction.yml:
--------------------------------------------------------------------------------
 1 | name: Reproduire
 2 | on:
 3 |   issues:
 4 |     types: [labeled]
 5 | 
 6 | permissions:
 7 |   issues: write
 8 | 
 9 | jobs:
10 |   reproduire:
11 |     runs-on: ubuntu-latest
12 |     steps:
13 |       - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
14 |       - uses: Hebilicious/reproduire@4b686ae9cbb72dad60f001d278b6e3b2ce40a9ac # v0.0.9-mp
15 |         with:
16 |           label: needs reproduction
17 | 


--------------------------------------------------------------------------------
/test/__snapshots__/TestMeSetup.d.vue.ts:
--------------------------------------------------------------------------------
1 | type __VLS_Props = {
2 |     count: number;
3 | };
4 | declare const __VLS_export: import("@vue/runtime-core").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("@vue/runtime-core").ComponentOptionsMixin, import("@vue/runtime-core").ComponentOptionsMixin, {}, string, import("@vue/runtime-core").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import("@vue/runtime-core").ComponentProvideOptions, false, {}, any>;
5 | declare const _default: typeof __VLS_export;
6 | export default _default;
7 | 


--------------------------------------------------------------------------------
/test/__snapshots__/TestMeSetup.vue.d.ts:
--------------------------------------------------------------------------------
1 | type __VLS_Props = {
2 |     count: number;
3 | };
4 | declare const __VLS_export: import("@vue/runtime-core").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("@vue/runtime-core").ComponentOptionsMixin, import("@vue/runtime-core").ComponentOptionsMixin, {}, string, import("@vue/runtime-core").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import("@vue/runtime-core").ComponentProvideOptions, false, {}, any>;
5 | declare const _default: typeof __VLS_export;
6 | export default _default;
7 | 


--------------------------------------------------------------------------------
/.github/workflows/provenance.yml:
--------------------------------------------------------------------------------
 1 | name: ci
 2 | 
 3 | on:
 4 |   push:
 5 |     branches:
 6 |       - main
 7 |   pull_request:
 8 |     branches:
 9 |       - main
10 | permissions:
11 |   contents: read
12 | jobs:
13 |   check-provenance:
14 |     runs-on: ubuntu-latest
15 |     steps:
16 |       - uses: actions/checkout@v6
17 |         with:
18 |           fetch-depth: 0
19 |       - name: Check provenance downgrades
20 |         uses: danielroe/provenance-action@41bcc969e579d9e29af08ba44fcbfdf95cee6e6c # v0.1.1
21 |         with:
22 |           fail-on-provenance-change: true
23 | 


--------------------------------------------------------------------------------
/tsconfig.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "compilerOptions": {
 3 |     "esModuleInterop": true,
 4 |     "skipLibCheck": true,
 5 |     "target": "es2022",
 6 |     "allowJs": true,
 7 |     "resolveJsonModule": true,
 8 |     "moduleDetection": "force",
 9 |     "isolatedModules": true,
10 |     "verbatimModuleSyntax": true,
11 |     "strict": true,
12 |     "noUncheckedIndexedAccess": true,
13 |     "noImplicitOverride": true,
14 |     "module": "Preserve",
15 |     "noEmit": true,
16 |     "moduleResolution": "Bundler",
17 |     "declaration": true
18 |   },
19 |   "include": [
20 |     "src",
21 |   ]
22 | }
23 | 


--------------------------------------------------------------------------------
/example/playground/types.ts:
--------------------------------------------------------------------------------
 1 | import { describe, expectTypeOf, it } from 'vitest'
 2 | import { useNuxtApp } from '#app'
 3 | 
 4 | describe('', () => {
 5 |   it('should have typed injection', () => {
 6 |     expectTypeOf(useNuxtApp().$injection).toEqualTypeOf<'injected'>()
 7 |   })
 8 |   it('should have typed runtime hooks', () => {
 9 |     useNuxtApp().hook('my-module:runtime-hook', () => {})
10 |   })
11 |   it('should have typed runtime config', () => {
12 |     expectTypeOf(useRuntimeConfig().public.NAME).toEqualTypeOf<string>()
13 |     expectTypeOf(useRuntimeConfig().PRIVATE_NAME).toEqualTypeOf<string>()
14 |   })
15 | })
16 | 


--------------------------------------------------------------------------------
/src/commands/_shared.ts:
--------------------------------------------------------------------------------
 1 | import type { ArgDef } from 'citty'
 2 | import { resolve } from 'pathe'
 3 | 
 4 | export const sharedArgs = {
 5 |   // cwd falls back to rootDir's default (indirect default)
 6 |   cwd: {
 7 |     type: 'string',
 8 |     valueHint: 'directory',
 9 |     description: 'Specify the working directory, this takes precedence over ROOTDIR (default: `.`)',
10 |     default: undefined,
11 |   },
12 |   rootDir: {
13 |     type: 'positional',
14 |     description: 'Specifies the working directory (default: `.`)',
15 |     required: false,
16 |     default: '.',
17 |   },
18 | } as const satisfies Record<string, ArgDef>
19 | 
20 | export const resolveCwdArg = (args: { cwd?: string, rootDir?: string }) => resolve(args.cwd || args.rootDir || '.')
21 | 


--------------------------------------------------------------------------------
/test/__snapshots__/TestMe.vue.d.ts:
--------------------------------------------------------------------------------
 1 | declare const __VLS_export: import("@vue/runtime-core").DefineComponent<import("@vue/runtime-core").ExtractPropTypes<{
 2 |     count: {
 3 |         type: NumberConstructor;
 4 |         required: true;
 5 |     };
 6 | }>, {}, {}, {}, {}, import("@vue/runtime-core").ComponentOptionsMixin, import("@vue/runtime-core").ComponentOptionsMixin, {}, string, import("@vue/runtime-core").PublicProps, Readonly<import("@vue/runtime-core").ExtractPropTypes<{
 7 |     count: {
 8 |         type: NumberConstructor;
 9 |         required: true;
10 |     };
11 | }>> & Readonly<{}>, {}, {}, {}, {}, string, import("@vue/runtime-core").ComponentProvideOptions, true, {}, any>;
12 | declare const _default: typeof __VLS_export;
13 | export default _default;
14 | 


--------------------------------------------------------------------------------
/knip.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "$schema": "https://unpkg.com/knip@5/schema.json",
 3 |   "ignore": [
 4 |     "test/__snapshots__/**"
 5 |   ],
 6 |   "workspaces": {
 7 |     ".": {
 8 |       "ignoreDependencies": [
 9 |         "mkdist",
10 |         "vue-sfc-transformer"
11 |       ]
12 |     },
13 |     "example": {
14 |       "entry": [
15 |         "src/module.ts",
16 |         "src/utils.ts",
17 |         "src/runtime/**"
18 |       ],
19 |       "ignoreDependencies": [
20 |         "@nuxt/module-builder"
21 |       ]
22 |     },
23 |     "example/playground": {
24 |       "entry": [
25 |         "providers/custom/index.ts",
26 |         "{components,layouts,pages,plugins,server}/**",
27 |         "{app,error}.vue",
28 |         "layers/**",
29 |         "*.ts"
30 |       ],
31 |       "ignoreDependencies": [
32 |         "my-module"
33 |       ]
34 |     }
35 |   }
36 | }
37 | 


--------------------------------------------------------------------------------
/.github/workflows/release-nightly.yml:
--------------------------------------------------------------------------------
 1 | name: release
 2 | 
 3 | on:
 4 |   pull_request: 
 5 |     branches:
 6 |       - main
 7 |   push:
 8 |     branches:
 9 |       - main
10 | 
11 | permissions: {}
12 | 
13 | jobs:
14 |   release-pkg-pr-new:
15 |     runs-on: ubuntu-latest
16 |     steps:
17 |       - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
18 |       - run: corepack enable
19 |       - uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f # v6.1.0
20 |         with:
21 |           node-version: lts/*
22 |           cache: "pnpm"
23 | 
24 |       - name: Install dependencies
25 |         run: pnpm install
26 | 
27 |       - name: Prepare build environment
28 |         run: pnpm dev:prepare
29 | 
30 |       - run: pnpm build
31 | 
32 |       - name: publish nightly release
33 |         run: pnpm pkg-pr-new publish --compact
34 | 


--------------------------------------------------------------------------------
/example/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "my-module",
 3 |   "license": "MIT",
 4 |   "version": "1.0.0",
 5 |   "type": "module",
 6 |   "exports": {
 7 |     ".": {
 8 |       "types": "./dist/types.d.mts",
 9 |       "default": "./dist/module.mjs"
10 |     },
11 |     "./utils": "./dist/utils.mjs"
12 |   },
13 |   "main": "dist/module.mjs",
14 |   "typesVersions": {
15 |     "*": {
16 |       "utils": [
17 |         "./dist/utils.d.mts"
18 |       ]
19 |     }
20 |   },
21 |   "files": [
22 |     "dist"
23 |   ],
24 |   "scripts": {
25 |     "prepack": "jiti ../src/cli.ts build",
26 |     "dev": "nuxi dev playground",
27 |     "dev:build": "nuxi build playground",
28 |     "dev:prepare": "jiti ../src/cli.ts build --stub && jiti ../src/cli.ts prepare",
29 |     "test:types": "vue-tsc --noEmit"
30 |   },
31 |   "dependencies": {
32 |     "@nuxt/kit": "^4.2.2"
33 |   },
34 |   "devDependencies": {
35 |     "@nuxt/module-builder": "latest",
36 |     "nuxt": "^4.2.2"
37 |   },
38 |   "build": {
39 |     "entries": [
40 |       "./src/utils"
41 |     ]
42 |   }
43 | }
44 | 


--------------------------------------------------------------------------------
/src/cli.ts:
--------------------------------------------------------------------------------
 1 | #!/usr/bin/env node
 2 | import { defineCommand, runMain } from 'citty'
 3 | import type { CommandDef } from 'citty'
 4 | import { consola } from 'consola'
 5 | import { name, description, version } from '../package.json'
 6 | 
 7 | const _rDefault = (r: unknown) => (r && typeof r === 'object' && 'default' in r ? r.default : r) as Promise<CommandDef>
 8 | 
 9 | const main = defineCommand({
10 |   meta: {
11 |     name,
12 |     description,
13 |     version,
14 |   },
15 |   subCommands: {
16 |     prepare: () => import('./commands/prepare').then(_rDefault),
17 |     build: () => import('./commands/build').then(_rDefault),
18 |   },
19 |   setup(context) {
20 |     // TODO: support 'default command' in citty?
21 |     const firstArg = context.rawArgs[0]
22 |     if (context.cmd.subCommands && !(firstArg && firstArg in context.cmd.subCommands)) {
23 |       consola.warn('Please specify the `build` command explicitly. In a future version of `@nuxt/module-builder`, the implicit default build command will be removed.')
24 |       context.rawArgs.unshift('build')
25 |     }
26 |   },
27 | })
28 | 
29 | runMain(main)
30 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2021 - Nuxt Project
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/src/commands/prepare.ts:
--------------------------------------------------------------------------------
 1 | import type { NuxtConfig } from '@nuxt/schema'
 2 | import { defineCommand } from 'citty'
 3 | import { resolve } from 'pathe'
 4 | import { resolveCwdArg, sharedArgs } from './_shared'
 5 | 
 6 | export default defineCommand({
 7 |   meta: {
 8 |     name: 'prepare',
 9 |     description: 'Prepare @nuxt/module-builder environment by writing types and stubs',
10 |   },
11 |   args: {
12 |     ...sharedArgs,
13 |   },
14 |   async run(context) {
15 |     const { runCommand } = await import('@nuxt/cli')
16 | 
17 |     const cwd = resolveCwdArg(context.args)
18 | 
19 |     return runCommand('prepare', [cwd], {
20 |       overrides: {
21 |         compatibilityDate: '2024-04-03',
22 |         typescript: {
23 |           builder: 'shared',
24 |         },
25 |         imports: {
26 |           autoImport: false,
27 |         },
28 |         modules: [
29 |           resolve(cwd, './src/module'),
30 |           function (_options, nuxt) {
31 |             nuxt.hooks.hook('app:templates', (app) => {
32 |               for (const template of app.templates) {
33 |                 template.write = true
34 |               }
35 |             })
36 |           },
37 |         ],
38 |       } satisfies NuxtConfig,
39 |     })
40 |   },
41 | })
42 | 


--------------------------------------------------------------------------------
/example/src/module.ts:
--------------------------------------------------------------------------------
 1 | import { defineNuxtModule, addPlugin, createResolver } from '@nuxt/kit'
 2 | 
 3 | // https://github.com/nuxt/module-builder/issues/242
 4 | import type { SharedTypeFromRuntime } from './runtime/plugins/plugin'
 5 | 
 6 | // Module options TypeScript interface definition
 7 | export interface ModuleOptions {
 8 |   apiKey: string
 9 |   shared?: SharedTypeFromRuntime
10 | }
11 | 
12 | export interface ModuleHooks {
13 |   'my-module:init': (sharedType: SharedTypeFromRuntime) => void
14 | }
15 | 
16 | export interface ModuleRuntimeHooks {
17 |   'my-module:runtime-hook': () => void
18 | }
19 | 
20 | export interface ModulePublicRuntimeConfig {
21 |   NAME: string
22 | }
23 | 
24 | export interface ModuleRuntimeConfig {
25 |   PRIVATE_NAME: string
26 | }
27 | 
28 | export default defineNuxtModule<ModuleOptions>({
29 |   meta: {
30 |     name: 'my-module',
31 |     configKey: 'myModule',
32 |   },
33 |   // Default configuration options of the Nuxt module
34 |   defaults: {
35 |     apiKey: '',
36 |   },
37 |   setup(_options, _nuxt) {
38 |     const resolver = createResolver(import.meta.url)
39 | 
40 |     // @ts-expect-error type should be resolved
41 |     _options.shared = 'not-shared-type'
42 | 
43 |     // Do not add the extension since the `.ts` will be transpiled to `.mjs` after `npm run prepack`
44 |     addPlugin(resolver.resolve('./runtime/plugins/plugin'))
45 |   },
46 | })
47 | 


--------------------------------------------------------------------------------
/.github/needs-reproduction.md:
--------------------------------------------------------------------------------
 1 | Would you be able to provide a [reproduction](https://nuxt.com/docs/community/reporting-bugs/#create-a-minimal-reproduction)? 🙏
 2 | 
 3 | <details>
 4 | <summary>More info</summary>
 5 | 
 6 | ### Why do I need to provide a reproduction?
 7 | 
 8 | Reproductions make it possible for us to triage and fix issues quickly with a relatively small team. It helps us discover the source of the problem, and also can reveal assumptions you or we might be making.
 9 | 
10 | ### What will happen?
11 | 
12 | If you've provided a reproduction, we'll remove the label and try to reproduce the issue. If we can, we'll mark it as a bug and prioritise it based on its severity and how many people we think it might affect.
13 | 
14 | If `needs reproduction` labeled issues don't receive any substantial activity (e.g., new comments featuring a reproduction link), we'll close them. That's not because we don't care! At any point, feel free to comment with a reproduction and we'll reopen it.
15 | 
16 | ### How can I create a reproduction?
17 | 
18 | We have a template for starting with a minimal reproduction:
19 | 
20 | 👉 https://stackblitz.com/github/nuxt/starter/tree/module
21 | 
22 | A public GitHub repository is also perfect. 👌
23 | 
24 | Please ensure that the reproduction is as **minimal** as possible. See more details [in our guide](https://nuxt.com/docs/community/reporting-bugs/#create-a-minimal-reproduction).
25 | 
26 | You might also find these other articles interesting and/or helpful:
27 | 
28 | - [The Importance of Reproductions](https://antfu.me/posts/why-reproductions-are-required)
29 | - [How to Generate a Minimal, Complete, and Verifiable Example](https://stackoverflow.com/help/mcve)
30 | 
31 | </details>
32 | 


--------------------------------------------------------------------------------
/.github/workflows/ci.yml:
--------------------------------------------------------------------------------
 1 | name: ci
 2 | 
 3 | on:
 4 |   push:
 5 |     branches:
 6 |       - main
 7 |   pull_request:
 8 |     branches:
 9 |       - main
10 | 
11 | jobs:
12 |   lint:
13 |     runs-on: ubuntu-latest
14 |     steps:
15 |       - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6
16 |       - run: corepack enable
17 |       - uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f # v6.1.0
18 |         with:
19 |           node-version: 22
20 |           cache: pnpm
21 | 
22 |       - name: 📦 Install dependencies
23 |         run: pnpm install
24 | 
25 |       - run: pnpm dev:prepare
26 | 
27 |       - name: 🔠 Lint project
28 |         run: pnpm lint
29 | 
30 |       - name: ✂️ Knip project
31 |         run: pnpm test:knip
32 | 
33 |       - name: ⚙️ Check package engines
34 |         run: pnpm test:engines
35 | 
36 |       - name: 💪 Check published types
37 |         run: pnpm test:attw
38 | 
39 |       - name: 📦 Check `package.json`
40 |         run: pnpm test:publint
41 | 
42 |   ci:
43 |     strategy:
44 |       matrix:
45 |         os: [ubuntu-latest, windows-latest]
46 |     runs-on: ${{ matrix.os }}
47 |     steps:
48 |       - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6
49 |       - run: corepack enable
50 |       - uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f # v6.1.0
51 |         with:
52 |           node-version: lts/-1
53 |           cache: pnpm
54 | 
55 |       - name: 📦 Install dependencies
56 |         run: pnpm install
57 | 
58 |       - run: pnpm dev:prepare
59 | 
60 |       - name: 🧪 Test project
61 |         run: pnpm test
62 | 
63 |       - name: 🛠 Build project
64 |         run: pnpm build
65 | 
66 |       - name: 🛠 Build project (example)
67 |         run: pnpm example:build
68 | 
69 |       - name: 💪 Type check
70 |         run: pnpm test:types
71 | 


--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "@nuxt/module-builder",
 3 |   "version": "1.0.2",
 4 |   "repository": "nuxt/module-builder",
 5 |   "description": "Complete solution for building Nuxt modules",
 6 |   "license": "MIT",
 7 |   "type": "module",
 8 |   "exports": {
 9 |     ".": "./dist/index.mjs",
10 |     "./package.json": "./package.json"
11 |   },
12 |   "typesVersions": {
13 |     "*": {
14 |       "*": [
15 |         "./dist/*.d.mts"
16 |       ],
17 |       "package.json": [
18 |         "package.json"
19 |       ]
20 |     }
21 |   },
22 |   "bin": {
23 |     "nuxt-build-module": "./dist/cli.mjs",
24 |     "nuxt-module-build": "./dist/cli.mjs"
25 |   },
26 |   "files": [
27 |     "dist"
28 |   ],
29 |   "scripts": {
30 |     "build": "unbuild",
31 |     "dev:prepare": "unbuild --stub && pnpm -r dev:prepare",
32 |     "example:build": "pnpm nuxt-module-build build ./example",
33 |     "example:stub": "pnpm nuxt-module-build build --stub ./example",
34 |     "lint": "eslint .",
35 |     "nuxt-module-build": "JITI_ESM_RESOLVE=1 jiti ./src/cli.ts",
36 |     "prepack": "pnpm build",
37 |     "release": "pnpm vitest run && pnpm build && changelogen --release && pnpm publish && git push --follow-tags",
38 |     "test": "pnpm vitest --coverage",
39 |     "test:attw": "attw --pack example && attw --pack .",
40 |     "test:publint": "cd example && publint",
41 |     "test:engines": "installed-check -d --no-workspaces",
42 |     "test:knip": "knip --exclude unresolved",
43 |     "test:types": "vue-tsc --noEmit && pnpm -r test:types"
44 |   },
45 |   "packageManager": "pnpm@10.25.0",
46 |   "dependencies": {
47 |     "citty": "^0.1.6",
48 |     "consola": "^3.4.2",
49 |     "defu": "^6.1.4",
50 |     "jiti": "^2.6.1",
51 |     "magic-regexp": "^0.10.0",
52 |     "mkdist": "^2.4.1",
53 |     "mlly": "^1.8.0",
54 |     "pathe": "^2.0.3",
55 |     "pkg-types": "^2.3.0",
56 |     "tsconfck": "^3.1.6",
57 |     "unbuild": "^3.6.1",
58 |     "vue-sfc-transformer": "^0.1.17"
59 |   },
60 |   "peerDependencies": {
61 |     "@nuxt/cli": "^3.31.1",
62 |     "typescript": "^5.9.3"
63 |   },
64 |   "devDependencies": {
65 |     "@arethetypeswrong/cli": "^0.18.2",
66 |     "@nuxt/cli": "^3.31.1",
67 |     "@nuxt/eslint-config": "^1.11.0",
68 |     "@nuxt/schema": "^4.2.2",
69 |     "@types/node": "^24.10.1",
70 |     "@types/semver": "^7.7.1",
71 |     "@vitest/coverage-v8": "^4.0.15",
72 |     "changelogen": "^0.6.2",
73 |     "eslint": "^9.39.1",
74 |     "installed-check": "^9.3.0",
75 |     "knip": "^5.72.0",
76 |     "nuxt": "^4.2.2",
77 |     "ofetch": "^1.5.1",
78 |     "pkg-pr-new": "^0.0.62",
79 |     "publint": "^0.3.15",
80 |     "semver": "^7.7.3",
81 |     "tinyexec": "^1.0.2",
82 |     "typescript": "~5.9.3",
83 |     "vitest": "^4.0.15",
84 |     "vue": "^3.5.25",
85 |     "vue-tsc": "^3.1.7"
86 |   },
87 |   "resolutions": {
88 |     "@nuxt/kit": "^4.2.2",
89 |     "@nuxt/module-builder": "workspace:*",
90 |     "@nuxt/schema": "^4.2.2",
91 |     "typescript": "~5.9.3",
92 |     "vue": "^3.5.25",
93 |     "vue-tsc": "^3.1.7"
94 |   },
95 |   "engines": {
96 |     "node": "^18.0.0 || >=20.0.0"
97 |   }
98 | }
99 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | # 📦 Nuxt Module Builder
  2 | 
  3 | [![npm version][npm-version-src]][npm-version-href]
  4 | [![License][license-src]][license-href]
  5 | [![npm downloads][npm-downloads-src]][npm-downloads-href]
  6 | <a href="https://volta.net/nuxt/module-builder?utm_source=nuxt_module_builder_readme"><img src="https://user-images.githubusercontent.com/904724/209143798-32345f6c-3cf8-4e06-9659-f4ace4a6acde.svg" alt="Volta board"></a>
  7 | 
  8 | > The complete solution to build and ship [Nuxt modules](https://nuxt.com/modules).
  9 | 
 10 | ## Features
 11 | 
 12 | - Compatible with Nuxt 3 and Nuxt Kit
 13 | - Unified build with [unjs/unbuild](https://github.com/unjs/unbuild)
 14 | - Automated build config using last module spec
 15 | - Typescript and ESM support
 16 | - Auto generated types and shims for `@nuxt/schema`
 17 | 
 18 | We recommend to checkout the [Nuxt modules author guide](https://nuxt.com/docs/guide/going-further/modules) before starting with the module-builder.
 19 | 
 20 | ## Requirements
 21 | 
 22 | For a user to use a module generated from module-builder, it's recommended they have:
 23 | - Node.js >= 18.x. _Latest Node LTS preferred_
 24 | - Nuxt 3+.
 25 | 
 26 | ## Quick start
 27 | 
 28 | Get started with our [module starter](https://github.com/nuxt/starter/tree/module):
 29 | 
 30 | ```bash
 31 | npm create nuxt -- -t module my-module
 32 | ```
 33 | 
 34 | ## Project structure
 35 | 
 36 | The module builder requires a special project structure. You can check out the [module template](https://github.com/nuxt/starter/tree/module).
 37 | 
 38 | ### `src/module.ts`
 39 | 
 40 | The entrypoint for module definition.
 41 | 
 42 | A default export using `defineNuxtModule` and `ModuleOptions` type export is expected.
 43 | 
 44 | You could also optionally export `ModuleHooks` or `ModuleRuntimeHooks` to annotate any custom hooks the module uses.
 45 | 
 46 | ```ts [src/module.ts]
 47 | import { defineNuxtModule } from '@nuxt/kit'
 48 | 
 49 | export interface ModuleOptions {
 50 |   apiKey: string
 51 | }
 52 | 
 53 | export interface ModuleHooks {
 54 |   'my-module:init': any
 55 | }
 56 | 
 57 | export interface ModuleRuntimeHooks {
 58 |   'my-module:runtime-hook': any
 59 | }
 60 | 
 61 | export interface ModuleRuntimeConfig {
 62 |   PRIVATE_NAME: string
 63 | }
 64 | 
 65 | export interface ModulePublicRuntimeConfig {
 66 |   NAME: string
 67 | }
 68 | 
 69 | export default defineNuxtModule<ModuleOptions>({
 70 |   meta: {
 71 |     name: 'my-module',
 72 |     configKey: 'myModule'
 73 |   },
 74 |   defaults: {
 75 |     apiKey: 'test'
 76 |   },
 77 |   async setup (moduleOptions, nuxt) {
 78 |     // Write module logic in setup function
 79 |   }
 80 | })
 81 | ```
 82 | 
 83 | ### `src/runtime/`
 84 | 
 85 | Any runtime file and code that we need to provide by module including plugins, composables and server api, should be in this directory.
 86 | 
 87 | Each file will be transformed individually using [unjs/mkdist](https://github.com/unjs/mkdist) to `dist/runtime/`.
 88 | 
 89 | <!-- TODO: Docs about how to address runtime from within setup -->
 90 | 
 91 | ### `package.json`:
 92 | 
 93 | A minimum `package.json` should look like this:
 94 | 
 95 | ```json [package.json]
 96 | {
 97 |   "name": "my-module",
 98 |   "license": "MIT",
 99 |   "version": "1.0.0",
100 |   "exports": {
101 |     ".": {
102 |       "types": "./dist/types.d.mts",
103 |       "import": "./dist/module.mjs"
104 |     }
105 |   },
106 |   "main": "./dist/module.mjs",
107 |   "typesVersions": {
108 |     "*": {
109 |       ".": [
110 |         "./dist/types.d.mts"
111 |       ]
112 |     }
113 |   },
114 |   "files": [
115 |     "dist"
116 |   ],
117 |   "scripts": {
118 |     "prepack": "nuxt-module-build build"
119 |   },
120 |   "dependencies": {
121 |     "@nuxt/kit": "latest"
122 |   },
123 |   "devDependencies": {
124 |     "@nuxt/module-builder": "latest"
125 |   }
126 | }
127 | ```
128 | 
129 | ### `build.config.ts` (optional)
130 | 
131 | Module builder is essentially a preset for [unjs/unbuild](https://github.com/unjs/unbuild), check out the [build command](./src/commands/build.ts#L51) for reference.
132 | 
133 | To customize/extend the unbuild configuration you can add a `build.config.ts` in the root of your project:
134 | 
135 | ```ts
136 | import { defineBuildConfig } from 'unbuild'
137 | 
138 | export default defineBuildConfig({
139 |   // set additional configuration or customize using hooks
140 | })
141 | ```
142 | 
143 | ## Dist files
144 | 
145 | Module builder generates dist files in `dist/` directory:
146 | 
147 | - `module.mjs`: Module entrypoint build from `src/module`
148 | - `module.json`: Module meta extracted from `module.mjs` + `package.json`
149 | - `types.d.mts`: Exported types in addition to shims for `nuxt.config` auto completion.
150 | - `runtime/*`: Individually transformed files using [unjs/mkdist](https://github.com/unjs/mkdist)
151 |   - Javascript and `.ts` files will be transformed to `.js` with extracted types on `.d.ts` file with same name
152 |   - `.vue` files will be transformed with extracted `.d.ts` file
153 |   - Other files will be copied as is
154 | 
155 | ## 💻 Development
156 | 
157 | - Clone repository
158 | - Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable`
159 | - Install dependencies using `pnpm install`
160 | - Try building [example module](./example) using `pnpm example:build`
161 | 
162 | ## License
163 | 
164 | [MIT](./LICENSE) - Made with 💚
165 | 
166 | <!-- Badges -->
167 | [npm-version-src]: https://img.shields.io/npm/v/@nuxt/module-builder/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
168 | [npm-version-href]: https://npmjs.com/package/@nuxt/module-builder
169 | 
170 | [npm-downloads-src]: https://img.shields.io/npm/dt/@nuxt/module-builder.svg?style=flat&colorA=18181B&colorB=28CF8D
171 | [npm-downloads-href]: https://npm.chart.dev/@nuxt/module-builder
172 | 
173 | [license-src]: https://img.shields.io/github/license/nuxt/module-builder.svg?style=flat&colorA=18181B&colorB=28CF8D
174 | [license-href]: https://github.com/nuxt/module-builder/blob/main/LICENSE
175 | 


--------------------------------------------------------------------------------
/test/build.spec.ts:
--------------------------------------------------------------------------------
  1 | import { fileURLToPath } from 'node:url'
  2 | import { cp, mkdir, readFile, readdir, rm, writeFile } from 'node:fs/promises'
  3 | import { beforeAll, describe, it, expect } from 'vitest'
  4 | import { exec } from 'tinyexec'
  5 | import { readPackageJSON } from 'pkg-types'
  6 | import { dirname, join } from 'pathe'
  7 | import { findStaticImports } from 'mlly'
  8 | import { version as nuxtVersion } from 'nuxt/package.json'
  9 | import { satisfies } from 'semver'
 10 | import { version } from '../package.json'
 11 | 
 12 | describe('module builder', () => {
 13 |   const rootDir = fileURLToPath(new URL('../example', import.meta.url))
 14 |   const secondRootDir = rootDir.replace('example', '.temp-example-without-options')
 15 |   const distDir = join(rootDir, 'dist')
 16 |   const secondDistDir = join(secondRootDir, 'dist')
 17 |   const runtimeDir = join(distDir, 'runtime')
 18 | 
 19 |   beforeAll(async () => {
 20 |     // Prepare second root directory without type export
 21 |     await mkdir(dirname(secondRootDir), { recursive: true })
 22 |     await rm(secondRootDir, { force: true, recursive: true })
 23 |     await cp(rootDir, secondRootDir, { recursive: true })
 24 |     const moduleSrc = join(secondRootDir, 'src/module.ts')
 25 |     const contents = await readFile(moduleSrc, 'utf-8').then(r => r.replace('export interface ModuleOptions', 'interface ModuleOptions'))
 26 |     await writeFile(moduleSrc, contents)
 27 | 
 28 |     await Promise.all([
 29 |       exec('pnpm', ['dev:prepare'], { nodeOptions: { cwd: rootDir } }).then(() => exec('pnpm', ['prepack'], { nodeOptions: { cwd: rootDir } })),
 30 |       exec('pnpm', ['dev:prepare'], { nodeOptions: { cwd: secondRootDir } }).then(() => exec('pnpm', ['prepack'], { nodeOptions: { cwd: secondRootDir } })),
 31 |     ])
 32 |   }, 120 * 1000)
 33 | 
 34 |   it('should generate all files', async () => {
 35 |     const files = await readdir(distDir)
 36 |     expect(files).toMatchInlineSnapshot(`
 37 |       [
 38 |         "module.d.mts",
 39 |         "module.json",
 40 |         "module.mjs",
 41 |         "runtime",
 42 |         "types.d.mts",
 43 |         "utils.d.mts",
 44 |         "utils.mjs",
 45 |       ]
 46 |     `)
 47 | 
 48 |     const runtime = await readdir(join(runtimeDir, 'plugins'))
 49 |     expect(runtime).toMatchInlineSnapshot(`
 50 |       [
 51 |         "plugin.d.ts",
 52 |         "plugin.js",
 53 |       ]
 54 |     `)
 55 |   })
 56 | 
 57 |   it('should write types to output directory', async () => {
 58 |     const types = await readFile(join(distDir, 'types.d.mts'), 'utf-8')
 59 |     expect(types).toMatchInlineSnapshot(`
 60 |       "import type { ModuleHooks, ModuleRuntimeHooks, ModuleRuntimeConfig, ModulePublicRuntimeConfig } from './module.mjs'
 61 | 
 62 |       declare module '#app' {
 63 |         interface RuntimeNuxtHooks extends ModuleRuntimeHooks {}
 64 |       }
 65 | 
 66 |       declare module '@nuxt/schema' {
 67 |         interface NuxtHooks extends ModuleHooks {}
 68 |         interface RuntimeConfig extends ModuleRuntimeConfig {}
 69 |         interface PublicRuntimeConfig extends ModulePublicRuntimeConfig {}
 70 |       }
 71 | 
 72 |       export { default } from './module.mjs'
 73 | 
 74 |       export { type ModuleHooks, type ModuleOptions, type ModulePublicRuntimeConfig, type ModuleRuntimeConfig, type ModuleRuntimeHooks } from './module.mjs'
 75 |       "
 76 |     `)
 77 |   })
 78 | 
 79 |   it('should generate types when no ModuleOptions are exported', async () => {
 80 |     const types = await readFile(join(secondDistDir, 'types.d.mts'), 'utf-8')
 81 |     expect(types).toMatchInlineSnapshot(`
 82 |       "import type { NuxtModule } from '@nuxt/schema'
 83 | 
 84 |       import type { default as Module, ModuleHooks, ModuleRuntimeHooks, ModuleRuntimeConfig, ModulePublicRuntimeConfig } from './module.mjs'
 85 | 
 86 |       declare module '#app' {
 87 |         interface RuntimeNuxtHooks extends ModuleRuntimeHooks {}
 88 |       }
 89 | 
 90 |       declare module '@nuxt/schema' {
 91 |         interface NuxtHooks extends ModuleHooks {}
 92 |         interface RuntimeConfig extends ModuleRuntimeConfig {}
 93 |         interface PublicRuntimeConfig extends ModulePublicRuntimeConfig {}
 94 |       }
 95 | 
 96 |       export type ModuleOptions = typeof Module extends NuxtModule<infer O> ? Partial<O> : Record<string, any>
 97 | 
 98 |       export { default } from './module.mjs'
 99 | 
100 |       export { type ModuleHooks, type ModulePublicRuntimeConfig, type ModuleRuntimeConfig, type ModuleRuntimeHooks } from './module.mjs'
101 |       "
102 |     `)
103 |   })
104 | 
105 |   it('should generate module metadata as separate JSON file', async () => {
106 |     const meta = await readFile(join(distDir, 'module.json'), 'utf-8')
107 |     const unbuildPkg = await readPackageJSON('unbuild')
108 |     expect(JSON.parse(meta)).toMatchObject(
109 |       {
110 |         builder: {
111 |           '@nuxt/module-builder': version,
112 |           'unbuild': unbuildPkg.version,
113 |         },
114 |         configKey: 'myModule',
115 |         name: 'my-module',
116 |         version: '1.0.0',
117 |       },
118 |     )
119 |   })
120 | 
121 |   it('should generate typed plugin', async () => {
122 |     const pluginDts = await readFile(join(distDir, 'runtime/plugins/plugin.d.ts'), 'utf-8')
123 |     await expect(pluginDts).toMatchFileSnapshot('__snapshots__/plugin.d.ts')
124 |   })
125 | 
126 |   it('should correctly add extensions to imports from runtime/ directory', async () => {
127 |     const moduleDts = await readFile(join(distDir, 'module.d.mts'), 'utf-8')
128 |     const runtimeImport = findStaticImports(moduleDts).find(i => i.specifier.includes('runtime'))
129 |     expect(runtimeImport!.code.trim()).toMatchInlineSnapshot(`"import { SharedTypeFromRuntime } from '../dist/runtime/plugins/plugin.js';"`)
130 |   })
131 | 
132 |   it('should generate components correctly', async () => {
133 |     const componentFile = await readFile(join(distDir, 'runtime/components/TestMe.vue'), 'utf-8')
134 |     await expect(componentFile.replace(/\r\n/g, '\n')).toMatchFileSnapshot('__snapshots__/TestMe.vue')
135 | 
136 |     const componentDeclarationFile = await readFile(join(distDir, 'runtime/components/TestMe.vue.d.ts'), 'utf-8')
137 |     await expect(componentDeclarationFile.replace(/\r\n/g, '\n')).toMatchFileSnapshot('__snapshots__/TestMe.vue.d.ts')
138 |   })
139 | 
140 |   it('should generate components with <script setup> correctly', async () => {
141 |     const componentFile = await readFile(join(distDir, 'runtime/components/TestMeSetup.vue'), 'utf-8')
142 |     await expect(componentFile.replace(/\r\n/g, '\n')).toMatchFileSnapshot('__snapshots__/TestMeSetup.vue')
143 | 
144 |     const componentDeclarationFile = await readFile(join(distDir, 'runtime/components/TestMeSetup.vue.d.ts'), 'utf-8')
145 |     await expect(componentDeclarationFile.replace(/\r\n/g, '\n')).toMatchFileSnapshot('__snapshots__/TestMeSetup.vue.d.ts')
146 | 
147 |     const componentDeclarationFile2 = await readFile(join(distDir, 'runtime/components/TestMeSetup.d.vue.ts'), 'utf-8')
148 |     await expect(componentDeclarationFile2.replace(/\r\n/g, '\n')).toMatchFileSnapshot('__snapshots__/TestMeSetup.d.vue.ts')
149 |   })
150 | 
151 |   it('should generate wrapped composables', async () => {
152 |     const componentFile = await readFile(join(distDir, 'runtime/composables/useWrappedFetch.d.ts'), 'utf-8')
153 |     if (satisfies(nuxtVersion, '^3')) {
154 |       expect(componentFile).toMatchInlineSnapshot(`
155 |         "export declare const useWrappedFetch: () => import("#app").AsyncData<unknown, import("ofetch").FetchError<any> | null>;
156 |         "
157 |       `)
158 |     }
159 |     else {
160 |       expect(componentFile).toMatchInlineSnapshot(`
161 |         "export declare const useWrappedFetch: () => import("nuxt/app").AsyncData<unknown, import("ofetch").FetchError<any> | undefined>;
162 |         "
163 |       `)
164 |     }
165 |   })
166 | 
167 |   it('should handle JSX correctly', async () => {
168 |     const [component, declaration] = await Promise.all([
169 |       readFile(join(distDir, 'runtime/components/JsxComponent.js'), 'utf-8'),
170 |       readFile(join(distDir, 'runtime/components/JsxComponent.d.ts'), 'utf-8'),
171 |     ])
172 |     await expect(component).toMatchFileSnapshot('__snapshots__/JsxComponent.js')
173 |     await expect(declaration).toMatchFileSnapshot('__snapshots__/JsxComponent.d.ts')
174 |   })
175 | })
176 | 


--------------------------------------------------------------------------------
/src/commands/build.ts:
--------------------------------------------------------------------------------
  1 | import { existsSync, promises as fsp } from 'node:fs'
  2 | import { pathToFileURL } from 'node:url'
  3 | import { basename, dirname, extname, join, normalize, resolve } from 'pathe'
  4 | import { filename } from 'pathe/utils'
  5 | import { readPackageJSON } from 'pkg-types'
  6 | import { parse } from 'tsconfck'
  7 | import type { TSConfig } from 'pkg-types'
  8 | import { defu } from 'defu'
  9 | import { createJiti } from 'jiti'
 10 | import { anyOf, createRegExp } from 'magic-regexp'
 11 | import { consola } from 'consola'
 12 | import type { NuxtModule } from '@nuxt/schema'
 13 | import { findExports, resolvePath, findTypeExports } from 'mlly'
 14 | import type { ESMExport } from 'mlly'
 15 | import { defineCommand } from 'citty'
 16 | import { convertCompilerOptionsFromJson } from 'typescript'
 17 | 
 18 | import { name, version } from '../../package.json'
 19 | import { resolveCwdArg, sharedArgs } from './_shared'
 20 | 
 21 | export default defineCommand({
 22 |   meta: {
 23 |     name: 'build',
 24 |     description: 'Build module for distribution',
 25 |   },
 26 |   args: {
 27 |     ...sharedArgs,
 28 |     outDir: {
 29 |       type: 'string',
 30 |       default: 'dist',
 31 |       description: 'Build directory',
 32 |     },
 33 |     sourcemap: {
 34 |       type: 'boolean',
 35 |       default: false,
 36 |       description: 'Generate sourcemaps',
 37 |     },
 38 |     stub: {
 39 |       type: 'boolean',
 40 |       default: false,
 41 |       description: 'Stub dist instead of actually building it for development',
 42 |     },
 43 |   },
 44 |   async run(context) {
 45 |     const { build } = await import('unbuild')
 46 | 
 47 |     const cwd = resolveCwdArg(context.args)
 48 | 
 49 |     const jiti = createJiti(cwd)
 50 | 
 51 |     await build(cwd, false, {
 52 |       declaration: 'node16',
 53 |       sourcemap: context.args.sourcemap,
 54 |       stub: context.args.stub,
 55 |       stubOptions: { absoluteJitiPath: true },
 56 |       outDir: context.args.outDir,
 57 |       entries: [
 58 |         'src/module',
 59 |         {
 60 |           input: 'src/runtime/',
 61 |           outDir: `${context.args.outDir}/runtime`,
 62 |           addRelativeDeclarationExtensions: true,
 63 |           ext: 'js',
 64 |           pattern: [
 65 |             '**',
 66 |             '!**/*.stories.{js,cts,mts,ts,jsx,tsx}', // ignore storybook files
 67 |             '!**/*.{spec,test}.{js,cts,mts,ts,jsx,tsx}', // ignore tests
 68 |           ],
 69 |           esbuild: {
 70 |             jsxImportSource: 'vue',
 71 |             jsx: 'automatic',
 72 |             jsxFactory: 'h',
 73 |           },
 74 |         },
 75 |       ],
 76 |       rollup: {
 77 |         esbuild: {
 78 |           target: 'esnext',
 79 |         },
 80 |         emitCJS: false,
 81 |         cjsBridge: false,
 82 |       },
 83 |       externals: [
 84 |         /dist[\\/]runtime[\\/]/,
 85 |         '@nuxt/schema',
 86 |         '@nuxt/schema-nightly',
 87 |         '@nuxt/schema-edge',
 88 |         '@nuxt/kit',
 89 |         '@nuxt/kit-nightly',
 90 |         '@nuxt/kit-edge',
 91 |         '#app',
 92 |         '#app/nuxt',
 93 |         'nuxt',
 94 |         'nuxt-nightly',
 95 |         'nuxt-edge',
 96 |         'nuxt3',
 97 |         'vue',
 98 |         'vue-demi',
 99 |       ],
100 |       hooks: {
101 |         async 'mkdist:entry:options'(_ctx, entry, options) {
102 |           options.typescript = defu(options.typescript, {
103 |             compilerOptions: await loadTSCompilerOptions(entry.input),
104 |           })
105 |         },
106 |         async 'rollup:options'(ctx, options) {
107 |           const [entry] = ctx.buildEntries
108 |           const mergedCompilerOptions = defu({
109 |             noEmit: false,
110 |             paths: {
111 |               '#app/nuxt': ['./node_modules/nuxt/dist/app/nuxt'],
112 |             },
113 |           }, ctx.options.rollup.dts.compilerOptions, await loadTSCompilerOptions(entry!.path))
114 |           ctx.options.rollup.dts.compilerOptions = convertCompilerOptionsFromJson(mergedCompilerOptions, entry!.path).options
115 |           options.plugins ||= []
116 |           if (!Array.isArray(options.plugins))
117 |             options.plugins = [options.plugins]
118 | 
119 |           const runtimeEntries = ctx.options.entries.filter(entry => entry.builder === 'mkdist')
120 | 
121 |           const runtimeDirs = runtimeEntries.map(entry => basename(entry.input))
122 |           const RUNTIME_RE = createRegExp(anyOf(...runtimeDirs).and(anyOf('/', '\\')))
123 | 
124 |           // Add extension for imports of runtime files in build
125 |           options.plugins.unshift({
126 |             name: 'nuxt-module-builder:runtime-externals',
127 |             async resolveId(id, importer) {
128 |               if (!RUNTIME_RE.test(id))
129 |                 return
130 | 
131 |               const resolved = await this.resolve(id, importer, { skipSelf: true })
132 |               if (!resolved)
133 |                 return
134 | 
135 |               const normalizedId = normalize(resolved.id)
136 |               for (const entry of runtimeEntries) {
137 |                 if (!entry.outDir || !normalizedId.includes(entry.input))
138 |                   continue
139 | 
140 |                 const name = filename(normalizedId) || basename(normalizedId, extname(normalizedId))
141 |                 const distFile = await resolvePath(join(dirname(pathToFileURL(normalizedId).href.replace(entry.input, entry.outDir)), name))
142 |                 if (distFile) {
143 |                   return {
144 |                     external: true,
145 |                     id: distFile,
146 |                   }
147 |                 }
148 |               }
149 |             },
150 |           })
151 |         },
152 |         async 'rollup:done'(ctx) {
153 |           // Load module meta
154 |           const moduleEntryPath = resolve(ctx.options.outDir, 'module.mjs')
155 |           const moduleFn = await jiti.import<NuxtModule<Record<string, unknown>>>(pathToFileURL(moduleEntryPath).toString(), { default: true }).catch((err) => {
156 |             consola.error(err)
157 |             consola.error('Cannot load module. Please check dist:', moduleEntryPath)
158 |             return null
159 |           })
160 | 
161 |           if (!moduleFn) {
162 |             return
163 |           }
164 |           const moduleMeta = await moduleFn.getMeta?.() || {}
165 | 
166 |           // Enhance meta using package.json
167 |           if (ctx.pkg) {
168 |             if (!moduleMeta.name) {
169 |               moduleMeta.name = ctx.pkg.name
170 |             }
171 |             if (!moduleMeta.version) {
172 |               moduleMeta.version = ctx.pkg.version
173 |             }
174 |           }
175 | 
176 |           // Add module builder metadata
177 |           moduleMeta.builder = {
178 |             [name]: version,
179 |             unbuild: await readPackageJSON('unbuild').then(r => r.version).catch(() => 'unknown'),
180 |           }
181 | 
182 |           // Write meta
183 |           const metaFile = resolve(ctx.options.outDir, 'module.json')
184 |           await fsp.writeFile(metaFile, JSON.stringify(moduleMeta, null, 2), 'utf8')
185 | 
186 |           // Generate types
187 |           await writeTypes(ctx.options.outDir, ctx.options.stub)
188 |         },
189 |         async 'build:done'(ctx) {
190 |           const logs = [...ctx.warnings].filter(l => l.startsWith('Potential missing package.json files:'))
191 |           if (logs.filter(l => l.match(/\.d\.ts/)).length > 0) {
192 |             consola.warn(`\`@nuxt/module-builder\` will no longer generate \`.d.ts\` declaration files. You can update these paths to use the \`.d.mts\` extension instead.`)
193 |           }
194 | 
195 |           if (logs.filter(l => l.match(/module\.cjs/)).length > 0) {
196 |             consola.warn(`\`@nuxt/module-builder\` will no longer generate \`module.cjs\` as this is not required for Nuxt v3+. You can safely remove replace this with \`module.mjs\` in your \`package.json\`.`)
197 |           }
198 | 
199 |           const pkg = await readPackageJSON(cwd)
200 |           if (pkg?.types && !existsSync(resolve(cwd, pkg.types))) {
201 |             consola.warn(`Please remove the \`types\` field from package.json as it is no longer required for Bundler TypeScript module resolution. Instead, you can use \`typesVersions\` to support subpath export types for Node10, if required.`)
202 |           }
203 |         },
204 |       },
205 |     })
206 |   },
207 | })
208 | 
209 | async function writeTypes(distDir: string, isStub: boolean) {
210 |   const dtsFile = resolve(distDir, 'types.d.mts')
211 |   if (existsSync(dtsFile)) {
212 |     return
213 |   }
214 | 
215 |   const moduleReExports: ESMExport[] = []
216 |   if (!isStub) {
217 |     // Read generated module types
218 |     const moduleTypesFile = resolve(distDir, 'module.d.mts')
219 |     const moduleTypes = await fsp.readFile(moduleTypesFile, 'utf8').catch(() => '')
220 |     const normalisedModuleTypes = moduleTypes
221 |       // Replace `export { type Foo }` with `export { Foo }`
222 |       .replace(/export\s*\{.*?\}/gs, match => match.replace(/\b(type|interface)\b/g, ''))
223 |     for (const e of findExports(normalisedModuleTypes)) {
224 |       moduleReExports.push(e)
225 |     }
226 |     for (const i of findTypeExports(normalisedModuleTypes)) {
227 |       moduleReExports.push(i)
228 |     }
229 |   }
230 | 
231 |   const appShims: string[] = []
232 |   const schemaShims: string[] = []
233 |   const moduleImports: string[] = []
234 |   const schemaImports: string[] = []
235 |   const moduleExports: string[] = []
236 | 
237 |   const hasTypeExport = (name: string) => isStub || moduleReExports.find(exp => exp.names?.includes(name))
238 | 
239 |   if (!hasTypeExport('ModuleOptions')) {
240 |     schemaImports.push('NuxtModule')
241 |     moduleImports.push('default as Module')
242 |     moduleExports.push(`export type ModuleOptions = typeof Module extends NuxtModule<infer O> ? Partial<O> : Record<string, any>`)
243 |   }
244 | 
245 |   if (hasTypeExport('ModuleHooks')) {
246 |     moduleImports.push('ModuleHooks')
247 |     schemaShims.push('  interface NuxtHooks extends ModuleHooks {}')
248 |   }
249 | 
250 |   if (hasTypeExport('ModuleRuntimeHooks')) {
251 |     moduleImports.push('ModuleRuntimeHooks')
252 |     appShims.push(`  interface RuntimeNuxtHooks extends ModuleRuntimeHooks {}`)
253 |   }
254 | 
255 |   if (hasTypeExport('ModuleRuntimeConfig')) {
256 |     moduleImports.push('ModuleRuntimeConfig')
257 |     schemaShims.push('  interface RuntimeConfig extends ModuleRuntimeConfig {}')
258 |   }
259 |   if (hasTypeExport('ModulePublicRuntimeConfig')) {
260 |     moduleImports.push('ModulePublicRuntimeConfig')
261 |     schemaShims.push('  interface PublicRuntimeConfig extends ModulePublicRuntimeConfig {}')
262 |   }
263 | 
264 |   const dtsContents = `
265 |   ${schemaImports.length ? `import type { ${schemaImports.join(', ')} } from '@nuxt/schema'` : ''}
266 | 
267 | ${moduleImports.length ? `import type { ${moduleImports.join(', ')} } from './module.mjs'` : ''}
268 | 
269 | ${appShims.length ? `declare module '#app' {\n${appShims.join('\n')}\n}\n` : ''}
270 | ${schemaShims.length ? `declare module '@nuxt/schema' {\n${schemaShims.join('\n')}\n}\n` : ''}
271 | ${moduleExports.length ? `\n${moduleExports.join('\n')}` : ''}
272 | ${isStub ? 'export * from "./module.mjs"' : ''}
273 | ${moduleReExports.filter(e => e.type === 'named' || e.type === 'default').map(e => `\nexport { ${e.names.map(n => (n === 'default' ? '' : 'type ') + n).join(', ')} } from '${e.specifier || './module.mjs'}'`).join('\n')}
274 | ${moduleReExports.filter(e => e.type === 'star').map(e => `\nexport * from '${e.specifier || './module.mjs'}'`).join('\n')}
275 | `.trim().replace(/[\n\r]{3,}/g, '\n\n') + '\n'
276 | 
277 |   await fsp.writeFile(dtsFile, dtsContents, 'utf8')
278 | }
279 | 
280 | async function loadTSCompilerOptions(path: string): Promise<NonNullable<TSConfig['compilerOptions']>> {
281 |   const config = await parse(path)
282 |   const resolvedCompilerOptions = config?.tsconfig.compilerOptions || {}
283 | 
284 |   // TODO: this should probably be ported to tsconfck?
285 |   for (const { tsconfig, tsconfigFile } of config.extended || []) {
286 |     for (const alias in tsconfig.compilerOptions?.paths || {}) {
287 |       resolvedCompilerOptions.paths[alias] = resolvedCompilerOptions.paths[alias].map((p: string) => {
288 |         if (!/^\.{1,2}(?:\/|$)/.test(p)) return p
289 | 
290 |         return resolve(dirname(tsconfigFile), p)
291 |       })
292 |     }
293 |   }
294 | 
295 |   return resolvedCompilerOptions
296 | }
297 | 


--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
  1 | # Changelog
  2 | 
  3 | 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.
  4 | 
  5 | ## v1.0.2
  6 | 
  7 | [compare changes](https://github.com/nuxt/module-builder/compare/v1.0.1...v1.0.2)
  8 | 
  9 | ### 🩹 Fixes
 10 | 
 11 | - Use absolute path for jiti stub ([#648](https://github.com/nuxt/module-builder/pull/648))
 12 | 
 13 | ### 🏡 Chore
 14 | 
 15 | - Add explicit semver dep ([ddb5a65](https://github.com/nuxt/module-builder/commit/ddb5a65))
 16 | - Add semver types ([50e3f6b](https://github.com/nuxt/module-builder/commit/50e3f6b))
 17 | 
 18 | ### ✅ Tests
 19 | 
 20 | - Add snapshots for v3 + v4 wrapped fetch ([270779b](https://github.com/nuxt/module-builder/commit/270779b))
 21 | 
 22 | ### 🤖 CI
 23 | 
 24 | - Remove forced corepack installation ([9be288b](https://github.com/nuxt/module-builder/commit/9be288b))
 25 | - Run tests on node 20 ([97e3f47](https://github.com/nuxt/module-builder/commit/97e3f47))
 26 | 
 27 | ### ❤️ Contributors
 28 | 
 29 | - Bobbie Goede <bobbiegoede@gmail.com>
 30 | - Daniel Roe ([@danielroe](https://github.com/danielroe))
 31 | 
 32 | ## v1.0.1
 33 | 
 34 | [compare changes](https://github.com/nuxt/module-builder/compare/v1.0.0...v1.0.1)
 35 | 
 36 | ### 📖 Documentation
 37 | 
 38 | - Add full v1 release notes ([#581](https://github.com/nuxt/module-builder/pull/581), [#582](https://github.com/nuxt/module-builder/pull/582))
 39 | - Update to latest recommendations ([6b30cde](https://github.com/nuxt/module-builder/commit/6b30cde))
 40 | 
 41 | ### ❤️ Contributors
 42 | 
 43 | - Daniel Roe ([@danielroe](https://github.com/danielroe))
 44 | - Connor Pearson ([@cjpearson](https://github.com/cjpearson))
 45 | 
 46 | ## v1.0.0
 47 | 
 48 | [compare changes](https://github.com/nuxt/module-builder/compare/v0.8.4...v1.0.0)
 49 | 
 50 | ### 🚀 Enhancements
 51 | 
 52 | - ⚠️ Upgrade to unbuild v3 ([#447](https://github.com/nuxt/module-builder/pull/447))
 53 | - ⚠️ Remove support for node10 resolution + cjs ([#448](https://github.com/nuxt/module-builder/pull/448))
 54 | - build: Ignore test + story files in runtime/ directory ([#480](https://github.com/nuxt/module-builder/pull/480))
 55 | - Add support for type exports in module re-exports ([#563](https://github.com/nuxt/module-builder/pull/563))
 56 | 
 57 | ### 🩹 Fixes
 58 | 
 59 | - Mark nuxi as optional peerDep ([29a42ae](https://github.com/nuxt/module-builder/commit/29a42ae))
 60 | - Drop @nuxt/kit peer dependency & remove optionality for nuxi ([5936063](https://github.com/nuxt/module-builder/commit/5936063))
 61 | - build: Handle windows path names ([#399](https://github.com/nuxt/module-builder/pull/399))
 62 | - build: Apply resolved tsconfig to dts ([#462](https://github.com/nuxt/module-builder/pull/462))
 63 | - Handle node10 resolution + add attw test ([7309198](https://github.com/nuxt/module-builder/commit/7309198))
 64 | - Update warnings ([6291cbe](https://github.com/nuxt/module-builder/commit/6291cbe))
 65 | - Support more than one line of type exports ([0c0020f](https://github.com/nuxt/module-builder/commit/0c0020f))
 66 | - Split re-exports across multiple lines ([7154a89](https://github.com/nuxt/module-builder/commit/7154a89))
 67 | - Support star exports ([8966047](https://github.com/nuxt/module-builder/commit/8966047))
 68 | 
 69 | ### 📖 Documentation
 70 | 
 71 | - Update example build script ([#359](https://github.com/nuxt/module-builder/pull/359))
 72 | - Update link to downloads count badge (9804e9e)([b9b27c3](https://github.com/nuxt/module-builder/commit/b9b27c3))
 73 | - Describe configuring unbuild ([#440](https://github.com/nuxt/module-builder/pull/440))
 74 | 
 75 | ### 🏡 Chore
 76 | 
 77 | - Use tinyexec in test suite ([7ff8ef1](https://github.com/nuxt/module-builder/commit/7ff8ef1))
 78 | - Fix links ([2e57eb2](https://github.com/nuxt/module-builder/commit/3cd9cd4))
 79 | - Pin typescript until issue with vue-tsc is resolved ([994135d](https://github.com/nuxt/module-builder/commit/994135d))
 80 | - Bump vue-tsc ([e8cb0ef](https://github.com/nuxt/module-builder/commit/e8cb0ef))
 81 | - Bump nuxi version ([5b1f00e](https://github.com/nuxt/module-builder/commit/5b1f00e))
 82 | - Add publint to dev dependencies ([7281ae3](https://github.com/nuxt/module-builder/commit/7281ae3))
 83 | - Set node versions and enable knip ([1a17c0c](https://github.com/nuxt/module-builder/commit/1a17c0c))
 84 | - Stub module before stubbing playground ([b3a513b](https://github.com/nuxt/module-builder/commit/b3a513b))
 85 | - Run install command to relink binaries ([932729e](https://github.com/nuxt/module-builder/commit/932729e))
 86 | - Update command and add builder to workspace ([#482](https://github.com/nuxt/module-builder/pull/482))
 87 | - Add type assertion ([14d7788](https://github.com/nuxt/module-builder/commit/14d7788))
 88 | - Add more type-safe solution + fallback ([66d4231](https://github.com/nuxt/module-builder/commit/66d4231))
 89 | - Add pkg.pr.new for nightly/pr builds ([#573](https://github.com/nuxt/module-builder/pull/573))
 90 | - Bump to latest mkdist and add vue-sfc-transformer ([673152a](https://github.com/nuxt/module-builder/commit/673152a))
 91 | - Update knip config ([c9a28a0](https://github.com/nuxt/module-builder/commit/c9a28a0))
 92 | - Bump `vue-sfc-transformer` version ([3cd9cd4](https://github.com/nuxt/module-builder/commit/3cd9cd4))
 93 | - release: V1.0.0 (b0655d3)([3cd9cd4](https://github.com/nuxt/module-builder/commit/3cd9cd4))
 94 | 
 95 | ### ✅ Tests
 96 | 
 97 | - Await file snapshot assertions ([16930b4](https://github.com/nuxt/module-builder/commit/16930b4))
 98 | - Assert current vue snapshot behaviour ([#444](https://github.com/nuxt/module-builder/pull/444))
 99 | - Update snapshots ([847d150](https://github.com/nuxt/module-builder/commit/847d150))
100 | 
101 | ### 🤖 CI
102 | 
103 | - Don't run publint on windows ([330f412](https://github.com/nuxt/module-builder/commit/330f412))
104 | - Prepare environment in lint step ([5f0f88f](https://github.com/nuxt/module-builder/commit/5f0f88f))
105 | - Force latest corepack ([9d74ce4](https://github.com/nuxt/module-builder/commit/9d74ce4))
106 | 
107 | #### ⚠️ Breaking Changes
108 | 
109 | - ⚠️ Upgrade to unbuild v3 ([#447](https://github.com/nuxt/module-builder/pull/447))
110 | - ⚠️ Remove support for node10 resolution + cjs ([#448](https://github.com/nuxt/module-builder/pull/448))
111 | 
112 | ### ❤️ Contributors
113 | 
114 | - Daniel Roe ([@danielroe](https://github.com/danielroe))
115 | - Dev ([@productdevbook])(https://github.com/productdevbook)
116 | - Bobbie Goede ([@BobbieGoede])(https://github.com/BobbieGoede)
117 | 
118 | ## v0.8.4
119 | 
120 | [compare changes](https://github.com/nuxt/module-builder/compare/v0.8.3...v0.8.4)
121 | 
122 | ### 🩹 Fixes
123 | 
124 | - Remove `nuxt/schema` augment ([2a20ed0](https://github.com/nuxt/module-builder/commit/2a20ed0))
125 | 
126 | ### ❤️ Contributors
127 | 
128 | - Daniel Roe ([@danielroe](http://github.com/danielroe))
129 | 
130 | ## v0.8.3
131 | 
132 | [compare changes](https://github.com/nuxt/module-builder/compare/v0.8.2...v0.8.3)
133 | 
134 | ### 🩹 Fixes
135 | 
136 | - **build:** Handle missing named type exports ([#331](https://github.com/nuxt/module-builder/pull/331))
137 | 
138 | ### ❤️ Contributors
139 | 
140 | - Tobias Diez <code@tobiasdiez.com>
141 | 
142 | ## v0.8.2
143 | 
144 | [compare changes](https://github.com/nuxt/module-builder/compare/v0.8.1...v0.8.2)
145 | 
146 | ### 🔥 Performance
147 | 
148 | - Removed unnecessary hasTypeExport check ([#310](https://github.com/nuxt/module-builder/pull/310))
149 | 
150 | ### 🩹 Fixes
151 | 
152 | - **prepare:** Override `compatibilityDate` ([b9b27c3](https://github.com/nuxt/module-builder/commit/b9b27c3))
153 | 
154 | ### ❤️ Contributors
155 | 
156 | - Daniel Roe ([@danielroe](http://github.com/danielroe))
157 | - Matt ([@matt-clegg](http://github.com/matt-clegg))
158 | 
159 | ## v0.8.1
160 | 
161 | [compare changes](https://github.com/nuxt/module-builder/compare/v0.8.0...v0.8.1)
162 | 
163 | ### 🩹 Fixes
164 | 
165 | - **build:** Export all types in stub mode ([6b1970d](https://github.com/nuxt/module-builder/commit/6b1970d))
166 | 
167 | ### 🏡 Chore
168 | 
169 | - Add @danielroe to code owners ([c39cc75](https://github.com/nuxt/module-builder/commit/c39cc75))
170 | 
171 | ### ❤️ Contributors
172 | 
173 | - Daniel Roe ([@danielroe](http://github.com/danielroe))
174 | 
175 | ## v0.8.0
176 | 
177 | [compare changes](https://github.com/nuxt/module-builder/compare/v0.7.1...v0.8.0)
178 | 
179 | ### 🩹 Fixes
180 | 
181 | - ⚠️  Do not augment nuxt options inside module entry ([#295](https://github.com/nuxt/module-builder/pull/295))
182 | - **build:** Do not export default as a type ([d29337c](https://github.com/nuxt/module-builder/commit/d29337c))
183 | - **build:** Only generate `import type` statement if required ([190bff4](https://github.com/nuxt/module-builder/commit/190bff4))
184 | 
185 | #### ⚠️ Breaking Changes
186 | 
187 | - ⚠️  Do not augment nuxt options inside module entry ([#295](https://github.com/nuxt/module-builder/pull/295))
188 | 
189 | ### ❤️ Contributors
190 | 
191 | - Daniel Roe ([@danielroe](http://github.com/danielroe))
192 | 
193 | ## v0.7.1
194 | 
195 | [compare changes](https://github.com/nuxt/module-builder/compare/v0.7.0...v0.7.1)
196 | 
197 | ### 🩹 Fixes
198 | 
199 | - **build:** Declare `ModuleOptions` in correct place ([#283](https://github.com/nuxt/module-builder/pull/283))
200 | 
201 | ### 📖 Documentation
202 | 
203 | - Update path for runtime js files ([#282](https://github.com/nuxt/module-builder/pull/282))
204 | 
205 | ### ❤️ Contributors
206 | 
207 | - Adam DeHaven ([@adamdehaven](http://github.com/adamdehaven))
208 | - Daniel Roe ([@danielroe](http://github.com/danielroe))
209 | 
210 | ## v0.7.0
211 | 
212 | [compare changes](https://github.com/nuxt/module-builder/compare/v0.6.0...v0.7.0)
213 | 
214 | ### 🚀 Enhancements
215 | 
216 | - Auto generate module options from schema meta ([#33](https://github.com/nuxt/module-builder/pull/33))
217 | 
218 | ### 🩹 Fixes
219 | 
220 | - Use `tsconfck` to resolve tsconfig `compilerOptions` ([#274](https://github.com/nuxt/module-builder/pull/274))
221 | - ⚠️  Use `.js` extension for files in `runtime/` directory ([dbd05bb](https://github.com/nuxt/module-builder/commit/dbd05bb))
222 | - Resolve full path to runtime externals ([#275](https://github.com/nuxt/module-builder/pull/275))
223 | - Include `dist/runtime` in externals list ([0946c04](https://github.com/nuxt/module-builder/commit/0946c04))
224 | 
225 | ### 📖 Documentation
226 | 
227 | - Add `types` condition to export subpath ([#265](https://github.com/nuxt/module-builder/pull/265))
228 | 
229 | ### 🏡 Chore
230 | 
231 | - **release:** V0.6.0 ([f56195e](https://github.com/nuxt/module-builder/commit/f56195e))
232 | - Fix lint issue ([0fe04e8](https://github.com/nuxt/module-builder/commit/0fe04e8))
233 | 
234 | ### ✅ Tests
235 | 
236 | - Add additional test for validity of types shared from runtime ([afc4374](https://github.com/nuxt/module-builder/commit/afc4374))
237 | 
238 | ### 🤖 CI
239 | 
240 | - Adds reproduction workflow ([0dc73bb](https://github.com/nuxt/module-builder/commit/0dc73bb))
241 | 
242 | #### ⚠️ Breaking Changes
243 | 
244 | - ⚠️  Use `.js` extension for files in `runtime/` directory ([dbd05bb](https://github.com/nuxt/module-builder/commit/dbd05bb))
245 | 
246 | ### ❤️ Contributors
247 | 
248 | - Daniel Roe ([@danielroe](http://github.com/danielroe))
249 | - Ricardo Gobbo De Souza ([@ricardogobbosouza](http://github.com/ricardogobbosouza))
250 | - Rgehbt ([@Gehbt](http://github.com/Gehbt))
251 | 
252 | ## v0.6.0
253 | 
254 | [compare changes](https://github.com/nuxt/module-builder/compare/v0.5.5...v0.6.0)
255 | 
256 | ### 🚀 Enhancements
257 | 
258 | - Generate `runtime/` dts based on nuxt `tsconfig` options ([#255](https://github.com/nuxt/module-builder/pull/255))
259 | - Add builder versions to `module.json` ([f8567a3](https://github.com/nuxt/module-builder/commit/f8567a3))
260 | - Support transforming `jsx` ([4841f2e](https://github.com/nuxt/module-builder/commit/4841f2e))
261 | 
262 | ### 🩹 Fixes
263 | 
264 | - ⚠️  Remove support for deprecated `RuntimeModuleHooks` interface ([#228](https://github.com/nuxt/module-builder/pull/228))
265 | - Add `-nightly` versions to externals ([0a88a87](https://github.com/nuxt/module-builder/commit/0a88a87))
266 | - Ignore exporting type if it is not defined ([c308cc5](https://github.com/nuxt/module-builder/commit/c308cc5))
267 | - Mark `runtime/` directory as external ([7a68e1e](https://github.com/nuxt/module-builder/commit/7a68e1e))
268 | 
269 | ### 🏡 Chore
270 | 
271 | - **release:** V0.5.5 ([f158ffa](https://github.com/nuxt/module-builder/commit/f158ffa))
272 | - Dedupe kit/schema/vue versions ([aa0a710](https://github.com/nuxt/module-builder/commit/aa0a710))
273 | - Add root `dev:prepare` command ([c308a68](https://github.com/nuxt/module-builder/commit/c308a68))
274 | - Migrate to eslint v9 ([#250](https://github.com/nuxt/module-builder/pull/250))
275 | - Improve internal type safety and enable strict mode ([78aa088](https://github.com/nuxt/module-builder/commit/78aa088))
276 | - Tweak tsconfig settings ([404aae7](https://github.com/nuxt/module-builder/commit/404aae7))
277 | - Add more type annotations ([ba0614b](https://github.com/nuxt/module-builder/commit/ba0614b))
278 | 
279 | ### ✅ Tests
280 | 
281 | - Update type testing step ([#256](https://github.com/nuxt/module-builder/pull/256))
282 | - Add inline snapshots for `runtime/` transforms ([#257](https://github.com/nuxt/module-builder/pull/257))
283 | - Update snapshot ([a39c183](https://github.com/nuxt/module-builder/commit/a39c183))
284 | 
285 | ### 🎨 Styles
286 | 
287 | - Lint ([c15fd92](https://github.com/nuxt/module-builder/commit/c15fd92))
288 | - Lint ([3b805ec](https://github.com/nuxt/module-builder/commit/3b805ec))
289 | 
290 | #### ⚠️ Breaking Changes
291 | 
292 | - ⚠️  Remove support for deprecated `RuntimeModuleHooks` interface ([#228](https://github.com/nuxt/module-builder/pull/228))
293 | 
294 | ### ❤️ Contributors
295 | 
296 | - Daniel Roe ([@danielroe](http://github.com/danielroe))
297 | 
298 | ## v0.5.5
299 | 
300 | [compare changes](https://github.com/nuxt/module-builder/compare/v0.5.4...v0.5.5)
301 | 
302 | ### 🩹 Fixes
303 | 
304 | - Rename `RuntimeModuleHooks` to `ModuleRuntimeHooks` ([#194](https://github.com/nuxt/module-builder/pull/194))
305 | - Use import with extension in generated `.d.mts` file ([#202](https://github.com/nuxt/module-builder/pull/202))
306 | 
307 | ### 📖 Documentation
308 | 
309 | - Remove reference to `ModulePrivateRuntimeConfig` ([34ee148](https://github.com/nuxt/module-builder/commit/34ee148))
310 | 
311 | ### 🏡 Chore
312 | 
313 | - Add shell emulator for Windows ([#191](https://github.com/nuxt/module-builder/pull/191))
314 | - Fix example `package.json` ([#192](https://github.com/nuxt/module-builder/pull/192))
315 | 
316 | ### ✅ Tests
317 | 
318 | - Add root + module type tests ([#198](https://github.com/nuxt/module-builder/pull/198))
319 | 
320 | ### 🤖 CI
321 | 
322 | - Run tests on node 18 ([81b7b4c](https://github.com/nuxt/module-builder/commit/81b7b4c))
323 | 
324 | ### ❤️ Contributors
325 | 
326 | - Joaquín Sánchez ([@userquin](http://github.com/userquin))
327 | - Bobbie Goede <bobbiegoede@gmail.com>
328 | - Daniel Roe <daniel@roe.dev>
329 | 
330 | ## v0.5.4
331 | 
332 | [compare changes](https://github.com/nuxt/module-builder/compare/v0.5.3...v0.5.4)
333 | 
334 | ### 🚀 Enhancements
335 | 
336 | - Support writing `RuntimeNuxtHooks` types ([#183](https://github.com/nuxt/module-builder/pull/183))
337 | 
338 | ### 🩹 Fixes
339 | 
340 | - Generate explicit type import/exports ([#184](https://github.com/nuxt/module-builder/pull/184))
341 | 
342 | ### 📖 Documentation
343 | 
344 | - Import nuxt composables from #imports ([#186](https://github.com/nuxt/module-builder/pull/186))
345 | 
346 | ### ❤️ Contributors
347 | 
348 | - Bobbie Goede <bobbiegoede@gmail.com>
349 | - Daniel Roe ([@danielroe](http://github.com/danielroe))
350 | 
351 | ## v0.5.3
352 | 
353 | [compare changes](https://github.com/nuxt/module-builder/compare/v0.5.2...v0.5.3)
354 | 
355 | ### 🩹 Fixes
356 | 
357 | - Esnext-compatible output ([#181](https://github.com/nuxt/module-builder/pull/181))
358 | 
359 | ### ❤️ Contributors
360 | 
361 | - Daniel Roe ([@danielroe](http://github.com/danielroe))
362 | 
363 | ## v0.5.2
364 | 
365 | [compare changes](https://github.com/nuxt/module-builder/compare/v0.5.1...v0.5.2)
366 | 
367 | ### 💅 Refactors
368 | 
369 | - Migrate to `citty` ([#169](https://github.com/nuxt/module-builder/pull/169))
370 | 
371 | ### 📖 Documentation
372 | 
373 | - Fix typo ([#174](https://github.com/nuxt/module-builder/pull/174))
374 | 
375 | ### 🏡 Chore
376 | 
377 | - **release:** V0.5.1 ([fc3a760](https://github.com/nuxt/module-builder/commit/fc3a760))
378 | 
379 | ### ❤️ Contributors
380 | 
381 | - Daniel Roe <daniel@roe.dev>
382 | - Pionxzh <spigbbbbb@gmail.com>
383 | 
384 | ## v0.5.1
385 | 
386 | [compare changes](https://github.com/nuxt/module-builder/compare/v0.5.0...v0.5.1)
387 | 
388 | ### 🚀 Enhancements
389 | 
390 | - Support `--sourcemap` option ([#163](https://github.com/nuxt/module-builder/pull/163))
391 | 
392 | ### ❤️ Contributors
393 | 
394 | - Bobbie Goede <bobbiegoede@gmail.com>
395 | 
396 | ## v0.5.0
397 | 
398 | [compare changes](https://github.com/nuxt/module-builder/compare/v0.4.0...v0.5.0)
399 | 
400 | ### 🚀 Enhancements
401 | 
402 | - Expose `prepareModule` function ([76b5654](https://github.com/nuxt/module-builder/commit/76b5654))
403 | - Upgrade to `unbuild@2` ([#161](https://github.com/nuxt/module-builder/pull/161))
404 | 
405 | ### 🏡 Chore
406 | 
407 | - Add type safety to prepare overrides ([9d0804a](https://github.com/nuxt/module-builder/commit/9d0804a))
408 | - Switch to changelogen for release ([ba811da](https://github.com/nuxt/module-builder/commit/ba811da))
409 | 
410 | ### ❤️ Contributors
411 | 
412 | - Daniel Roe <daniel@roe.dev>
413 | - Anthony Fu <anthonyfu117@hotmail.com>
414 | 
415 | ## [0.4.0](https://github.com/nuxt/module-builder/compare/v0.3.1...v0.4.0) (2023-05-26)
416 | 
417 | 
418 | ### Features
419 | 
420 | * add `prepare` command for local types support ([#124](https://github.com/nuxt/module-builder/issues/124)) ([612c6b2](https://github.com/nuxt/module-builder/commit/612c6b29a6bad321764d1b0d48d28ada56677f85))
421 | 
422 | ### [0.3.1](https://github.com/nuxt/module-builder/compare/v0.3.0...v0.3.1) (2023-05-01)
423 | 
424 | 
425 | ### Bug Fixes
426 | 
427 | * extend `nuxt/schema` as well ([796d6ab](https://github.com/nuxt/module-builder/commit/796d6ab161f753b3cce66ebf182f1f46b22f2a7c))
428 | 
429 | ## [0.3.0](https://github.com/nuxt/module-builder/compare/v0.2.1...v0.3.0) (2023-04-11)
430 | 
431 | ### [0.2.1](https://github.com/nuxt/module-builder/compare/v0.2.0...v0.2.1) (2022-11-16)
432 | 
433 | ## [0.2.0](https://github.com/nuxt/module-builder/compare/v0.1.7...v0.2.0) (2022-10-15)
434 | 
435 | 
436 | ### Features
437 | 
438 | * export all module types in `types.d.ts` ([#46](https://github.com/nuxt/module-builder/issues/46)) ([64f3ba5](https://github.com/nuxt/module-builder/commit/64f3ba5e89471fb3dfed0cf83411f90c584f205c))
439 | * support `ModuleRuntimeConfig` and `ModulePublicRuntimeConfig` type exports ([#45](https://github.com/nuxt/module-builder/issues/45)) ([a552495](https://github.com/nuxt/module-builder/commit/a5524952ef09ed3748e46db71b6e989611253076))
440 | * support `outDir` option  ([#37](https://github.com/nuxt/module-builder/issues/37)) ([6453ed0](https://github.com/nuxt/module-builder/commit/6453ed0bc104f7ef167f9f16bc012968d1b9261d))
441 | 
442 | 
443 | ### Bug Fixes
444 | 
445 | * **pkg:** export `./package.json` subpath ([#47](https://github.com/nuxt/module-builder/issues/47)) ([82ab400](https://github.com/nuxt/module-builder/commit/82ab400f236bbc8aacaaddfabb62dcf292d5b698))
446 | 
447 | ### [0.1.7](https://github.com/nuxt/module-builder/compare/v0.1.6...v0.1.7) (2022-01-18)
448 | 
449 | 
450 | ### Bug Fixes
451 | 
452 | * ensure nuxt packages are externalized ([ebad137](https://github.com/nuxt/module-builder/commit/ebad137dea9cc3d45659dc7cdb6446ee81e82e96))
453 | 
454 | ### [0.1.6](https://github.com/nuxt/module-builder/compare/v0.1.5...v0.1.6) (2022-01-17)
455 | 
456 | 
457 | ### Bug Fixes
458 | 
459 | * typo meta.json => module.json ([55863c1](https://github.com/nuxt/module-builder/commit/55863c110af7aea562c3ffb3e4681f9b1b61446b))
460 | 
461 | ### [0.1.5](https://github.com/nuxt/module-builder/compare/v0.1.4...v0.1.5) (2022-01-17)
462 | 
463 | 
464 | ### Bug Fixes
465 | 
466 | * add default export for `types.d.ts` ([885c02f](https://github.com/nuxt/module-builder/commit/885c02f0285679ab437ae3e9b5dca8436a8e84f8))
467 | 
468 | ### [0.1.4](https://github.com/nuxt/module-builder/compare/v0.1.3...v0.1.4) (2022-01-17)
469 | 
470 | 
471 | ### Features
472 | 
473 | * parse `module.d` exports to generate ModuleOptions conditionally ([9cd8282](https://github.com/nuxt/module-builder/commit/9cd828203623d25c325129b0bd2d1fa40470b55a))
474 | * support `--stub` ([746d59b](https://github.com/nuxt/module-builder/commit/746d59bd95ddc3dd63c89db01193c764f6f0bdde))
475 | * support `ModuleHooks` type export ([269ce20](https://github.com/nuxt/module-builder/commit/269ce20b33377707c2e7a9460cdc3403afacb285))
476 | 
477 | ### [0.1.3](https://github.com/nuxt/module-builder/compare/v0.1.2...v0.1.3) (2022-01-17)
478 | 
479 | 
480 | ### Features
481 | 
482 | * generate module.json file ([ac12805](https://github.com/nuxt/module-builder/commit/ac12805b71848d9abbf8daa68a88ede4df5a5c6c))
483 | 
484 | 
485 | ### Bug Fixes
486 | 
487 | * win32 support ([#14](https://github.com/nuxt/module-builder/issues/14)) ([c8ab1ad](https://github.com/nuxt/module-builder/commit/c8ab1ad68c28913aeecf46bf3288ed316e3e1d8e))
488 | 
489 | ### [0.1.2](https://github.com/nuxt/module-builder/compare/v0.1.1...v0.1.2) (2021-12-23)
490 | 
491 | 
492 | ### Bug Fixes
493 | 
494 | * **pkg:** only include dist ([d2ff7e4](https://github.com/nuxt/module-builder/commit/d2ff7e4168363dd4e8a93dc9c909e6f6e07765ff))
495 | 
496 | ### 0.1.1 (2021-12-23)
497 | 
498 | 
499 | ### Features
500 | 
501 | * poc for schema types generation ([4991907](https://github.com/nuxt/module-builder/commit/49919078806b95e8d9bde64b708cb430a3bb09cf))
502 | 
503 | 
504 | ### Bug Fixes
505 | 
506 | * emit cjs stub before validation ([0154bc5](https://github.com/nuxt/module-builder/commit/0154bc51db2246217287c0fba4d9be42955fa306))
507 | * improve types generation ([68c02e6](https://github.com/nuxt/module-builder/commit/68c02e60ab4f504c6b7d078c7e8e5fb13cb81e37))
508 | 


--------------------------------------------------------------------------------