@nuxt/module-builder 0.2.1 → 0.3.1

package/README.md

@@ -1,22 +1,24 @@
 # 📦 Nuxt Module Builder
 
-> Complete solution to build Nuxt Modules.
+[![npm version][npm-version-src]][npm-version-href]
+[![License][license-src]][license-href]
+[![npm downloads][npm-downloads-src]][npm-downloads-href]
+<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>
+
+> The complete solution to build and ship [Nuxt modules](https://nuxt.com/modules).
 
 ## Features
 
-- Unified build with [unjs/unbuild](https://github.com/unjs/unbuild)
 - Compatible with Nuxt 3 and Nuxt Kit
+- Unified build with [unjs/unbuild](https://github.com/unjs/unbuild)
 - Automated build config using last module spec
 - Typescript and ESM support
 - Auto generated CommonJS stubs
 - Auto generated types and shims for `@nuxt/schema`
 
+We recommend to checkout the [Nuxt modules author guide](https://nuxt.com/docs/guide/going-further/modules) before starting with the module-builder.
 
-## Learn More
-
-Check the new [Guide for Nuxt Modules](https://v3.nuxtjs.org/docs/advanced/modules/) before starting with module-builder.
-
-### Requirements
+## Requirements
 
 For a user to use a module generated from module-builder, it's recommended they have:
 - Node.js >= 14.x. _Latest Node LTS preferred_
@@ -24,19 +26,19 @@ For a user to use a module generated from module-builder, it's recommended they
 
 ## Quick start
 
-You can quickly get started with the pre-configured [module starter](https://github.com/nuxt/starter/tree/module):
+Get started with our [module starter](https://github.com/nuxt/starter/tree/module):
 
 ```bash
-$ npx nuxi init -t module my-module
+npx nuxi init -t module my-module
 ```
 
 ## Project structure
 
-Using module builder, requires a special project setup. You can check an example [here](./example).
+The module builder requires a special project structur. You can checkout the [module template](https://github.com/nuxt/starter/tree/module).
 
 ### `src/module.ts`
 
-This is the entrypoint for module definition.
+The entrypoint for module definition.
 
 A default export using `defineNuxtModule` and `ModuleOptions` type export is expected.
 
@@ -138,3 +140,15 @@ Module builder generates dist files in `dist/` directory:
 ## License
 
 [MIT](./LICENSE) - Made with 💚
+
+
+<!-- Badges -->
+[npm-version-src]: https://img.shields.io/npm/v/@nuxt/module-builder/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
+[npm-version-href]: https://npmjs.com/package/@nuxt/module-builder
+
+[npm-downloads-src]: https://img.shields.io/npm/dt/@nuxt/module-builder.svg?style=flat&colorA=18181B&colorB=28CF8D
+[npm-downloads-href]: https://npmjs.com/package/@nuxt/module-builder
+
+[license-src]: https://img.shields.io/github/license/nuxt/module-builder.svg?style=flat&colorA=18181B&colorB=28CF8D
+[license-href]: https://github.com/nuxt/module-builder/blob/main/LICENSE
+

package/dist/cli.d.ts

@@ -1 +1,2 @@
 
+export { }

package/dist/cli.mjs

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 import mri from 'mri';
 import { resolve } from 'pathe';
-import { b as buildModule } from './shared/module-builder.4bb3ed8c.mjs';
+import { b as buildModule } from './shared/module-builder.0966342c.mjs';
 import 'fs';
 import 'url';
 import 'consola';

package/dist/index.mjs

@@ -1,4 +1,4 @@
-export { b as buildModule } from './shared/module-builder.4bb3ed8c.mjs';
+export { b as buildModule } from './shared/module-builder.0966342c.mjs';
 import 'fs';
 import 'url';
 import 'pathe';

package/dist/shared/{module-builder.4bb3ed8c.mjs → module-builder.0966342c.mjs}

@@ -94,6 +94,10 @@ ${schemaShims.length ? `declare module '@nuxt/schema' {
 ${schemaShims.join("\n")}
 }
 ` : ""}
+${schemaShims.length ? `declare module 'nuxt/schema' {
+${schemaShims.join("\n")}
+}
+` : ""}
 
 export { ${typeExports[0].names.join(", ")} } from './module'
 `;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nuxt/module-builder",
-  "version": "0.2.1",
+  "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": "^2.15.3",
-    "mlly": "^1.0.0",
+    "consola": "^3.1.0",
+    "mlly": "^1.2.0",
     "mri": "^1.2.0",
-    "pathe": "^1.0.0",
-    "unbuild": "^1.0.1"
+    "pathe": "^1.1.0",
+    "unbuild": "^1.2.1"
   },
   "devDependencies": {
-    "@nuxt/kit": "^3.0.0-rc.13",
-    "@nuxt/schema": "^3.0.0-rc.13",
-    "@nuxtjs/eslint-config-typescript": "^11.0.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.11.9",
-    "eslint": "^8.27.0",
-    "jiti": "^1.16.0",
-    "nuxt": "^3.0.0-rc.13",
-    "standard-version": "^9.5.0"
+    "@types/node": "^18.16.3",
+    "@vitest/coverage-c8": "^0.30.1",
+    "eslint": "^8.39.0",
+    "jiti": "^1.18.2",
+    "nuxt": "^3.4.3",
+    "standard-version": "^9.5.0",
+    "vitest": "^0.30.1"
   }
 }