React サポート
React は、カプセル化されたコンポーネントから複雑なインタラクティブユーザーインターフェースを構築するための JavaScript ライブラリです。 React オフィシャル Web サイト(英語)からライブラリの詳細を参照してください。
PyCharm は React と連携し、設定、編集、lint、実行、デバッグ、保守など、アプリケーション開発をサポートします。
始める前
お使いのコンピューターに Node.js(英語) がインストールされていることを確認してください。
JavaScript と TypeScript、 React、 Vite に必要なプラグインが 設定 | プラグイン ページ、タブ インストール済み で有効になっていることを確認してください。 詳細は、 プラグインの管理を参照してください。
新しい React アプリケーションを作成する
React アプリケーションを生成する
メインメニューから をクリックします。 または、'ようこそ' 画面の左側のペインで をクリックします。
新規 Project ダイアログが開きます。
左側のペインで、 React を選択します。
右側のペインで:
プロジェクト関連ファイルが保存されるフォルダーへのパスを指定します。
ノードランタイム フィールドで使用する Node.js ランタイムを指定します。 リストから設定済みのランタイムを選択するか、 追加 を選択して新しいランタイムを設定してください。
React CLI リストから、使用するジェネレーターを選択してください。
デフォルトの
npx create-viteを受け入れると、開発環境が Vite を使用するように事前に構成されます。npx create-react-appを選択すると、webpack、Babel、ESLint を使用するための開発環境が事前に設定されます。以前にダウンロードしたカスタムジェネレーターを使用するには、 選択 をクリックし、開いたダイアログでジェネレーターへのパスを指定します。

オプション:
JSX の代わりに TSX を使用するには、 TypeScript プロジェクトの作成 チェックボックスを選択します。 PyCharm は、アプリケーション用の .tsx ファイルと tsconfig.json 構成ファイルを生成します。
作成 をクリックすると、PyCharm は必要な構成ファイルがすべて含まれた React 専用プロジェクトを生成し、必要な依存関係をダウンロードします。 PyCharm は、アプリケーションの実行やデバッグ用のデフォルト設定を持つ npm start と JavaScript デバッグ構成も作成します。
空の PyCharm プロジェクトに React をインストールする
この場合、以下の React アプリケーションの構築の説明に従ってビルドパイプラインを自分で設定する必要があります。 React オフィシャル Web サイト(英語)からプロジェクトに React を追加する方法の詳細を参照してください。
空の PyCharm プロジェクトを作成する
メインメニューから をクリックします。 または、'ようこそ' 画面の左側のペインで をクリックします。
新規 Project ダイアログが開きます。
左側のペインで、 空の Project プロジェクト を選択します。 右側のウィンドウで、アプリケーションフォルダーを指定し、 作成 をクリックします。
空のプロジェクトに React をインストールする
React を使用する空のプロジェクトを開きます。
組み込み ターミナル (Alt+F12) で次のように入力します。
npm install --save react react-dom
既存の React アプリケーションから始める
既存の React アプリケーションの開発を継続する場合は、PyCharm で開いて必要な依存関係をダウンロードしてください。
すでにマシン上にあるアプリケーションソースを開く
ようこそ 画面の左側のペインで オープン をクリックするか、メインメニューから を選択します。 開いたダイアログで、ソースが保存されているフォルダーを選択します。
バージョン管理からアプリケーションのソースをチェックアウト
ようこそ 画面の左側のペインで クローン をクリックします。
あるいは、メインメニューから 、 、 を選択します。
メインメニューの Gitサポート の代わりに、プロジェクトに関連付けられている他のバージョン管理システムが表示される場合があります。 例: Mercurial または Perforce。
表示されるダイアログで、リストからバージョン管理システムを選択し、アプリケーションソースをチェックアウトするリポジトリを指定します。 詳細については、 プロジェクトをチェックアウトする (クローン) を参照してください。
依存関係をダウンロードする
ポップアップで 'npm install' の実行 または 'yarn install' の実行 をクリックします。

npm、 Yarn 1 、または Yarn 2 を使用できます。詳細は npm と Yarn を参照してください。
または、エディターの package.json のコンテキストメニュー、または Project ツールウィンドウ (Alt+1) で 'npm install' の実行 または 'yarn install' の実行 を選択します。
プロジェクトのセキュリティ
PyCharm の外部で作成され、インポートされたプロジェクトを開くと、PyCharm は知らないソースコードを含むプロジェクトをどのように処理するか決定できるダイアログを表示します。

次のいずれかのオプションを選択します:
セーフモードでプレビュー :この場合、PyCharm はプロジェクトをプレビューモードで開きます。 これは、プロジェクトのソースを参照することはできますが、タスクやスクリプトを実行したり、プロジェクトを実行 / デバッグしたりすることはできないことを意味します。
PyCharm はエディター領域の上部に通知を表示し、 Trust project… リンクをクリックして、いつでもプロジェクトをロードできます。
プロジェクトを信頼 :この場合、PyCharm はプロジェクトを開いてロードします。 これは、プロジェクトが初期化され、プロジェクトのプラグインが解決され、依存関係が追加され、すべての PyCharm 機能が利用可能になることを意味します。
開かない :この場合、PyCharm はプロジェクトを開きません。
詳細は プロジェクトのセキュリティ をご覧ください。
コード補完
PyCharm は、React API と JavaScript コード内の JSX にコード補完を提供します。 コード補完は、React メソッド、React 固有の属性、HTML タグとコンポーネント名、 React イベント(英語) 、コンポーネントプロパティなどに対して機能します。 React オフィシャル Web サイト(英語)から詳細を参照してください。
React メソッドのコード補完と React 固有の属性を取得するには、プロジェクトのどこかに react.js ライブラリファイルが必要です。 通常、ライブラリはすでに node_modules フォルダーにあります。
完全な React メソッド、属性、イベント
デフォルトでは、入力時にコード補完ポップアップが自動的に表示されます。 例:

JSX タグでは、PyCharm は React 固有の属性 (className や classID など)、および 非 DOM 属性 (key や ref など)のコーディング支援を提供します。 さらに、自動補完は、プロジェクトの CSS ファイルで定義されているクラスの名前に対しても機能します。

onClick や onChange などのすべての React イベント(英語)は、波括弧 ={} または引用符 "" と一緒に自動的に補完することもできます。

デフォルトでは、波括弧が挿入されます。 PyCharm で常に引用符を追加することも、 TypeScript 定義ファイル (d.ts) の型に基づいて引用符または中括弧のいずれかを選択することも可能です。 デフォルト設定を変更するには、 設定 ダイアログ (Ctrl+Alt+S) を開き、 に移動して、 JSX 属性の追加 リストから該当するオプションを選択します。

また、波括弧内の JavaScript 式の補完も可能です。 これは、定義したすべてのメソッドと関数に適用されます。

完全な HTML タグとコンポーネント名
PyCharm は、JavaScript や他のコンポーネント内のメソッドで定義した HTML タグやコンポーネント名に対してコード補完を提供します:

補完は、ES6 形式構文によるインポート済みコンポーネントでも機能します:

完全なコンポーネントプロパティ
PyCharm は、 propTypes を使って定義されたコンポーネントプロパティに対してコード補完を提供し、それらの定義に素早くジャンプしたりプレビューしたりできるように解決します:

コンポーネント名を自動補完すると、PyCharm は必要なすべてのプロパティを自動的に追加します。 必要なプロパティの一部がコンポーネントの使用時に欠落している場合、PyCharm はそのことを警告します。
機能コンポーネントに状態を追加する
PyCharm は、特定の場所で未解決の参照を定義して、関数型 React コンポーネントに useState フックを追加するクイックフィックスを提案します。 PyCharm は、 useState フック用の import ステートメントを自動的に挿入します。 状態タイプは、参照が定義されている場所から推測されます。
未解決の参照にキャレットを置き、 Alt+Enter を押して、リストから <機能コンポーネント名> コンポーネントに <未解決の reference> 状態を作成する を選択します。
props を追加
PyCharm は、特定の場所で未解決参照を定義することで、React コンポーネントに新しいプロパティを追加するためのクイックフィックスを提案します。
PyCharm は、追加されたプロパティを含むコンポーネントのコードを生成します。 プロパティの型は、対応する参照が定義されている場所から推論されます。
クイックフィックスはクラスベースのコンポーネントにも適用できます。 この場合、新しいプロパティが挿入された後、未解決の参照は this.props.${reference_name} に置き換えられます。
未解決の参照にキャレットを置き、 Alt+Enter を押して、リストから <コンポーネント名> コンポーネントに <未解決の reference> プロパティを作成する を選択します。

HTML 属性を JSX に転送する
クラス属性または on 系のイベントハンドラを含む HTML コードをコピーして JSX に貼り付けると、PyCharm はこれらの属性を React 固有のものに自動的に置き換えます(className、 onClick、 onChange など)。

これは TSX でも機能します:

単一タグを含む HTML コードをコピーして JSX に貼り付けると、PyCharm は各単一タグの末尾にスラッシュ / を自動的に追加します。

HTML コードをそのまま JSX または TSX にコピーするには、 そのまま貼り付け Ctrl+Alt+Shift+V を使用するか、 設定 ダイアログ (Ctrl+Alt+S) を開いて の設定ページに移動し、 JSX ファイルにコードを貼り付けるときに HTML の単一タグを閉じる と JSX ファイルに貼り付け時に HTML 属性名を変換する のチェックボックスをオフにします。
React コードスニペット
PyCharm には、 React フック など、React アプリでよく使われるさまざまなステートメントやコードブロックへ展開できる 50 以上のコードスニペット集が付属しています。 以下の例は、 rcjc 省略形を使用して、新しい React コンポーネントを定義するクラスを作成する方法を示しています。

スニペットから React コード構成を作成する
必要な省略形をエディターに入力し、 Tab を押します。
Ctrl+J を押して、関連するスニペットを選択します。 検索を絞り込むには、略語の入力を開始してから、 補完リストから選択します。
詳細は、 ライブテンプレートを参照してください。
使用可能なすべての React スニペットのリストを表示する
設定 ダイアログ (Ctrl+Alt+S) で、 エディター の ライブテンプレート をクリックし、 React ノードまたは React フック ノードを展開します。

React ディレクティブ
PyCharm は、ファイルの先頭および関数内で次の React ディレクティブ を認識し、ハイライトします。
JSX の Emmet
PyCharm では、HTML だけでなく JSX コードでも、特有の React 機能を活かして Emmet を使用できます。 例: 略語 div.my-class は JSX では <div className=”my-class"></div> に展開されますが、HTML のように <div class=”my-class"></div> には展開されません。

React アプリケーションを移動する
基本的なナビゲーションに加えて、PyCharm は React 固有のコード要素間のジャンプにも対応しています。
構造ビューで移動する
構造 ツールウィンドウと 構造 ポップアップにより、React コード構造をより明確に把握できるようになり、ナビゲーションが容易になり、React コンポーネントと関連要素の理解が深まります。
構造 ツールウィンドウには、次の React 固有のノードが表示されます。
React アプリケーションをリントする
JavaScript および HTML 用 PyCharm の全組み込み コードインスペクションは、JSX コードでも動作します。 PyCharm は、未使用の変数や関数、終了タグの抜け、ステートメントの不足など場合に警告します。

一部のインスペクションでは、PyCharm がクイックフィックス、たとえば不足しているメソッドの追加提案を提供します。 クイックフィックス ポップアップを表示するには、 Alt+Enter を押します。
インスペクションの一覧をカスタマイズするには、 設定 ダイアログ(Ctrl+Alt+S )を開き、エディター|インスペクションから不要な項目を無効化したり、重要度を変更したりします。 詳しくは、 インスペクションの無効化と有効化 と インスペクションの重大度を変更する を参照してください。
ESLint
組み込みコードインスペクションの提供に加えて、PyCharm は JSX コード向けに ESLint などのリンターとも連携しています。 ESLint は、プラグインで拡張できる幅広い lint ルールをもたらします。 PyCharm は、入力中にエディターで ESLint によって報告された警告とエラーを表示します。 ESLint を使用すると、 JavaScript 標準スタイル(英語)を使用したり、 TypeScript コードをリントしたりすることもできます。
詳細については、 ESLint を参照してください。
ESLint で React JSX 構文を正しく解析するには、 eslint-plugin-react が必要です。 このプラグインにより、たとえば React コンポーネントの表示名前が設定されていない場合や、危険な JSX プロパティが使用されている場合などに警告が表示されます。

React プロジェクトに ESLint をインストールして設定する
組み込み ターミナル ( )で、次のように入力します。
npm install --save-dev eslint npm install --save-dev eslint-plugin-reactプロジェクトに ESLint 構成ファイルを追加します。
設定 ダイアログ(Ctrl+Alt+S )で、 言語 & フレームワーク | JavaScript | コード品質ツール | ESLint に移動し、 自動 ESLint 構成 を選択します。 PyCharm はプロジェクトの node_modules フォルダー内の ESLint を自動で検出し、 .eslintrc.* ファイルまたは package.json の
eslintConfigプロパティからデフォルト構成を利用します。または、 手動 ESLint 構成 を選択して、カスタム ESLint パッケージと構成を使用します。
詳細は PyCharm での ESLint の有効化と構成 をご覧ください。
.eslintrc 構造体の例 (react プラグイン付き ESLint 1.x)
ecmaFeaturesオブジェクトに、"jsx" = trueを追加します。 ここでは、ES6 クラスやモジュールなど、使用したい追加の言語機能を指定することもできます。pluginsオブジェクトに、reactを追加します。rulesオブジェクトでは、有効にする ESLint ビルトインルール(英語)と、 react プラグイン経由で利用できるルール(英語)をリストできます。{ "parser": "babel-eslint", "env": { "browser": true, "es6": true, "jest": true }, "rules": { "arrow-parens": ["error", "as-needed", { "requireForBlockBody": true }], "react/jsx-props-no-spreading": "off", "react/jsx-sort-props": ["error", { "reservedFirst": ["key"] }], "react/require-default-props": "off", "react/sort-prop-types": "error", "react/state-in-constructor": ["error", "never"], "semi-spacing": "warn" }, "overrides": [ { "files": [ "sample/**", "test/**" ], "rules": { "import/no-unresolved": "off" } } ] }
ESLint 公式 Web サイト(英語)から ESLint および react プラグイン構成の詳細を学びましょう。
React アプリケーションを構築する
既存の PyCharm プロジェクトに React をインストールした場合は、ビルドプロセスを設定する必要があります。 React オフィシャル Web サイト(英語)から React アプリケーションのビルドパイプラインを構成するさまざまな方法について説明します。
プロジェクト内で複数のフレームワークを使用する
場合によっては React プロジェクト内で他のフレームワークを使用する必要があることがあります。
各ファイルでコンテキスト認識コーディング支援を受けるには、構成ファイル .ws-context を作成し、各ファイルまたはフォルダーで使用するフレームワークを指定します。 このファイルの設定は、デフォルトの構成を上書きします。
プロジェクトルートで、コンテキストメニューから 新規 | ファイル を選択し、ファイル名として
.ws-contextを指定します。.ws-contextでは、次の 2 種類のプロパティを使用します。コンテキスト値文字列を持つ
<context-name>コンテキスト詳細オブジェクトを持つ GLOB パターン
次のコンテキスト値を使用します:
framework:vue、angular、react、svelte、astroangular-template-syntax:V_2、V_17ドライバー:
nextjs-projectドライバー:
astro-projectvue-store:vuex、piniavue-class-component-library:vue-class-component、vue -property-decorator、vue-facing-decoratorjsdoc-dialect:jsdoc-typescript、jsdoc-closure
簡潔にするためパスのネストを使用します。
GLOB パスの最後のセグメントはファイル名パターンであり、
*ワイルドカードのみがサポートされます。最後のセグメントが
**の場合、ネストされたすべてのディレクトリとファイルと一致します。最上位レベルのコンテキストプロパティには
/**パターンが必要です。
複数のパターンが同じファイル名に一致する場合、曖昧さを解消するために次のルールが使用されます:
**セグメントを除いて、パスセグメント数が最大となるパターンを選択します。純粋なファイル名パターン、つまり
**または/で終わらないものを選択してください。最初に定義されたパターンを選択します。
サンプル
さまざまなフォルダーで複数のフレームワークを使っているプロジェクトがあるとします。

プロジェクト内の各ファイルに対してコンテキスト認識型の支援を受けるには、次のコードを .ws-context に追加します。









