WebStorm 2024.1 ヘルプ

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 と Docker」、「SSH 経由の Node.js」、「Node.js と Vagrant」を参照してください。

始める前に

  1. お使いのコンピューターに Node.js(英語) がインストールされていることを確認してください。

  2. 設定で Node.js プラグインが有効になっていることを確認します。Ctrl+Alt+S を押して設定を開き、プラグインを選択します。インストール済みタブをクリックします。検索フィールドに Node.js と入力します。プラグインの詳細については、プラグインのマッピングを参照してください。

Node.js バージョン間の切り替え

WebStorm を使用すると、Node.js を複数インストールし、同じプロジェクトで作業しながら切り替えることができます。

  1. Ctrl+Alt+S を押して設定を開き、言語 & フレームワーク | Node.js を選択します。

  2. Node インタープリターリストから必要な Node.js インストールを選択します。

    標準のインストール手順に従っている場合、ほとんどの場合、必要な Node.js インストールがリストに含まれています。インストールが欠落している場合は、the Browse button をクリックし、ローカルインタープリターとして手動で構成します

システム Node.js バージョンの使用

WebStorm を使用すると、デフォルトのシステムノードエイリアスをプロジェクトの Node.js バージョンとして設定できます。その後、このバージョンは、Node.js を必要とするすべてのツールおよびすべての新しい実行 / デバッグ構成で自動的に使用されます。これは、特に、新しい Node.js バージョンをインストールし、それをシステムのデフォルトのノードエイリアスにした場合、各ツールの設定を更新する必要がないことを意味します。

  1. Ctrl+Alt+S を押して設定を開き、言語 & フレームワーク | Node.js を選択します。

  2. Node インタープリターリストから node を選択します。

    Default system node
  3. 実行 / デバッグ構成や特定のツールの設定など、該当する場合はこの新しい Node.js インタープリターを指定します。

ローカル Node.js インタープリターの構成

Node.js をデフォルト以外の場所にインストールして、WebStorm が自動的に検出しないようにする場合など、Node.js インストールをインタープリターとして手動で構成する必要がある場合があります。

  1. Ctrl+Alt+S を押して設定を開き、言語 & フレームワーク | Node.js を選択します。

  2. Node インタープリターリストの横にある the Browse button をクリックします。

  3. 現在構成されているすべてのインタープリターのリストが表示された Node.js インタープリターダイアログで、ツールバーの the Add button をクリックし、コンテキストメニューからローカル追加を選択し、Node.js のインストールを選択してから、OK をクリックします。Node.js インタープリターダイアログに戻り、Node インタープリター読み取り専用フィールドに新しいインタープリターへのパスが表示されます。

  4. パッケージマネージャーフィールドで、現在のプロジェクトのパッケージマネージャー(npm、Yarn、pnpm)を選択します。

    詳細は、プロジェクトのパッケージマネージャーの設定を参照してください。

OK をクリックすると Node.js ページに戻り、Node インタープリターフィールドに新しいインタープリターが表示されます。

Windows Subsystem for Linux で Node.js を使用する

WebStorm を使用すると、Windows Subsystem for Linux の Node.js を使用して Node.js アプリケーションを実行およびデバッグできます。WSL 上の Node.js を現在のプロジェクトのデフォルトのインタープリターとして選択するか、この Node.js バージョンを Node.js 実行 / デバッグ構成で構成して使用することができます。

WSL の Node.js をデフォルトのプロジェクトノードインタープリターとして構成する

  1. 設定ダイアログ(Ctrl+Alt+S)で、言語 & フレームワーク | Node.js に移動します。

  2. Node.js インタープリターダイアログで Node インタープリターフィールドの横にある the Browse button をクリックし、the Add button をクリックして、リストから WSL を追加するを選択します。

    Configure WSL Node.js interpreter: add WSL
  3. 開いている WSL ノードインタープリターを追加するダイアログで、使用している Linux ディストリビューションを選択し、Node.js へのパスを指定します。

    Configuring Node.js on WSL as the default project node interpreter

Node.js アプリケーションの作成

まだアプリケーションがない場合は、テンプレートから Node.js 固有の構造を使用して WebStorm プロジェクトを生成するか、空の WebStorm プロジェクトを作成し、その中に Node.js を以下の既存の Node.js アプリケーションから始めるの説明に従って構成できます。

新しい Node.js アプリケーションを作成する

  1. ウェルカム画面で新規プロジェクトの作成をクリックするか、メインメニューからファイル | 新規 | プロジェクトを選択します。新しいプロジェクトダイアログが開きます。

  2. 左側のペインで、Node.js を選択して基本的な Node.js アプリケーションを作成するか、Express を選択して Express(英語) アプリケーションを作成します。

  3. 右側のペインで、使用するプロジェクトフォルダーと Node.js インタープリターを指定します。詳細については、ローカル Node.js インタープリターの構成を参照してください。

    マシン上に Node.js が 1 つだけあり、標準のインストール手順に従っている場合、WebStorm は Node.js を自動的に検出します。それ以外の場合は、リストから関連するインタープリターを選択します。上記のローカル Node.js インタープリターの構成を参照してください。

    Node.js がインストールされていない場合は、Node.js をダウンロードを選択します。

    Installing Node.js during project creation in the Create Project dialog

    Express アプリケーションの場合、express-generator フィールドに express -generator(英語) を指定します。

    ジェネレーターをダウンロードして実行する npx(英語) を使用することをお勧めします。これを行うには、express -generator リストから npx --package express-generator express を選択します。

    または、埋め込まれたターミナルAlt+F12)を開いて npm install --g express-generator と入力し、ダウンロードしたジェネレーターを express-generator リストから選択します。

    Select express generator

    使用するテンプレート言語とスタイルシート言語を選択します。

  4. 作成をクリックすると、WebStorm は必要な依存関係をダウンロードし、それらと Node.js コア API に対してコード補完を有効にします。詳細については、「node_modules ライブラリの構成および Node.js コアライブラリの構成」を参照してください。

    Express の場合、WebStorm はデフォルト設定でタイプ Node.js の実行 / デバッグ構成を作成し、Express 固有の基本的なディレクトリ構造(英語)を生成します。

    Node.js の場合、WebStorm は npm init コマンドを実行して package.json ファイルを生成するだけです。

空の WebStorm プロジェクトを作成する

  1. ウェルカム画面で新規プロジェクトの作成をクリックするか、メインメニューからファイル | 新規 | プロジェクトを選択します。新しいプロジェクトダイアログが開きます。

  2. 左側のペインで、空のプロジェクトを選択します。右側のウィンドウで、アプリケーションフォルダーを指定し、作成をクリックします。

既存の Node.js アプリケーションから始める

既存の Node.js アプリケーションを引き続き開発する場合は、WebStorm でそれを開き、その中に Node.js を構成し、必要な依存関係をダウンロードします。

すでにマシン上にあるアプリケーションソースを開く

  • ウェルカム画面で開くをクリックするか、メインメニューからファイル | 開くを選択します。開いたダイアログで、ソースが保存されているフォルダーを選択します。

バージョン管理からアプリケーションのソースをチェックアウト

  1. ウェルカム画面で VCS から取得をクリックします。

    あるいは、メインメニューからファイル | 新規 | バージョン管理からプロジェクトGit | クローンVCS | バージョン管理から取得を選択します。

    メインメニューの Git の代わりに、プロジェクトに関連付けられている他のバージョン管理システムが表示される場合があります。例: Mercurial または Perforce

  2. 表示されるダイアログで、リストからバージョン管理システムを選択し、アプリケーションソースをチェックアウトするリポジトリを指定します。詳細については、プロジェクトをチェックアウトする (クローン) を参照してください。

プロジェクトで Node.js を構成する

  1. 設定ダイアログ(Ctrl+Alt+S)で、言語 & フレームワーク | Node.js に移動します。

  2. Node インタープリターフィールドで、現在のプロジェクトのデフォルトの Node.js インタープリターを指定します。WebStorm は、実行 / デバッグ構成の作成時など、Node インタープリターリストから Project エイリアスを選択するたびに自動的に使用します。

    リストから構成済みのインタープリターを選択するか、the Browse button をクリックして、ローカル Node.js インタープリターの構成に従って開いたダイアログで新しいインタープリターを構成します。node を選択すると、システム Node.js のバージョンが使用されます。

  3. Node.js コーディング支援チェックボックスを選択して、Node.js コアモジュールのソースを JavaScript ライブラリとして設定し、プロジェクトに関連付けます。その結果、WebStorm は、fspathhttp、Node.js バイナリにコンパイルされる Node.js の他の部分に対して、コード補完、参照解決、検証、デバッグ機能を提供します。

    構成が完了すると、WebStorm は現在構成されているバージョンに関する情報を表示します。

  4. プロジェクトの一部でのみ Node.js API にコード補完が必要な場合は、スコープの管理リンクを使用してそれを構成できます。開いた使用箇所ダイアログで、関連するディレクトリをクリックし、リストごとに構成済みの Node.js コアライブラリを選択します。ライブラリのスコープの構成から詳細を参照してください。

プロジェクトの依存関係をダウンロードする

  • 埋め込まれたターミナルAlt+F12)で、次のように入力します。

    npm install

  • または、プロジェクトルートの package.json ファイルのコンテキストメニューから 'npm install' の実行を選択します。

プロジェクトのセキュリティ

WebStorm の外部で作成され、そこにインポートされたプロジェクトを開くと、WebStorm は、未知ソースコードを使用してこのプロジェクトを処理する方法を決定できるダイアログを表示します。

Untrusted project warning

次のいずれかのオプションを選択します。

  • セーフモードでプレビュー : この場合、WebStorm はプロジェクトをプレビューモードで開きます。これは、プロジェクトのソースを参照することはできますが、タスクやスクリプトを実行したり、プロジェクトを実行 / デバッグしたりすることはできないことを意味します。

    WebStorm はエディター領域の上部に通知を表示し、プロジェクトを信頼リンクをクリックして、いつでもプロジェクトをロードできます。

  • プロジェクトを信頼 : この場合、WebStorm はプロジェクトを開いてロードします。これは、プロジェクトが初期化され、プロジェクトのプラグインが解決され、依存関係が追加され、すべての WebStorm 機能が使用可能になることを意味します。

  • 開かない : この場合、WebStorm はプロジェクトを開きません。

プロジェクトのセキュリティの詳細を参照してください。

関連ページ:

Node.js と Docker

Docker を使用すると、Node.js アプリケーションをすばやくブートストラップして、WebStorm から実行、デバッグ、プロファイリングできます。IDE は、新しい Dockerfile を自動的に作成し、イメージをビルドして実行し、ソースコードを同期し、コンテナーに npm 依存関係をインストールすることにより、初期構成を処理します。WebStorm と Docker のクイックツアーでいくつかの例を見つけることができます。始める前に:設定 | プラグインページのインストール済みタブで、...

プラグインのインストール

プラグインは WebStorm のコア機能を拡張します。例: プラグインをインストールして、次の機能を取得します。バージョン管理システム、課題追跡システム、ビルド管理サーバー、その他のツールとの統合。さまざまな言語とフレームワークのコーディング支援サポート。ショートカットのヒント、ライブプレビュー、ファイルウォッチャーなど。新しいプログラミング言語を学ぶのに役立つコーディング演習。デフォルトでは、WebStorm には多数のプラグインがバンドルされています。バンドルされたプラグインを無効にするこ...

Node.js インタープリターダイアログ

次の Node.js バージョンは、WebStorm 2023.3 以降でサポートされています。Node.js 20 - アクティブな長期サポート (LTS) バージョン、Node.js 21 - 現在のバージョン、サポートされている Node.js バージョンの詳細を参照してください。このダイアログを使用して、ローカルまたはリモート Node.js インタープリターまたは Windows Subsystem for Linux の Node.js を構成します。ローカル Node.js インタープリ...

npm、pnpm、Yarn

WebStorm は npm、pnpm、Yarn、Yarn 2、Yarn 3 と統合されているため、組み込みのターミナルで、IDE 内から再利用可能なコードのパッケージをインストール、検索、更新、削除できます。WebStorm では、npm、Yarn、pnpm スクリプトを実行およびデバッグすることもできます。WebStorm は、package.json ファイルを解析してスクリプトの定義を認識し、スクリプトをツリービューに表示して、ツリー内のスクリプトと package.json ファイル内のその定...

Node.js の実行とデバッグ

WebStorm は、Node.js アプリケーションの実行とデバッグを支援します。WebStorm から起動し、すでに実行中のアプリケーションにアタッチするアプリケーションをデバッグできます。始める前に:設定 | プラグインページのインストール済みタブで、Node.js および JavaScript デバッガーに必要なプラグインが有効になっていることを確認します。詳細については、「プラグインのマッピング」を参照してください。Node.js アプリケーションを実行する:WebStorm は、タイ...

JavaScript ライブラリを構成する

言語と IDE のコンテキストでは、ライブラリはファイルまたはファイルのセットです。これらのファイルの関数とメソッドは、編集したプロジェクトコードから WebStorm が取得する関数とメソッドに加えて、WebStorm の内部知識に追加されます。プロジェクトのスコープでは、そのライブラリはデフォルトで書き込み保護されています。WebStorm は、2 つの事前定義された自動生成ライブラリフォルダーを予約します。node_modules プロジェクト package.json のオブジェクトにリストさ...