NestJS CLI について

NestJS CLIのコマンド一覧

NestJS CLIのコマンド一覧をテーブル形式でまとめました。

NestJS CLIコマンド一覧

コマンド	説明
nest new [project-name]	新しいNestJSプロジェクトを作成します。
nest start	アプリケーションを起動します。 オプション: --watch または -w - ファイル変更を監視して自動再起動します。
nest build	アプリケーションをビルドします。
nest test	単体テストを実行します。 オプション: --watch または -w - テストをウォッチモードで実行します。
nest e2e	エンドツーエンドテストを実行します。
nest lint	コードの静的解析を行います。
nest info	プロジェクトの情報を表示します。
nest update	NestJSの依存関係を更新します。
nest add [library-name]	指定したライブラリをプロジェクトに追加します。
nest eject	デフォルトの設定ファイルをエクスポートします。
nest generate [schematic] [name] または nest g [schematic] [name]	指定したスキーマティックでコードを生成します。

nest generateのスキーマティック一覧

スキーマティック	エイリアス	説明
application	app	新しいアプリケーションを生成します。
class	なし	クラスを生成します。
controller	co	コントローラーを生成します。
decorator	dec	デコレーターを生成します。
filter	f	フィルターを生成します。
gateway	g	ゲートウェイ（WebSocket用）を生成します。
guard	gu	ガードを生成します。
interceptor	in	インターセプターを生成します。
interface	なし	インターフェースを生成します。
middleware	mi	ミドルウェアを生成します。
module	mo	モジュールを生成します。
pipe	pi	パイプを生成します。
provider	なし	プロバイダーを生成します。
resolver	r	リゾルバー（GraphQL用）を生成します。
service	s	サービスを生成します。
library	lib	ライブラリを生成します。
resource	なし	CRUDリソースを生成します。

コマンドの例

• コントローラーの生成

  nest g controller users
  

• サービスの生成

  nest g service users
  

• モジュールの生成

  nest g module users
  

---

補足説明

• オプションの活用: 各コマンドには追加のオプションがあり、詳細な設定やカスタマイズが可能です。
• 公式ドキュメントの参照: 最新の情報や詳細な使い方については、NestJS公式ドキュメントを参照してください。
• 依存関係の管理: nest updateコマンドを使用して、プロジェクトの依存関係を最新の状態に保つことができます。

ご不明な点や追加の質問がありましたら、お気軽にお知らせください。

NestJS CLI について

NestJSのCLI（コマンドラインインターフェース）は、NestJSアプリケーションの開発を効率化するための強力なツールです。
CLIを使用することで、新しいプロジェクトの作成、コードの自動生成、アプリケーションのビルドや実行、テストの実行など、多くのタスクを簡単に行うことができます。

NestJS CLIでできること:

• 新規プロジェクトの作成: シンプルなコマンドで新しいNestJSプロジェクトを初期化できます。
• コードの自動生成: コントローラー、サービス、モジュールなどの基本的な構造を自動生成し、手作業を削減します。
• アプリケーションの実行とビルド: 開発環境での実行や、本番環境向けのビルドを簡単に行えます。
• テストの実行: 単体テストやエンドツーエンドテストをコマンド一つで実行できます。
• 依存関係の管理: プロジェクトの依存関係を最新の状態に保つことができます。
• 設定のエクスポート: デフォルトの設定をカスタマイズするために、設定ファイルをエクスポートできます。

NestJS CLIのコマンドリスト:

1. 新規プロジェクトの作成

   • nest new [project-name]
     新しいNestJSプロジェクトを作成します。

2. アプリケーションの起動

   • nest start
     アプリケーションを起動します。
     • --watch または -w: ファイルの変更を監視して自動的に再起動します。

3. コードの生成

   • nest generate [schematic] [name] または nest g [schematic] [name]
     指定したスキーマティックでコードを生成します。
     • スキーマティックの種類:
       • app または application: 新しいアプリケーションを生成します。
       • class: クラスを生成します。
       • co または controller: コントローラーを生成します。
       • dec または decorator: デコレーターを生成します。
       • f または filter: フィルターを生成します。
       • g または gateway: ゲートウェイを生成します（WebSocket用）。
       • gu または guard: ガードを生成します。
       • in または interceptor: インターセプターを生成します。
       • interface: インターフェースを生成します。
       • mi または middleware: ミドルウェアを生成します。
       • mo または module: モジュールを生成します。
       • pi または pipe: パイプを生成します。
       • provider: プロバイダーを生成します。
       • r または resolver: リゾルバーを生成します（GraphQL用）。
       • s または service: サービスを生成します。
       • lib または library: ライブラリを生成します。
       • resource: CRUDリソースを生成します。

4. アプリケーションのビルド

   • nest build
     アプリケーションをビルドします。

5. テストの実行

   • nest test
     単体テストを実行します。
     • --watch または -w: テストをウォッチモードで実行します。

6. エンドツーエンドテストの実行

   • nest e2e
     エンドツーエンドテストを実行します。

7. Lintの実行

   • nest lint
     コードの静的解析を行います。

8. 情報の表示

   • nest info
     NestJSプロジェクトの情報を表示します。

9. 依存関係の更新

   • nest update
     NestJSの依存関係を更新します。

10. ライブラリの追加

    • nest add [library-name]
      指定したライブラリをプロジェクトに追加します。

11. 設定のエクスポート

    • nest eject
      デフォルトの設定ファイルをエクスポートします。

例:

• コントローラーの生成:

  nest g controller users
  

• サービスの生成:

  nest g service users
  

• モジュールの生成:

  nest g module users
  

補足:

CLIコマンドには多くのオプションがあり、詳細な設定やカスタマイズが可能です。最新の情報や詳細な使い方については、公式ドキュメントを参照してください。