ページ編集

インストール可能なフックの作成

インストール可能なフックは、アプリケーションのnode_modulesフォルダに存在するカスタムSailsフックです。Sailsアプリケーション間で機能を共有する場合、またはNPMにフックを公開してSailsコミュニティと共有する場合に役立ちます。単一のSailsアプリケーションでのみ使用するフックを作成する場合は、代わりにプロジェクトフックの作成を参照してください。

新しいインストール可能なフックを作成するには

新しいフックの名前を選択します。これは、コアフック名と競合してはなりません。
システム上にsails-hook-という名前の新しいフォルダを作成します。sails-hook-プレフィックスはオプションですが、一貫性のために推奨されます。フックがロードされるとSailsによって削除されます。
フォルダ内にpackage.jsonファイルを作成します。システムにnpmがインストールされている場合は、npm initを実行してプロンプトに従うことで簡単にこれを行うことができます。それ以外の場合は、ファイルを手で作成し、少なくとも以下の内容が含まれていることを確認してください。
```
{
 "name": "sails-hook-your-hook-name",
 "version": "0.0.0",
 "description": "a brief description of your hook",
 "main": "index.js",
 "sails": {
   "isHook": true
 }
}
```
npm initを使用してpackage.jsonを作成する場合は、後でファイルを開いてisHook: trueを含むsailsキーを手動で挿入してください。
フック仕様に従って、index.jsにフックコードを記述します。

新しいフォルダには他のファイルも含まれている可能性があり、それらはrequireを使用してフック内でロードできます。index.jsのみがSailsによって自動的に読み取られます。フックを動作させるためにインストールする必要がある依存関係を参照するには、package.jsonのdependenciesキーを使用します（npm install --saveを使用して、依存関係情報をpackage.jsonに簡単に保存することもできます）。

Sailsがフックに使用する内部名の指定（上級者向け）

特に、コアSailsフックをオーバーライドするためにスコープ付きNPMパッケージを使用する場合、フックのロード時にSailsが内部的に使用する名前を変更したい場合があります。これには、package.jsonファイルでsails.hookName構成オプションを使用できます。値は、sails.hooks辞書にロードする必要がある名前であるため、一般的にsails-hooks-プレフィックスは必要ありません。たとえば、コアsails-hook-socketsモジュールをオーバーライドするために使用するモジュール@mycoolhooks/sails-hook-socketsがある場合、package.jsonは次のようになります。

{
    "name": "@mycoolhooks/sails-hook-sockets",
    "version": "0.0.0",
    "description": "my own sockets hook",
    "main": "index.js",
    "sails": {
      "isHook": true,
      "hookName": "sockets"
    }
}

新しいフックのテスト

インストール可能なフックを他の人に配布する前に、テストを作成する必要があります。これにより、将来のSailsバージョンとの互換性が確保され、怒りの発作による髪の毛の抜けることや周辺物の破壊が大幅に減少します。テストの完全なガイドは、このドキュメントの範囲外ですが、次の手順に従うと開始するのに役立ちます。

フックのpackage.jsonファイルにSailsをdevDependencyとして追加します。
```
"devDependencies": {
   "sails": "~0.11.0"
}
```
npm install sailsまたはnpm link sails（システムにSailsがグローバルにインストールされている場合）を使用して、フックの依存関係としてSailsをインストールします。
まだインストールしていない場合は、npm install -g mochaを使用して、システムにMochaをインストールします。
フックのメインフォルダ内にtestフォルダを追加します。

次の基本テストを含むbasic.jsファイルを追加します。

var Sails = require('sails').Sails;

 describe('Basic tests ::', function() {

     // Var to hold a running sails app instance
     var sails;

     // Before running any tests, attempt to lift Sails
     before(function (done) {

         // Hook will timeout in 10 seconds
         this.timeout(11000);

         // Attempt to lift sails
         Sails().lift({
           hooks: {
             // Load the hook
             "your-hook-name": require('../'),
             // Skip grunt (unless your hook uses it)
             "grunt": false
           },
           log: {level: "error"}
         },function (err, _sails) {
           if (err) return done(err);
           sails = _sails;
           return done();
         });
     });

     // After tests are complete, lower Sails
     after(function (done) {

         // Lower Sails (if it successfully lifted)
         if (sails) {
             return sails.lower(done);
         }
         // Otherwise just return
         return done();
     });

     // Test that Sails can lift with the hook in place
     it ('sails does not crash', function() {
         return true;
     });

 });

mocha -R specを実行して、完全な結果を確認します。
Mochaのドキュメントを参照してください。

フックの公開

フックがテストされ、問題ない場合、またフック名が別のNPMモジュールによって既に使用されていない場合は、npm publishを実行して世界と共有できます。おめでとうございます！

何か不足していますか？

見落とした点や改善できる点がある場合は、このリンクに従って、Sailsリポジトリにプルリクエストを送信してください。マージされると、次回のウェブサイトのデプロイ時に変更が反映されます。

ドキュメント

概念

愛情を込めて作成

Sailsフレームワークは、テキサス州オースティンのウェブ＆モバイルショップが、貢献者たちの助けを借りて作成されました。2012年にNode.jsプロジェクトを支援するためにSailsを作成しました。当然のことながら、オープンソース化しました。皆様の生活が少しでも楽になることを願っています！