@nuxt/module-builder 0.1.2 → 0.1.3

package/README.md

@@ -85,6 +85,20 @@ A minimum `package.json` should look like this:
 }
 ```
 
+## Dist files
+
+Module builder generates dist files in `dist/` directory:
+
+- `module.mjs`: Module entrypoint build from `src/module`
+- `module.json`: Module meta extracted from `module.mjs` + `package.json`
+- `module.cjs`: ESM proxy to allow require module in CommonJS context
+- `types.d.ts`: Exported types in addition to shims for `nuxt.config` auto completion.
+- `runtime/*`: Individually transformed files using [unjs/mkdist](https://github.com/unjs/mkdist)
+  - Javascript and `.ts` files will be transformed to `.mjs` with extracted types on `.d.ts` file with same name
+  - `.vue` files will be transformed with extracted `.d.ts` file
+  - Other files will be copied as as
+
+
 
 ## 💻 Development
 

package/dist/chunks/build.mjs

@@ -1,4 +1,5 @@
-import { existsSync, promises } from 'fs';
+import { promises, existsSync } from 'fs';
+import { pathToFileURL } from 'url';
 import { resolve } from 'pathe';
 import consola from 'consola';
 
@@ -24,7 +25,7 @@ async function buildModule(rootDir) {
       async "rollup:done"(ctx) {
         await writeCJSStub(ctx.options.outDir);
         const moduleEntryPath = resolve(ctx.options.outDir, "module.mjs");
-        const moduleFn = await import(moduleEntryPath).then((r) => r.default || r).catch((err) => {
+        const moduleFn = await import(pathToFileURL(moduleEntryPath).toString()).then((r) => r.default || r).catch((err) => {
           consola.error(err);
           consola.error("Cannot load module. Please check dist:", moduleEntryPath);
           return null;
@@ -33,6 +34,16 @@ async function buildModule(rootDir) {
           return;
         }
         const moduleMeta = await moduleFn.getMeta();
+        if (ctx.pkg) {
+          if (!moduleMeta.name) {
+            moduleMeta.name = ctx.pkg.name;
+          }
+          if (!moduleMeta.version) {
+            moduleMeta.version = ctx.pkg.version;
+          }
+        }
+        const metaFile = resolve(ctx.options.outDir, "module.json");
+        await promises.writeFile(metaFile, JSON.stringify(moduleMeta, null, 2), "utf8");
         await writeTypes(ctx.options.outDir, moduleMeta);
       }
     }
@@ -66,7 +77,8 @@ async function writeCJSStub(distDir) {
   const cjsStub = `module.exports = function(...args) {
   return import('./module.mjs').then(m => m.default.call(this, ...args))
 }
-module.exports.meta = require('../package.json')
+const _meta = module.exports.meta = require('./meta.json')
+module.exports.getMeta = () => Promise.resolve(_meta)
 `;
   await promises.writeFile(cjsStubFile, cjsStub, "utf8");
 }

package/dist/cli.mjs

@@ -1,8 +1,9 @@
-#!/bin/env node
+#!/usr/bin/env node
 import mri from 'mri';
 import { resolve } from 'pathe';
 import { b as buildModule } from './chunks/build.mjs';
 import 'fs';
+import 'url';
 import 'consola';
 
 async function main() {

package/dist/index.mjs

@@ -1,4 +1,5 @@
 export { b as buildModule } from './chunks/build.mjs';
 import 'fs';
+import 'url';
 import 'pathe';
 import 'consola';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nuxt/module-builder",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "Complete solution to build Nuxt Modules",
   "license": "MIT",
   "type": "module",
@@ -35,10 +35,10 @@
   "devDependencies": {
     "@nuxt/kit": "npm:@nuxt/kit-edge@latest",
     "@nuxt/schema": "npm:@nuxt/schema-edge@latest",
-    "@nuxtjs/eslint-config-typescript": "^8.0.0",
-    "@types/mri": "^1.1.1",
-    "eslint": "^8.5.0",
-    "jiti": "^1.12.9",
-    "standard-version": "^9.3.2"
+    "@nuxtjs/eslint-config-typescript": "latest",
+    "@types/mri": "latest",
+    "eslint": "latest",
+    "jiti": "latest",
+    "standard-version": "latest"
   }
 }

package/CHANGELOG.md

@@ -1,23 +0,0 @@
-# Changelog
-
-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.1.2](https://github.com/nuxt/module-builder/compare/v0.1.1...v0.1.2) (2021-12-23)
-
-
-### Bug Fixes
-
-* **pkg:** only include dist ([d2ff7e4](https://github.com/nuxt/module-builder/commit/d2ff7e4168363dd4e8a93dc9c909e6f6e07765ff))
-
-### 0.1.1 (2021-12-23)
-
-
-### Features
-
-* poc for schema types generation ([4991907](https://github.com/nuxt/module-builder/commit/49919078806b95e8d9bde64b708cb430a3bb09cf))
-
-
-### Bug Fixes
-
-* emit cjs stub before validation ([0154bc5](https://github.com/nuxt/module-builder/commit/0154bc51db2246217287c0fba4d9be42955fa306))
-* improve types generation ([68c02e6](https://github.com/nuxt/module-builder/commit/68c02e60ab4f504c6b7d078c7e8e5fb13cb81e37))