Node.js
Node.js(英語) は、サーバーやコマンドラインなど、ブラウザーの外部で JavaScript を実行するための軽量ランタイム環境です。 WebStorm は Node.js と統合されており、アプリケーションの構成、編集、実行、デバッグ、テスト、プロファイリング、保守を支援します。
Node.js がアプリケーションのローカルランタイムとして、または npm パッケージの管理、JavaScript リンターの実行、ツールのビルド、フレームワークのテストなどにのみ必要な場合は、 Node.js をインストールするだけです。 標準のインストール手順に従うと、ほとんどの場合、WebStorm が Node.js 自体を検出します。
また、コンピューターに Node.js がない場合でも、 新規プロジェクトの作成ダイアログ で新しい Node.js アプリケーションを作成するときにインストールできます。以下の 新しい Node.js アプリケーションを作成するを参照してください。
複数の Node.js インストールを切り替える場合は、 ローカル Node.js ランタイムとして設定する必要があります。 ほとんどの場合、WebStorm は Node.js インストールを検出し、自動でランタイムとして設定し、選択できるリストに追加します。
Node.js アプリケーションをリモートで実行するには、リモートランタイムとして設定してください。 詳細については、 Node.js with Docker、 Node.js via SSH、 Node.js with Vagrant を参照してください。
始める前に
コンピューターに Node.js(英語) があることを確認してください。
設定で Node.js プラグインが有効になっていることを確認します。 Ctrl+Alt+S を押して設定を開き、 を選択します。 インストール済み タブをクリックします。 検索フィールドに Node.js と入力します。 プラグインの詳細については、 プラグインの管理を参照してください。
Node.js インストール間の切り替え
WebStorm を使うと、Node.js を複数インストールし、同じプロジェクトで作業しながら切り替えることができます。
Ctrl+Alt+S を押して設定を開き、 を選択します。
推奨ランタイム フィールドで Node.js が選択されていることを確認してください。
Node.js ランタイム リストから必要な Node.js インストールを選択します。
標準的なインストール手順に従った場合、ほとんどの場合、必要な Node.js のインストールがリストに表示されます。 インストールされていない場合は、
をクリックし、 手動でローカルランタイムとして設定してください。
システム Node.js バージョンの使用
WebStorm を使うと、システムのデフォルト node エイリアスをプロジェクトの Node.js バージョンとして設定できます。 設定後は、Node.js を必要とするすべてのツールと、すべての新しい実行 / デバッグ構成で、このバージョンが自動的に使用されます。 特に、新しい Node.js バージョンをインストールしてシステムのデフォルトノードエイリアスに設定した場合、各ツールの設定を更新する必要がなくなります。
Ctrl+Alt+S を押して設定を開き、 を選択します。
推奨ランタイム フィールドで Node.js が選択されていることを確認してください。
Node.js ランタイム リストから node を選択してください。
実行 / デバッグ構成や特定のツールの設定など、該当する場合にこの新しい Node.js ランタイムを指定します。
ローカル Node.js ランタイムの構成
たとえば、Node.js がデフォルト以外の場所にインストールされているため WebStorm が自動で検出しない場合は、Node.js インストールをランタイムとして手動で構成する必要があることがあります。
Ctrl+Alt+S を押して設定を開き、 を選択します。
推奨ランタイム フィールドで Node.js が選択されていることを確認してください。
ノードランタイム リストの横にある
をクリックします。現在設定されているすべてのランタイムのリストが表示された Node.js ランタイムダイアログで、ツールバーの
をクリックし、コンテキストメニューから ローカル追加 を選択して Node.js のインストールを選択し、 OK をクリックします。 Node.js ランタイムダイアログに戻り、 ノードランタイム の読み取り専用フィールドに新しいランタイムへのパスが表示されます。パッケージマネージャー フィールドで、現在のプロジェクトのパッケージマネージャー (npm、Yarn、pnpm、bun) を選択します。
詳細は、 プロジェクトのパッケージマネージャーの設定を参照してください。
OK をクリックすると、 JavaScript ランタイム ページに戻り、 ノードランタイム フィールドに新しいランタイムが表示されます。
Linux の Windows サブシステムで Node.js を使用する
WebStorm を利用すると、 Linux 用 Windows サブシステム上の Node.js を使って Node.js アプリケーションを実行したりデバッグしたりできます。 WSL 上の Node.js を 現在のプロジェクトのデフォルトランタイムとして選択することも、この Node.js バージョンを Node.js 実行 / デバッグ構成で設定して使用することもできます。
WSL 上の Node.js をプロジェクトのデフォルト Node.js ランタイムとして構成する
設定 ダイアログ（Ctrl+Alt+S ）で に移動します。
Node.js ランタイム ダイアログで Node.js ランタイム フィールドの横にある
をクリックし、 をクリックして、リストから WSL を追加 を選択します。
開いている WSL ノードランタイムを追加する ダイアログで、使用している Linux ディストリビューションを選択し、Node.js へのパスを指定します。
Node.js アプリケーションの作成
まだアプリケーションがない場合は、Node.js 固有の構造を持つ WebStorm プロジェクトをテンプレートから生成するか、空の WebStorm プロジェクトを作成し、下の 既存の Node.js アプリケーションで開始の説明に従って Node.js を構成できます。
新しい Node.js アプリケーションを作成する
ようこそ 画面で 新規プロジェクト をクリックするか、メインメニューから を選択します。 新規 プロジェクト ダイアログが開きます。
左側のペインで、 Node.js を選択して基本的な Node.js アプリケーションを作成するか、 Express を選択して Express(英語) アプリケーションを作成します。
右側のペインで、プロジェクトフォルダーと使用する Node.js ランタイムを指定します。 詳細は、 ローカル Node.js ランタイムの構成 を参照してください。
マシンに Node.js が1つだけあり、標準のインストール手順に従った場合は、WebStorm によって Node.js が自動的に検出されます。 それ以外の場合は、リストから該当するランタイムを選択し、上記の ローカル Node.js ランタイムの構成を参照してください。
Node.js がインストールされていない場合は、 Node.js をダウンロード を選択します。
Express アプリケーションの場合、 express-generator フィールドに express -generator(英語) を指定します。
ジェネレーターをダウンロードして実行する npx(英語) の使用をお勧めします。 そのためには、 express -generator リストから npx --package express-generator express を選択してください。
または、埋め込まれた ターミナル （Alt+F12 ）を開いて
npm install --g express-generatorと入力し、ダウンロードしたジェネレーターを express-generator リストから選択します。
使用するテンプレート言語とスタイルシート言語を選択してください。
作成 をクリックすると、WebStorm が必要な依存関係をダウンロードし、それらおよび Node.js コア API のコード補完も有効にします。 詳細については、「node_modules ライブラリの構成および Node.js コアライブラリの構成 」を参照してください。
Express の場合、WebStorm はデフォルト設定で Node.js タイプの実行/デバッグ構成を作成し、 Express 固有の基本的なディレクトリ構造を生成します。
Node.js の場合、WebStorm は
npm initコマンドを実行して package.json ファイルを生成するだけです。
空の WebStorm プロジェクトを作成する
ようこそ 画面で 新規プロジェクト をクリックするか、メインメニューから を選択します。 新規 プロジェクト ダイアログが開きます。
左側のペインで、 空の プロジェクト を選択します。 右側のウィンドウで、アプリケーションフォルダーを指定し、 作成 をクリックします。
既存の Node.js アプリケーションから始める
既存の Node.js アプリケーションの開発を続ける場合は、WebStorm でそのプロジェクトを開いて Node.js を構成し、必要な依存関係をダウンロードします。
すでにマシン上にあるアプリケーションソースを開く
ようこそ 画面で 開く をクリックするか、メインメニューから を選択します。 開いたダイアログで、ソースが保存されているフォルダーを選択します。
バージョン管理からアプリケーションのソースをチェックアウト
ようこそ 画面で リポジトリのクローン をクリックします。
あるいは、メインメニューから 、 、 を選択します。
メインメニューの Git の代わりに、プロジェクトに関連付けられている他のバージョン管理システムが表示される場合があります。 例: Mercurial または Perforce。
表示されるダイアログで、リストからバージョン管理システムを選択し、アプリケーションソースをチェックアウトするリポジトリを指定します。 詳細については、 プロジェクトをチェックアウトする（クローン） を参照してください。
プロジェクトで Node.js を構成する
設定 ダイアログ（Ctrl+Alt+S ）で に移動します。
ノードランタイム フィールドで、現在のプロジェクトのデフォルトの Node.js ランタイムを指定します。 例えば実行 / デバッグ構成を作成する際など、 ノードランタイム リストから
Projectエイリアスを選択するたびに、WebStorm がそのエイリアスを自動的に使用します。リストから設定済みのランタイムを選択するか、
をクリックして、 ローカル Node.js ランタイムの構成の説明に従って表示されるダイアログで新しいランタイムを設定します。 node を選択した場合は、 システム Node.js のバージョンが使用されます。Node.js コーディング支援 チェックボックスを選択して、 Node.js コアモジュールのソースを JavaScript ライブラリとして設定し、プロジェクトに関連付けます。 その結果、WebStorm は
fs、path、http、および Node.js バイナリにコンパイルされた他の Node.js パーツに対して、コード補完、参照解決、検証、デバッグ機能を提供します。構成が完了すると、WebStorm が現在構成されているバージョンの情報を表示します。
プロジェクトの一部でのみ Node.js API にコード補完が必要な場合は、 スコープの管理 リンクを使用してそれを構成できます。 開いた 使用箇所ダイアログで、関連するディレクトリをクリックし、リストごとに構成済みの Node.js コアライブラリを選択します。 ライブラリのスコープの構成から詳細を参照してください。
プロジェクトの依存関係をダウンロードする
組み込み ターミナル (Alt+F12) で次のように入力します。
npm installまたは、プロジェクトルートの package.json ファイルのコンテキストメニューから 'npm install' を実行 を選択します。
プロジェクトのセキュリティ
WebStorm の外部で作成されインポートしたプロジェクトを開くと、WebStorm は未知のソースコードをどう扱うか選択できるダイアログを表示します。
次のいずれかのオプションを選択します：
セーフモードでプレビュー ：この場合、WebStorm はプロジェクトをプレビューモードで開きます。 これは、プロジェクトのソースを参照することはできますが、タスクやスクリプトを実行したり、プロジェクトを実行 / デバッグしたりすることはできないことを意味します。
WebStorm はエディター領域の上部に通知を表示し、 プロジェクトを信頼する… リンクをクリックしていつでもプロジェクトをロードできます。
プロジェクトを信頼 ：この場合、WebStorm はプロジェクトを開いてロードします。 つまり、プロジェクトが初期化され、プロジェクトのプラグインが解決され、依存関係が追加され、すべての WebStorm 機能が利用可能になります。
開かない ：この場合、WebStorm はプロジェクトを開きません。
詳細は プロジェクトのセキュリティ をご覧ください。