Next.js
WebStorm は Next.js React フレームワークと統合されています。
始める前に
コンピューターに Node.js(英語) があることを確認してください。
設定で Next.js のサポートプラグインが有効になっていることを確認します。 Ctrl+Alt+S を押して設定を開き、 を選択します。 インストール済み タブをクリックします。 検索フィールドに Next.js のサポートと入力します。 プラグインの詳細については、 プラグインの管理を参照してください。
新しい Next.js アプリケーションを作成する
新しい Next.js アプリケーションの構築を開始するための推奨される方法は、WebStorm が npx を使用してダウンロードして実行する create-next-app パッケージです。 その結果、開発環境は Next.js を使用するように事前構成されています。
もちろん、ご自身で create-next-app をダウンロードしたり、空の WebStorm プロジェクトを作成して Next.js をインストールしたりすることもできます。
create-next-app で Next.js アプリケーションを生成する
ようこそ 画面で 新規プロジェクト をクリックするか、メインメニューから を選択します。 新規 プロジェクト ダイアログが開きます。
左側のペインで、 Next.js を選択します。
右側のペインで：
プロジェクト関連ファイルが保存されるフォルダーへのパスを指定します。
ノードランタイム フィールドで使用する Node.js ランタイムを指定します。 リストから設定済みのランタイムを選択するか、 追加 を選択して新しいランタイムを設定してください。
create-next-app リストから npx create-next-app を選択してください。
または、npm バージョン 5.1 以前の場合、 ターミナル Alt+F12 で
npm install --save-dev next react react-domを実行して、create-next-appパッケージを自分でインストールします。 アプリケーションを作成するときに、create-next-appパッケージが保存されているフォルダーを選択します。オプション:
JavaScript の代わりに TypeScript を使用するには、 TypeScript テンプレートの使用 チェックボックスを選択します。 WebStorm は、アプリケーション用の .ts ファイルと tsconfig.json 構成ファイルを生成します。
作成 をクリックすると、WebStorm は必要なすべての設定ファイルを含む Next.js 専用プロジェクトを生成し、必要な依存関係をダウンロードします。 WebStorm はさらに、アプリケーションの実行やデバッグ用のデフォルト設定を持つ npm start と JavaScript デバッグ構成も作成します。
空の WebStorm プロジェクトに Next.js をインストールする
この場合、ビルドパイプラインを自分で構成する必要があります。 Next.js 公式サイト(英語)からプロジェクトに Next.js を追加する方法については、こちらを参照してください。
空の WebStorm プロジェクトを作成する
ようこそ 画面で 新規プロジェクト をクリックするか、メインメニューから を選択します。 新規 プロジェクト ダイアログが開きます。
左側のペインで、 空のプロジェクト を選択します。 右側のウィンドウで、アプリケーションフォルダーを指定し、 作成 をクリックします。
空のプロジェクトに Next.js をインストールする
Next.js を使用する空のプロジェクトを開きます。
コマンドラインシェルまたは組み込み ターミナル （Alt+F12） で、次を入力してください：
npm install --save-dev next react react-dom
既存の Next.js アプリケーションから開始する
既存の Next.js アプリケーションの開発を続けるには、WebStorm で開き、必要な依存関係をダウンロードしてください。
すでにマシン上にあるアプリケーションソースを開く
ようこそ 画面で 開く をクリックするか、メインメニューから を選択します。 開いたダイアログで、ソースが保存されているフォルダーを選択します。
バージョン管理からアプリケーションのソースをチェックアウト
ようこそ 画面で リポジトリのクローン をクリックします。
あるいは、メインメニューから 、 、 を選択します。
メインメニューの Git の代わりに、プロジェクトに関連付けられている他のバージョン管理システムが表示される場合があります。 例: Mercurial または Perforce。
表示されるダイアログで、リストからバージョン管理システムを選択し、アプリケーションソースをチェックアウトするリポジトリを指定します。 詳細については、 プロジェクトをチェックアウトする（クローン） を参照してください。
依存関係をダウンロードする
ポップアップで 'npm install' を実行 または 'yarn install' を実行 をクリックします。
npm、 Yarn 1 または Yarn 2 を利用可能です。詳細は npm と Yarn を参照してください。
または、エディターの package.json のコンテキストメニュー、または プロジェクト ツールウィンドウ (Alt+1) で 'npm install' を実行 または 'yarn install' を実行 を選択します。
プロジェクトのセキュリティ
WebStorm の外部で作成されインポートしたプロジェクトを開くと、WebStorm は未知のソースコードをどう扱うか選択できるダイアログを表示します。
次のいずれかのオプションを選択します：
セーフモードでプレビュー ：この場合、WebStorm はプロジェクトをプレビューモードで開きます。 これは、プロジェクトのソースを参照することはできますが、タスクやスクリプトを実行したり、プロジェクトを実行 / デバッグしたりすることはできないことを意味します。
WebStorm はエディター領域の上部に通知を表示し、 プロジェクトを信頼する… リンクをクリックしていつでもプロジェクトをロードできます。
プロジェクトを信頼 ：この場合、WebStorm はプロジェクトを開いてロードします。 つまり、プロジェクトが初期化され、プロジェクトのプラグインが解決され、依存関係が追加され、すべての WebStorm 機能が利用可能になります。
開かない ：この場合、WebStorm はプロジェクトを開きません。
詳細は プロジェクトのセキュリティ をご覧ください。
Next.js アプリケーションを実行する
アプリケーションを実行するには、 next dev コマンドをスクリプトとして起動し、 実行 ツールウィンドウまたは ターミナル でアプリケーション URL をクリックする必要があります。
エディターからアプリケーションを実行する または 実行 / デバッグ構成経由に従って、 ターミナル 内の package.json からスクリプトとして next dev コマンドを起動できます。
エディターからアプリケーションを実行する
を package.json 内の devスクリプトの横にあるガターでクリックするか、 ターミナル Alt+F12 でnext devコマンドを実行するか、 npm ツールウィンドウ () でdevタスクをダブルクリックします。
アプリケーションのコンパイルと開発サーバーの準備が完了するまでお待ちください。
実行 ツールウィンドウまたは ターミナル には、アプリケーションが実行されている URL が表示されます。デフォルトの URL は http://localhost:3000 です。
このリンクをクリックすると、ブラウザーでアプリケーションが開きます。
実行 / デバッグ構成でアプリケーションを実行する
ルート package.json に next パッケージが依存関係としてリストされているシングルリポジトリプロジェクトを開くと、WebStorm は自動的に npm タイプの Next.js: server-side 実行 / デバッグ構成を生成します。 この構成は、開発サーバーを起動し、アプリケーションを開発モードで実行する next dev コマンドを実行します。
ツールバーの 実行 ウィジェットのリストから、 npm タイプの実行構成を選択します。 これは、自動生成された Next.js：server-side 構成、または 以下で説明するように自分で作成したカスタム構成のいずれかになります。
をクリックしてください。アプリケーションがコンパイルされ、開発サーバーの準備が完了すると、 実行 ツールウィンドウまたは ターミナル に、アプリケーションが実行されている URL が表示されます。 デフォルトの URL は http://localhost:3000 ですが、デフォルトポート
3000がすでに使用中の場合、サーバーは最も近い空きポートで起動を試みます。リンクをクリックすると、ブラウザーでアプリケーションが開きます。
Next.js アプリケーションのクライアント側をデバッグする
WebStorm では、デバッグセッションを開始する方法が 2 つあります：
エディターから - package.json または ターミナル から
next devコマンドをスクリプトとして実行します。 その後、 実行 ツールウィンドウまたは ターミナル でアプリケーション URL をクリックしてデバッグセッションを開始します。
エディターからデバッグを開始する
Next Dev でアプリケーションを実行する
- を package.json 内の
devスクリプトの横にあるガターでクリックするか、 ターミナル Alt+F12 でnext devコマンドを実行するか、 npm ツールウィンドウ () でdevタスクをダブルクリックします。 アプリケーションのコンパイルと開発サーバーの準備が完了するまでお待ちください。
実行 ツールウィンドウまたは ターミナル には、アプリケーションが実行されている URL が表示されます。デフォルトの URL は http://localhost:3000 です。
このリンクをクリックすると、ブラウザーでアプリケーションが開きます。
実行ツールウィンドウまたはターミナルからデバッグセッションを開始する
必要に応じて ブレークポイントの設定。
- を package.json 内の
devスクリプトの横にあるガターでクリックするか、 ターミナル Alt+F12 でnext devコマンドを実行するか、 npm ツールウィンドウ () でdevタスクをダブルクリックします。 アプリケーションがコンパイルされ、開発サーバーの準備が完了すると、 実行 ツールウィンドウまたは ターミナル に、アプリケーションが実行されている URL が表示されます。 デフォルトの URL は http://localhost:3000 ですが、デフォルトポート
3000がすでに使用中の場合、サーバーは最も近い空きポートで起動を試みます。
Ctrl+Shift を押しながらリンクをクリックします。
アプリケーションがブラウザーで開いたら、プログラムの実行をトリガーするアクション（たとえば、リンクをクリックするなど）を実行します。 フォーカスは デバッグツールウィンドウ を開いた状態の WebStorm に切り替わります。
通常どおり続行してください： プログラムをステップ実行、 プログラムの実行を停止・再開、 中断時に調査 、コールスタックや変数を確認、ウォッチの設定、変数の評価、 実際の HTML DOM を表示など。
ソースマップを無視して実際に実行されるコードをステップ実行するには、
を デバッグ ツールウィンドウのツールバーで押してください。 詳細については、 ソースマップを無効化 を参照してください。
実行 / デバッグ構成でデバッグを開始する
ルート package.json に next パッケージが依存関係として記載された単一リポジトリプロジェクトを開くと、WebStorm は 2 つの実行/デバッグ構成を自動で生成します：
npm タイプの Next.js: server-side。 この構成は、開発サーバーを起動しアプリケーションを開発モードで実行する
next devコマンドを実行します。ブラウザーでアプリケーションをデバッグするには、タイプ JavaScript デバッグの Next.js: クライアント側のデバッグを使用します。
実行 / デバッグ構成の作成
に進みます。 または、ツールバーの 実行 ウィジェットから 実行構成の編集 を選択します。
開いた 実行構成の編集 ダイアログで、ツールバーの 追加 ボタン (
) をクリックし、リストから npm を選択します。開いた 実行 / デバッグ構成：npm ダイアログの 構成 タブで、 package.json の場所、Node.js ランタイム、および使用するパッケージマネージャーを指定します。
コマンド フィールドで、リストから 実行 を選択し、次に スクリプト リストから実行するスクリプトを選択します。 ほとんどの場合、デフォルトの
devスクリプトになりますが、カスタムポートでアプリケーションを実行するなど、 package.json で別のスクリプトを構成することもできます。
オプション:
ブラウザーでアプリケーションを開くには、構成を次のように更新します： ブラウザー / Live Edit タブで、 起動後 チェックボックスをオンにし、アプリケーションを開くブラウザーを選択して、アプリケーションが実行される URL アドレスを指定します。
npm 実行 / デバッグ構成を使用して開発モードでアプリケーションを実行する
ツールバーの 実行 ウィジェットのリストから、 npm タイプの実行構成を選択します。 これは、自動生成された Next.js：server-side 構成、または 上記のように自分で作成したカスタム構成にすることができます。
をクリックしてください。アプリケーションがコンパイルされ、開発サーバーの準備が完了すると、 実行 ツールウィンドウまたは ターミナル に、アプリケーションが実行されている URL が表示されます。 デフォルトの URL は http://localhost:3000 ですが、デフォルトポート
3000がすでに使用中の場合、サーバーは最も近い空きポートで起動を試みます。
このリンクをクリックすると、アプリケーションが表示されます。
または、 上記のように、WebStorm で起動時にアプリケーションを開くよう有効にできます。
JavaScript デバッグ構成でデバッグを開始する
必要に応じて ブレークポイントの設定。
アプリケーションを開発モード npm 実行 / デバッグ構成または
next devとで実行します。アプリケーションがコンパイルされ、開発サーバーの準備が完了すると、 実行 ツールウィンドウまたは ターミナル に、アプリケーションが実行されている URL が表示されます。 デフォルトの URL は http://localhost:3000 ですが、デフォルトポート
3000がすでに使用中の場合、サーバーは最も近い空きポートで起動を試みます。ツールバーの 実行 ウィジェットのリストから、 JavaScript デバッグ タイプの実行構成を選択します。 これは、自動生成された Next.js: デバッグクライアント 構成、または 上記のように自分で作成したカスタム構成にすることができます。
をクリックしてください。アプリケーションがブラウザーで開いたら、プログラムの実行をトリガーするアクション（たとえば、リンクをクリックするなど）を実行します。 フォーカスは デバッグツールウィンドウ を開いた状態の WebStorm に切り替わります。
通常どおり続行してください： プログラムをステップ実行、 プログラムの実行を停止・再開、 中断時に調査 、コールスタックや変数を確認、ウォッチの設定、変数の評価、 実際の HTML DOM を表示など。
ソースマップを無視して実際に実行されるコードをステップ実行するには、
を デバッグ ツールウィンドウのツールバーで押してください。 詳細については、 ソースマップを無効化 を参照してください。
React アプリケーションの実行 および React アプリケーションのデバッグ を参照してください。
Next.js アプリケーションのサーバー側コンポーネントをデバッグする
ルート package.json に next パッケージが依存関係としてリストされているシングルリポジトリプロジェクトを開くと、WebStorm は自動的に npm タイプの Next.js: server-side 実行 / デバッグ構成を生成します。 この構成は、開発サーバーを起動し、アプリケーションを開発モードで実行する next dev コマンドを実行します。
サーバー側コード内の必要な場所にブレークポイントを設定します。
ツールバーの 実行 ウィジェットのリストから、 npm タイプの実行構成を選択します。 これは、自動生成された Next.js：server-side 構成、または 上記のように自分で作成したカスタム構成にすることができます。
をクリックしてください。プログラムの実行をトリガーするアクションを実行します。たとえば、リンクをクリックします。 フォーカスは デバッグツールウィンドウ を開いた状態の WebStorm に切り替わります。
通常どおり続行してください： プログラムをステップ実行、 プログラムの実行を停止・再開、 中断時に調査 、コールスタックや変数を確認、ウォッチの設定、変数の評価、 実際の HTML DOM を表示など。
ソースマップを無視して実際に実行されるコードをステップ実行するには、
を デバッグ ツールウィンドウのツールバーで押してください。 詳細については、 ソースマップを無効化 を参照してください。