概要

Nightwatch `v2.0` は、プラグインを定義し、独自の カスタムコマンドとアサーションを使用して Nightwatch の基本機能を拡張するための新しいインターフェースを導入しました。

プラグインは、基本的にカスタムコマンドとアサーションのラッパーです。プラグインは `node_modules` フォルダーにインストールされます。

Nightwatch プラグインの作成

NPM パッケージの公開が初めての場合は、まず スコープなしのパブリックパッケージの作成と公開 ガイドをお読みください。

Nightwatch プラグインは、Nightwatch が使用されているのと同じプロジェクトで(またはグローバル NPM パッケージとして)、NPM からインストールする必要があります。

フォルダ構造

フォルダ構造は非常にシンプルで、以下のようになります。カスタムコマンドとアサーションが自動的にロードされるプラグインには、`nightwatch` フォルダーが必要です。

  ├── nightwatch/ 
  |   ├── commands/
  |   |    ├── my_new_custom_command.js
  |   |    └── my_other_custom_command.js
  |   └── assertions/
  |        ├── my_new_custom_assertions.js
  |        └── my_other_custom_command.js
  ├── index.js
  ├── LICENSE.md
  ├── package.json
  └── README.md

上記のようにプラグインが定義されている場合、Nightwatch ランナーはカスタムコマンドとアサーションを**自動的に**取得します。

新しいプラグインのインストール

プラグインが NPM(または他のパッケージリポジトリ)で使用可能になったら、プロジェクトフォルダーにインストールし、`plugins` 配列にそれを追加することで Nightwatch 設定ファイルを更新するだけです。

最初に、NPM からプラグインをインストールします

npm i my-new-plugin --save-dev

次に、`nightwatch.conf.js`(または `nightwatch.json`)を更新し、`plugins` リストに追加します

nightwatch.conf.js
{
  plugins: ['my-new-plugin']
  
// other nightwatch config options
}