feat: template improvements

.github/workflows/ci.yml

@@ -3,19 +3,19 @@ name: ci
 on:
   push:
     branches:
-      - master
+      - main
   pull_request:
     branches:
-      - master
+      - main
 
 jobs:
   ci:
     runs-on: ${{ matrix.os }}
 
     strategy:
       matrix:
-        os: [ubuntu-latest, macos-latest, windows-latest]
-        node: [10, 12]
+        os: [ubuntu-latest]
+        node: [14]
 
     steps:
       - uses: actions/setup-node@v1
@@ -25,14 +25,19 @@ jobs:
       - name: checkout
         uses: actions/checkout@master
 
-      - name: cache node_modules
-        uses: actions/cache@v1
+      - name: Get yarn cache directory path
+        id: yarn-cache-dir-path
+        run: echo "::set-output name=dir::$(yarn cache dir)"
+
+      - uses: actions/cache@v2
+        id: yarn-cache
         with:
-          path: node_modules
-          key: ${{ matrix.os }}-node-v${{ matrix.node }}-deps-${{ hashFiles(format('{0}{1}', github.workspace, '/yarn.lock')) }}
+          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
+          key: ${{ matrix.os }}-node-v${{ matrix.node }}-deps-${{ hashFiles('**/yarn.lock') }}
+          restore-keys: |
+            ${{ matrix.os }}-yarn-
 
       - name: Install dependencies
-        if: steps.cache.outputs.cache-hit != 'true'
         run: yarn
 
       - name: Lint

example/nuxt.config.js

@@ -1,5 +1,6 @@
 export default {
   modules: [
+    '@nuxt/typescript-build',
     '../src/module.ts'
   ]
 }

jest.config.js

@@ -8,6 +8,9 @@ module.exports = {
       }
     ]
   },
+  moduleNameMapper: {
+    npm_package: '<rootDir>/src'
+  },
   collectCoverage: true,
-  collectCoverageFrom: ['src/**', '!templates/**']
+  collectCoverageFrom: ['src/**']
 }

package.json

@@ -9,29 +9,37 @@
   ],
   "repository": "github_repo",
   "license": "MIT",
-  "main": "dist/module.js",
-  "types": "dist/module.d.ts",
+  "exports": {
+    ".": {
+      "require": "./dist/module.js",
+      "import": "./dist/module.es.js"
+    },
+    "./templates/*": "./dist/templates/*",
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/module.js",
+  "types": "./dist/module.d.ts",
   "files": [
-    "dist",
-    "templates"
+    "dist"
   ],
   "scripts": {
     "build": "siroc build",
-    "dev": "nuxt-ts example",
+    "dev": "nuxt example",
     "lint": "eslint --ext .js,.ts,.vue .",
-    "release": "yarn build && yarn test && standard-version && git push --follow-tags && npm publish",
-    "test": "yarn lint && jest"
+    "release": "yarn build && yarn lint && yarn test && standard-version && git push --follow-tags && npm publish",
+    "test": "jest"
   },
   "dependencies": {
-    "defu": "^2.0.4"
+    "defu": "latest",
+    "upath": "latest"
   },
   "devDependencies": {
     "@babel/plugin-transform-runtime": "latest",
     "@babel/preset-env": "latest",
     "@babel/preset-typescript": "latest",
     "@nuxt/test-utils": "latest",
     "@nuxt/types": "latest",
-    "@nuxt/typescript-runtime": "latest",
+    "@nuxt/typescript-build": "latest",
     "@nuxtjs/eslint-config-typescript": "latest",
     "@siroc/jest-preset": "latest",
     "@types/jest": "latest",
@@ -40,6 +48,7 @@
     "eslint": "latest",
     "jest": "latest",
     "nuxt-edge": "latest",
+    "playwright": "latest",
     "siroc": "latest",
     "standard-version": "latest"
   },

src/module.ts

@@ -1,27 +1,33 @@
-import { resolve } from 'path'
 import defu from 'defu'
-import { Module } from '@nuxt/types'
+import { extname } from 'upath'
+
+import { Module, NuxtOptions } from '@nuxt/types'
+
+import { name, version } from '../package.json'
 
 export interface ModuleOptions {}
 const DEFAULTS: ModuleOptions = {}
 const CONFIG_KEY = 'myModule'
 
 const nuxtModule: Module<ModuleOptions> = /* async */ function (moduleOptions) {
-  const options = defu<ModuleOptions>(this.options[CONFIG_KEY], moduleOptions, DEFAULTS)
-  // const { nuxt } = this
+  const options = defu(this.options[CONFIG_KEY] /* istanbul ignore next */ || {}, moduleOptions, DEFAULTS)
+
+  const nuxtOptions: NuxtOptions = this.nuxt.options
+  console.log('Normalized & typed Nuxt options available, e.g.', { rootDir: nuxtOptions.rootDir })
 
+  const src = require.resolve('./templates/plugin')
   this.addPlugin({
-    src: resolve(__dirname, '../templates/plugin.js'),
-    fileName: 'myPlugin.js',
+    src,
+    fileName: 'myPlugin' + extname(src),
     options
   })
 }
 
-;(nuxtModule as any).meta = require('../package.json')
+;(nuxtModule as any).meta = { name, version }
 
 declare module '@nuxt/types' {
-  interface NuxtConfig { [CONFIG_KEY]?: ModuleOptions } // Nuxt 2.14+
-  interface Configuration { [CONFIG_KEY]?: ModuleOptions } // Nuxt 2.9 - 2.13
+  interface NuxtConfig { [CONFIG_KEY]?: Partial<ModuleOptions> } // Nuxt 2.14+
+  interface Configuration { [CONFIG_KEY]?: Partial<ModuleOptions> } // Nuxt 2.9 - 2.13
 }
 
 export default nuxtModule

src/templates/plugin.ts

@@ -0,0 +1,8 @@
+import type { Plugin } from '@nuxt/types'
+
+console.log('imported')
+
+export default <Plugin> /* async */ function (ctx, inject) {
+  // Fully typed plugin
+  console.log('loaded', ctx && 'with context', !!inject && 'and with inject')
+}

test/browser.test.js

@@ -9,7 +9,7 @@ describe('module', () => {
 
   test('browser', async () => {
     const page = await createPage('/')
-    const html = await page.getHtml()
+    const html = await page.content()
 
     expect(html).toContain('Works!')
   })

test/module.test.js

@@ -13,8 +13,8 @@ describe('module', () => {
 
   test('should inject plugin', () => {
     expectModuleToBeCalledWith('addPlugin', {
-      src: expect.stringContaining('templates/plugin.js'),
-      fileName: 'myPlugin.js',
+      src: expect.stringMatching(/templates[\\/]plugin/),
+      fileName: expect.stringContaining('myPlugin'),
       options: getNuxt().options.myModule
     })
   })

tsconfig.json

@@ -2,6 +2,7 @@
   "compilerOptions": {
     "strict": true,
     "target": "es2018",
+    "allowJs": true,
     "module": "esnext",
     "lib": [
       "esnext",