Merge pull request #2790 from ricardogobbosouza/module-register-layout

feat: add layout on module

lib/core/module.js

@@ -71,6 +71,13 @@ module.exports = class ModuleContainer {
     })
   }
 
+  addLayout(template, name) {
+    const { dst, src } = this.addTemplate(template)
+
+    // Add to nuxt layouts
+    this.options.layouts[name || path.parse(src).name] = `./${dst}`
+  }
+
   addServerMiddleware(middleware) {
     this.options.serverMiddleware.push(middleware)
   }

test/fixtures/module/modules/basic/index.js

@@ -8,6 +8,9 @@ module.exports = function basicModule(options, resolve) {
   // Add a plugin
   this.addPlugin(path.resolve(__dirname, 'reverse.js'))
 
+  // Add a layout
+  this.addLayout(path.resolve(__dirname, 'layout.vue'))
+
   // Extend build
   this.extendBuild((config, { isClient, isServer }) => {
     // Do nothing!

test/fixtures/module/modules/basic/layout.vue

@@ -0,0 +1,6 @@
+<template>
+    <div>
+        <h1>Module Layouts</h1>
+        <nuxt />
+    </div>
+</template>

test/fixtures/module/router.js

@@ -5,6 +5,7 @@ Vue.use(Router)
 
 const indexPage = () => import('~/views/index.vue').then(m => m.default || m)
 const aboutPage = () => import('~/views/about.vue').then(m => m.default || m)
+const layoutPage = () => import('~/views/layout.vue').then(m => m.default || m)
 
 export function createRouter() {
   return new Router({
@@ -19,6 +20,11 @@ export function createRouter() {
         path: '/about',
         component: aboutPage,
         name: 'about'
+      },
+      {
+        path: '/layout',
+        component: layoutPage,
+        name: 'layout'
       }
     ]
   })

test/fixtures/module/views/layout.vue

@@ -0,0 +1,10 @@
+<template>
+  <div>
+    Layout on module
+  </div>
+</template>
+<script>
+export default {
+  layout: 'layout'
+}
+</script>

test/module.test.js

@@ -47,6 +47,16 @@ test.serial('Plugin', async t => {
   t.true(html.includes('<h1>TXUN</h1>'), 'plugin works')
 })
 
+test.serial('Layout', async t => {
+  t.true(
+    nuxt.options.layouts.layout.includes('layout'),
+    'layout added to config'
+  )
+
+  const { html } = await nuxt.renderRoute('/layout')
+  t.true(html.includes('<h1>Module Layouts</h1>'), 'layout works')
+})
+
 test.serial('Hooks', async t => {
   t.is(nuxt.__module_hook, 1)
   t.is(nuxt.__renderer_hook, 2)