Node.js と Docker Compose
Docker Compose(英語) は、マルチコンテナーアプリケーションを実行するために使用されます。 例: Web サーバー、バックエンドデータベース、アプリケーションコードを個別のサービスとして実行できます。 必要に応じてコンテナーを追加することで各サービスを拡張できます。 これにより、本番環境と同様に、動的な環境で効率的な開発とテストを実行できます。
始める前
JavaScript と TypeScript および Docker の必要なプラグインが 設定 | プラグイン ページ、タブ インストール済み で有効になっていることを確認してください。 詳細については、 プラグインの管理を参照してください。
JetBrains マーケットプレイスからプラグインをインストールする説明に従って、 設定 | プラグイン ページの マーケットプレース タブに Node.js、 Node.js リモートインタープリター、 JavaScript Debugger プラグインをインストールしてください。 プラグインは PyCharm Pro でのみ利用できます。
Docker をダウンロード、インストールし、 Docker の説明に従って設定してください。
Docker Compose で Node.js ランタイムを構成する
Docker の Node.js ランタイムは、 Configure Node.js Remote Runtime ダイアログで設定します。 このダイアログは、 設定 ダイアログの JavaScript ランタイムページから、またはそれ以降にアプリケーションの実行またはデバッグのために Node.js の実行 / デバッグ構成を作成または編集するを実行する際に開くことができます。
推奨される方法は、 設定 ダイアログでリモート Node.js ランタイムを設定することです。 この場合、ランタイムと関連するパッケージマネージャーをプロジェクトのデフォルトとして設定できます。 これにより、Docker で設定された Node.js ランタイムを使用してアプリを実行およびデバッグできるだけでなく、プロジェクトの依存関係の管理、テストの実行、コードのリンティングも実行できるようになります。 以下の npm、pnpm、yarn と Docker、 アプリケーションをテストする、 Docker を使用した ESLint を参照してください。
Node.js 実行 / デバッグ構成で直接構成したリモート Node.js ランタイムは、この実行 / デバッグ構成でのみ使用できます。
設定 ダイアログ（Ctrl+Alt+S ）を開き、 に進みます。
ノードランタイム フィールドの横にある
をクリックします。
現在構成されているすべてのランタイムのリストが表示されている Node.js ランタイムダイアログで、ツールバーの
をクリックし、コンテキストメニューから リモートの追加 を選択します。
開いた Node.js リモートランタイムを構成するダイアログで、 Docker Compose を選択します。
サーバー リストから、使用する Docker 構成を選択します。
または、フィールドの横にある 新規 をクリックし、 Docker サポートを有効にする説明に従って Docker サーバーを構成します。
構成ファイル フィールドで使用する docker-compose 設定ファイルを指定します。 「閲覧 」をクリックし、表示される「Docker Compose 構成ファイル 」ダイアログで構成ファイルのリストを作成します。
サービス リストから、使用するサービスを選択します。
OK をクリックすると、新しいランタイムがリストに追加される Node.js ランタイム ダイアログに戻ります。 新しく構成されたランタイムをプロジェクトのデフォルトとして設定するには、リストでそのランタイムを選択し、 OK をクリックして JavaScript ランタイム ダイアログに戻ります。
PyCharm は、たとえば実行/デバッグ構成を作成する際に、 ノードランタイム リストから Project エイリアスを選択するたびに、このインタープリターを自動的に使用します。
新しいランタイムに関連付けられたパッケージマネージャーをプロジェクトの依存関係の管理に使用するには、このパッケージマネージャーをプロジェクトのデフォルトとして設定します。 そのためには、 パッケージマネージャー フィールドにパッケージマネージャーの場所を指定します。 詳しくは プロジェクトでデフォルトの Node.js ランタイムとパッケージマネージャーを指定するを参照してください。
プロジェクト内のデフォルトの Node.js ランタイムとパッケージマネージャーを指定する
PyCharm は、実行 / デバッグ構成の作成時など、 ノードランタイム リストから Project エイリアスを選択するたびに、デフォルトのプロジェクトインタープリターを自動的に使用します。
デフォルトのプロジェクトパッケージマネージャーは、依存関係を管理するために自動的に使用されます。たとえば、 package.json ファイルから <package manager> install を実行したり、ESLint、Prettier などのサードパーティ製ツールをインストールしたりします。
設定 ダイアログ（Ctrl+Alt+S ）を開き、 に進みます。
ノードランタイム リストから、現在のプロジェクトでデフォルトで使用する構成を選択します。
パッケージマネージャー リストから、使用するパッケージマネージャーに関連付けられているエイリアスを選択します。 PyCharm はそのロケーションを自動的に検出します。
または、必要なパッケージマネージャーの場所を手動で指定します。
npm 実行可能ファイルのデフォルトの場所は
/usr/local/lib/node_modules/npmです。pnpm のデフォルトの場所は、インストール方法によって異なります：
npm を介してインストールするための /usr/local/lib/node_modules/pnpm 。
カールを介してインストールするための /usr/local/pnpm-global/<version>/node_modules/pnpm （
curl -f https://get.pnpm.io/<version>.js | node - add --global pnpm）。
詳細については、 pnpm 公式 Web サイト(英語)を参照してください。
ヤーンのデフォルトの場所は /opt/yarn-<version>5 で、たとえば /opt/yarn-v1.22.5 です。
Node.js 実行 / デバッグ構成を作成する
に進みます。 開いた 構成の編集 ダイアログで、ツールバーの
をクリックし、コンテキストメニューから Node.js を選択します。 「実行 / デバッグ構成: Node.js 」ダイアログが開きます。ファイル フィールドで、それを開始するアプリケーションのメインファイルへのパスを指定します（たとえば、 Express(英語) アプリケーションの場合は bin/www ）。
必要に応じて、 Node.js アプリケーションの実行とデバッグで説明されているいくつかのオプション設定を指定します。
ノードランタイム リストから、Docker Compose 経由で関連するリモート Node.js ランタイムを選択します。
または、 ノードランタイム フィールドの横にある
をクリックし、 上記のようにリモート Node.js ランタイムを構成します。
Docker Compose エリアで、Docker Compose に渡すコマンドとオプションを指定します。 デフォルト設定を受け入れるか、
をクリックしてカスタム設定を指定します。たとえば、 --rmや--service-portsなどのカスタム Docker Compose フラグが指定できます。 詳細については、 Docker オフィシャル Web サイトを参照してください。コマンドプレビュー を確認してください。
