モジュールディレクトリ

export default {
  modules: [
    // 使うパッケージ名
    '@nuxtjs/axios',

    // プロジェクトのソースディレクトリの相対パス
    '~/modules/awesome.js',

    // オプションの提供
    ['@nuxtjs/google-analytics', { ua: 'X1234567' }],

    // インライン定義
    function () {}
  ]
}

export default {
  exampleMsg: 'hello',
  modules: [
    // シンプルな使い方
    '~/modules/example',
    // オプションを直接渡す
    ['~/modules/example', { token: '123' }]
  ]
}

export default function ExampleModule(moduleOptions) {
  console.log(moduleOptions.token) // '123'
  console.log(this.options.exampleMsg) // 'hello'

  this.nuxt.hook('ready', async nuxt => {
    console.log('Nuxt is ready')
  })
}

// モジュールを npm パッケージとして公開する場合は必須
module.exports.meta = require('./package.json')

export default {
  modules: [['@nuxtjs/axios', { anotherOption: true }]],

  // axios モジュールは `this.options.axios` を使ってこのオプションを認識します
  axios: {
    option1,
    option2
  }
}

export default function (moduleOptions) {
  // `options` には option1、option2、anotherOption が含まれます
  const options = Object.assign({}, this.options.axios, moduleOptions)

  // ...
}

export default function (moduleOptions) {
  if (moduleOptions.fontAwesome !== false) {
    // Font Awesome を追加
    this.options.css.push('font-awesome/css/font-awesome.css')
  }
}

export default function (moduleOptions) {
  const info = 'Built by awesome module - 1.3 alpha on ' + Date.now()

  this.options.build.plugins.push({
    apply(compiler) {
      compiler.plugin('emit', (compilation, cb) => {
        // info 変数の内容を含む `.nuxt/dist/info.txt` が生成されます。
        // ソースもバッファにすることができます
        compilation.assets['info.txt'] = {
          source: () => info,
          size: () => info.length
        }

        cb()
      })
    }
  })
}

nuxt.hook('ready', async nuxt => {
  // カスタムコードはここに記述する
})

nuxt.hook('error', async error => {
  // カスタムコードはここに記述する
})

nuxt.hook('close', async nuxt => {
  // カスタムコードはここに記述する
})

nuxt.hook('listen', async (server, { host, port }) => {
  // カスタムコードはここに記述する
})

export default function myModule() {
  this.nuxt.hook('modules:done', moduleContainer => {
    // これはすべてのモジュールのロードが終了したときに呼び出されます
  })

  this.nuxt.hook('render:before', renderer => {
    // レンダラが作成された後に呼び出されます
  })

  this.nuxt.hook('build:compile', async ({ name, compiler }) => {
    // コンパイラ（デフォルト: webpack）が起動する前に呼び出されます
  })

  this.nuxt.hook('generate:before', async generator => {
    // これは Nuxt がページを生成する前に呼び出されます
  })
}

import Vue from 'vue'
import BootstrapVue from 'bootstrap-vue/dist/bootstrap-vue.esm'

Vue.use(BootstrapVue)

import path from 'path'

export default function nuxtBootstrapVue(moduleOptions) {
  // `plugin.js` テンプレートを登録する
  this.addPlugin(path.resolve(__dirname, 'plugin.js'))
}

// Google Analytics の UA を設定
ga('create', '<%= options.ua %>', 'auto')

<% if (options.debug) { %>
// 開発向けのコードのみ
<% } %>

import path from 'path'

export default function nuxtGoogleAnalytics(moduleOptions) {
  // `plugin.js` テンプレートを登録する
  this.addPlugin({
    src: path.resolve(__dirname, 'plugin.js'),
    options: {
      // プラグインをプロジェクトにコピーするとき Nuxt は `options.ua` を `123` に置き換えます
      ua: 123,

      // dev を含む条件付きパーツは本番ビルドのプラグインコードから削除されます
      debug: this.options.dev
    }
  })
}

export default function (moduleOptions) {
    this.extendBuild((config, { isClient, isServer }) => {
      // `.foo` ローダー
      config.module.rules.push({
        test: /\.foo$/,
        use: [...]
      })

      // 既存のローダーをカスタマイズします
      // Nuxt 内部のソースコードを参照してください：
      // https://github.com/nuxt/nuxt/blob/2.x-dev/packages/webpack/src/config/base.js
      const barLoader = config.module.rules.find(rule => rule.loader === 'bar-loader')
  })
}

import fse from 'fs-extra'

export default async function asyncModule() {
  // ここで `async`/`await` を使って非同期作業が行えます
  const pages = await fse.readJson('./pages.json')
}

export default function asyncModule($http) {
  return $http
    .get('https://jsonplaceholder.typicode.com/users')
    .then(res => res.data.map(user => '/users/' + user.username))
    .then(routes => {
      // Nuxt ルートを拡張して何かをする
    })
}

module.exports.meta = require('./package.json')

export default {
  buildModules: ['@nuxtjs/eslint-module']
}