@nuxt/module-builder 0.1.1 → 0.1.2

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [0.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)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nuxt/module-builder",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Complete solution to build Nuxt Modules",
   "license": "MIT",
   "type": "module",
@@ -14,6 +14,9 @@
     "nuxt-build-module": "./dist/cli.mjs",
     "nuxt-module-build": "./dist/cli.mjs"
   },
+  "files": [
+    "dist"
+  ],
   "scripts": {
     "build": "unbuild",
     "example:build": "yarn nuxt-module-build ./example",

package/.editorconfig

@@ -1,15 +0,0 @@
-root = true
-
-[*]
-end_of_line = lf
-insert_final_newline = true
-trim_trailing_whitespace = true
-charset = utf-8
-
-[*.js]
-indent_style = space
-indent_size = 2
-
-[{package.json,*.yml,*.cjson}]
-indent_style = space
-indent_size = 2

package/.eslintignore

@@ -1,3 +0,0 @@
-dist
-.nuxt
-.output

package/.eslintrc

@@ -1,5 +0,0 @@
-{
-  "extends": [
-    "@nuxtjs/eslint-config-typescript"
-  ]
-}

package/.github/workflows/ci.yml

@@ -1,23 +0,0 @@
-name: ci
-
-on:
-  push:
-    branches:
-      - main
-  pull_request:
-    branches:
-      - main
-
-jobs:
-  ci:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
-        with:
-          node-version: 16
-          cache: 'yarn'
-      - run: yarn install
-      - run: yarn lint
-      - run: yarn build
-      - run: yarn example:build

package/build.config.ts

@@ -1,9 +0,0 @@
-import { defineBuildConfig } from 'unbuild'
-
-export default defineBuildConfig({
-  declaration: true,
-  entries: [
-    './src/cli',
-    './src/index'
-  ]
-})

package/example/dist/module.cjs

@@ -1,4 +0,0 @@
-module.exports = function(...args) {
-  return import('./module.mjs').then(m => m.default.call(this, ...args))
-}
-module.exports.meta = require('../package.json')

package/example/dist/module.d.ts

@@ -1,8 +0,0 @@
-import * as _nuxt_schema from '@nuxt/schema';
-
-interface ModuleOptions {
-    apiKey: string;
-}
-declare const _default: _nuxt_schema.NuxtModule<ModuleOptions>;
-
-export { ModuleOptions, _default as default };

package/example/dist/module.mjs

@@ -1,15 +0,0 @@
-import { defineNuxtModule } from '@nuxt/kit';
-
-const module = defineNuxtModule({
-  meta: {
-    name: "my-module",
-    configKey2: "myModule"
-  },
-  defaults: {
-    apiKey: null
-  },
-  setup(_options, _nuxt) {
-  }
-});
-
-export { module as default };

package/example/dist/types.d.ts

@@ -1,9 +0,0 @@
-
-import type { ModuleOptions } from './module'
-
-declare module '@nuxt/schema' {
-  interface NuxtConfig { ['my-module']?: Partial<ModuleOptions> }
-  interface NuxtOptions { ['my-module']?: ModuleOptions }
-}
-
-export * from './module'

package/example/dist/utils.d.ts

@@ -1,3 +0,0 @@
-declare const myModuleUtils: () => void;
-
-export { myModuleUtils };

package/example/dist/utils.mjs

@@ -1,4 +0,0 @@
-const myModuleUtils = () => {
-};
-
-export { myModuleUtils };

package/example/package.json

@@ -1,32 +0,0 @@
-{
-  "name": "my-module",
-  "license": "MIT",
-  "version": "1.0.0",
-  "exports": {
-    ".": {
-      "import": "./dist/module.mjs",
-      "require": "./dist/module.cjs"
-    },
-    "./utils": "./dist/utils.mjs"
-  },
-  "main": "./dist/module.cjs",
-  "types": "./dist/types.d.ts",
-  "files": [
-    "dist"
-  ],
-  "scripts": {
-    "prepack": "npm run build"
-  },
-  "dependencies": {
-    "@nuxt/kit": "npm:@nuxt/kit-edge@latest"
-  },
-  "devDependencies": {
-    "@nuxt/module-builder": "latest",
-    "nuxt3": "latest"
-  },
-  "build": {
-    "entries": [
-      "./src/utils"
-    ]
-  }
-}

package/renovate.json

@@ -1,11 +0,0 @@
-{
-  "extends": [
-    "@nuxtjs"
-  ],
-  "baseBranches": [
-    "main"
-  ],
-  "lockFileMaintenance": {
-    "enabled": true
-  }
-}

package/src/build.ts

@@ -1,84 +0,0 @@
-import { existsSync, promises as fsp } from 'fs'
-import { resolve } from 'pathe'
-import consola from 'consola'
-import type { ModuleMeta } from '@nuxt/schema'
-
-export async function buildModule (rootDir: string) {
-  const { build } = await import('unbuild')
-
-  await build(rootDir, false, {
-    declaration: true,
-    entries: [
-      'src/module',
-      { input: 'src/runtime/', outDir: 'dist/runtime', ext: 'mjs' }
-    ],
-    rollup: {
-      emitCJS: false,
-      cjsBridge: true
-    },
-    externals: [
-      '@nuxt/schema',
-      '@nuxt/schema-edge',
-      '@nuxt/kit',
-      '@nuxt/kit-edge'
-    ],
-    hooks: {
-      async 'rollup:done' (ctx) {
-        // Generate CommonJS stup
-        await writeCJSStub(ctx.options.outDir)
-
-        // Load module meta
-        const moduleEntryPath = resolve(ctx.options.outDir, 'module.mjs')
-        const moduleFn = await import(moduleEntryPath).then(r => r.default || r).catch((err) => {
-          consola.error(err)
-          consola.error('Cannot load module. Please check dist:', moduleEntryPath)
-          return null
-        })
-        if (!moduleFn) {
-          return
-        }
-        const moduleMeta = await moduleFn.getMeta()
-
-        // Generate types
-        await writeTypes(ctx.options.outDir, moduleMeta)
-      }
-    }
-  })
-}
-
-async function writeTypes (distDir: string, meta: ModuleMeta) {
-  const dtsFile = resolve(distDir, 'types.d.ts')
-  if (existsSync(dtsFile)) {
-    return
-  }
-
-  const schemaShims = []
-  if (meta.configKey) {
-    schemaShims.push(
-      `  interface NuxtConfig { ['${meta.configKey}']?: Partial<ModuleOptions> }`,
-      `  interface NuxtOptions { ['${meta.configKey}']?: ModuleOptions }`
-    )
-  }
-
-  const dtsContents = `
-import type { ModuleOptions } from './module'
-
-${schemaShims.length ? `declare module '@nuxt/schema' {\n${schemaShims.join('\n')}\n}\n` : ''}
-export * from './module'
-`
-
-  await fsp.writeFile(dtsFile, dtsContents, 'utf8')
-}
-
-async function writeCJSStub (distDir: string) {
-  const cjsStubFile = resolve(distDir, 'module.cjs')
-  if (existsSync(cjsStubFile)) {
-    return
-  }
-  const cjsStub = `module.exports = function(...args) {
-  return import('./module.mjs').then(m => m.default.call(this, ...args))
-}
-module.exports.meta = require('../package.json')
-`
-  await fsp.writeFile(cjsStubFile, cjsStub, 'utf8')
-}

package/src/cli.ts

@@ -1,17 +0,0 @@
-#!/bin/env node
-
-/* eslint-disable no-console */
-import mri from 'mri'
-import { resolve } from 'pathe'
-import { buildModule } from './build'
-
-async function main () {
-  const args = mri(process.argv.slice(2))
-  const rootDir = resolve(args._[0] || '.')
-  await buildModule(rootDir)
-}
-
-main().catch((err) => {
-  console.error(err)
-  process.exit(1)
-})

package/src/index.ts

@@ -1 +0,0 @@
-export * from './build'

package/tsconfig.json

@@ -1,16 +0,0 @@
-{
-  "compilerOptions": {
-    "baseUrl": ".",
-    "target": "ESNext",
-    "module": "ESNext",
-    "moduleResolution": "Node",
-    "esModuleInterop": true,
-    "declaration": true,
-    "types": [
-      "node"
-    ]
-  },
-  "include": [
-    "src"
-  ]
-}