カスタムジェネレータ
概要
カスタムジェネレータは、Sailsコマンドライン用のプラグインの一種です。テンプレートを通して、sails newまたはsails generateを実行したときに、Sailsプロジェクトで生成されるファイルとそのファイルの外観を制御します。
ジェネレータの作成
作業を容易にするために、最初にSailsプロジェクトを作成しましょう。まだ作成していない場合は、ターミナルに行ってタイプします
sails new my-project
次に、my-projectにcdして、Sailsに新しいジェネレータのテンプレートを出力させます
sails generate generator awesome
ジェネレータの設定
ジェネレータを有効にするには、テストプロジェクトの.sailsrcファイルを使用して、Sailsにそのジェネレータを伝える必要があります。
既存のジェネレータを使用している場合は、NPMからインストールし、.sailsrcでパッケージの名前を指定すればよいのですが、このジェネレータをローカルで開発している場合は、フォルダーに直接接続するだけです
{
"generators": {
"modules": {
"awesome": "./my-project/awesome"
}
}
}
注意:とりあえずは「awesome」のままにしておきますが、任意の名前でジェネレータをマウントできます。
.sailsrcファイルのキーの名前として選択した名前は、ターミナルからこのジェネレータを実行するために使用する名前になります（例:sails generate awesome）。
カスタムジェネレータの実行
ジェネレータを実行するには、sails generateにジェネレータの名前を付け、目的の引数またはコマンドラインオプションを続けるとよいでしょう。たとえば、
sails generate awesome
NPMへの公開
ジェネレータが複数のプロジェクトで役立つ場合は、NPMパッケージとして公開することを検討してください（ただし、これによってジェネレータがオープンソースになるわけではありません。NPMはプライベートパッケージもサポートしています）。
まず、package.jsonファイルを開き、パッケージ名（例: "@my-npm-name/sails-generate-awesome"）、作成者（"My Name"）、ライセンスなどの情報が正しいことを確認します。不明な場合は、「MIT」という優れたオープンソースライセンスの使用を検討してください。プライベートジェネレータを公開し、組織の所有物として保持したい場合は、「UNLICENSED」を使用します。
注意:NPMアカウントがまだない場合は、npmjs.comにアクセスしてアカウントを作成します。次に
npm loginを使用してセットアップします。
NPMにジェネレータを公開するための準備が整ったら、ターミナルでジェネレータのフォルダーにcdして、以下を入力します
npm publish
ジェネレータのインストール
新しく公開したジェネレータを試すには、例に挙げたSailsプロジェクト（my-project）に戻り、インラインジェネレータを削除して、以下を実行します
npm install @my-npm-name/sails-generate-awesome
次に、例に挙げたSailsプロジェクトの.sailsrc（my-project/.sailsrc）を変更します
{
"generators": {
"modules": {
"awesome": "@my-npm-name/sails-generate-awesome"
}
}
}
そして、最後になりますが
sails generate awesome
sailsjs.comの体験を向上させるために、ブラウザを更新してください。
コンセプト
愛情込めて制作
Sails フレームワークは、テキサス州オースティンにある Web & モバイルショップ とコントリビューターの協力により構築されました。当社は 2012 年に Node.js のプロジェクトを支援するために Sails を作成しました。当然、オープンソース化しました。皆さんの生活が少しでも楽になれば幸いです！
© 2012-2024 The Sails Company。
Sails フレームワークは MIT ライセンスの下で提供される無料のオープンソースです。
イラスト: Edamame