Prettier
Prettier (英語) は、 TypeScript、JavaScript、CSS、HTML、JSON などのさまざまな言語でファイルをフォーマットするツールです。PyCharm では、Prettier で整形アクションを使用して、ファイルまたはディレクトリ全体だけでなく、選択したコードフラグメントもフォーマットできます。PyCharm は、プロジェクト内の依存関係として、またはコンピューター上にグローバルに Prettier をインストールするとすぐに、このアクションを追加します。
特定のファイルが変更されるたびに再フォーマットし、変更が自動または手動で保存されるように Prettier を設定できます。保存時に Prettier を自動的に実行するを参照してください。
また、Prettier を特定のファイルのデフォルトのフォーマッタとして設定することもできます。Ctrl+Alt+L でコードを再フォーマットするたびに、このようなファイルに対して実行されます。
詳細は、Prettier でコードを整形を参照してください。
始める前に
お使いのコンピューターに Node.js(英語) がインストールされていることを確認してください。
プロジェクトでローカル Node.js インタープリターが設定されていることを確認します。設定ダイアログ (Ctrl+Alt+S) を開き、 に移動します。Node インタープリターフィールドには、デフォルトのプロジェクト Node.js インタープリターが表示されます。詳細については、ローカル Node.js インタープリターの構成を参照してください。
設定 | プラグインページのインストール済みタブで、JavaScript and TypeScript および Prettier に必要なプラグインが有効になっていることを確認します。詳細については、「プラグインのマッピング」を参照してください。
Prettier をインストールする
埋め込まれたターミナル (Alt+F12) を開きます。
次のいずれかのコマンドを入力します。
npm install --save-dev --save-exact prettier
npm install --global prettier
Prettier オフィシャル Web サイト(英語)のインストールモードの詳細を参照してください。
PyCharm で Prettier を構成する
設定ダイアログ(Ctrl+Alt+S)で、言語 & フレームワーク | JavaScript | Prettier に移動します。
PyCharm は Prettier を有効にし、上記のようにインストールするとすぐに Prettier で整形アクションを追加します。Prettier をオフにするには、Prettier を無効にするを選択します。
Prettier パッケージと構成ファイルを検出する方法を選択します。
自動 Prettier 構成 : このモードでは、PyCharm は最も近い node_modules (再フォーマットするファイルと同じフォルダーまたはその親フォルダーにある) の Prettier パッケージを使用し、最も近い .prettierrc.* 構成ファイルを検索します。
その結果、プロジェクトが異なる Prettier 構成を持つ複数のモジュールで構成されている場合、各モジュールは独自の Prettier 構成ファイル (そのような構成が見つかった場合) のルールを使用します。
手動 Prettier 構成 : このモードでは、Prettier パッケージと指定された構成ファイルのルールがプロジェクト内のすべてのモジュールに適用されます。
Prettier パッケージリストから、使用する
prettier
インストールを選択します。標準のインストール手順に従った場合、PyCharm はprettier
パッケージ自体を見つけて、フィールドに自動的に入力されます。Prettier をデフォルトのフォーマットツールとして設定するには、'コードの整形' アクション時に実行チェックボックスを選択します。
保存されたファイルに Prettier を自動的に適用するには、保存時チェックボックスを選択します。
Prettier のスコープを設定する
設定ダイアログ (Ctrl+Alt+S) で、言語 & フレームワーク | JavaScript | Prettier に移動します。ファイルに対して実行フィールドで、ファイルが保存されるとき、コードの整形アクションが呼び出されたときに Prettier が自動的に適用されるファイルパターンを指定します。
デフォルトのパターンでは、**/*.{js,ts,jsx,tsx,cjs,cts,mjs,mts,vue,astro}
、Prettier が JavaScript、TypeScript、JSX、TSX、HTML、Vue、Astro ファイルに適用されます。他の種類のファイルや特定のフォルダーに保存されているファイルを再フォーマットするには、glob パターン(英語)を使用してデフォルトのパターンを更新します。
例: CoffeeScript ファイルも自動的に再フォーマットするには、次のように
coffee
をデフォルトパターンに追加します。**/*.{js,ts,jsx,tsx,cjs,cts,mjs,mts,vue,astro,coffee}サブフォルダーを含む特定のフォルダーからファイルを再フォーマットするには、
**/*
を<path to the folder>/**/*
に置き換えます。次のような構造のプロジェクトがあるとします。
coffee フォルダー内のファイルのみを再フォーマットするには、次のようにパターンを更新します。
coffee/*.{js,ts,jsx,tsx,cjs,cts,mjs,mts,vue,astro,coffee}その結果、ファイル reformat.coffee は再フォーマットされますが、no_reformatting.coffee は再フォーマットされません。
詳細については、保存時に Prettier を自動的に実行するおよび Prettier をデフォルトのフォーマッターとして設定するを参照してください。
Prettier でコードを整形
エディターで、再フォーマットするコードフラグメントを選択します。ファイルまたはフォルダーを再フォーマットするには、プロジェクトツールウィンドウで選択します。
次に、コンテキストメニューから Prettier で整形を選択します。
特定のファイルが変更されるたびに再フォーマットし、変更が自動または手動で保存されるように Prettier を設定できます。保存時に Prettier を自動的に実行するを参照してください。
また、Prettier を特定のファイルのデフォルトのフォーマッタとして設定することもできます。Ctrl+Alt+L でコードを再フォーマットするたびに、このようなファイルに対して実行されます。
この動作は、現在のプロジェクトだけでなく、すべての新しいプロジェクトでも有効にできます。
保存時に Prettier を自動的に実行する
設定ダイアログ(Ctrl+Alt+S)を開き、 に移動して、保存時に実行チェックボックスを選択します。
ファイルに対して実行フィールドで、ファイルが保存されるたびに再フォーマットされるファイルのセットを定義するパターンを指定します。デフォルトのパターンを受け入れるか、カスタムパターンを入力できます。
デフォルトのパターンである
**/*.{js,ts,jsx,tsx,vue,astro}
を使用すると、Prettier が起動して更新および保存された JavaScript、TypeScript、JSX、TSX ファイルを処理します。他のタイプのファイルまたは特定のフォルダーに保存されているファイルを再フォーマットするには、glob パターン(英語)を使用してデフォルトのパターン(英語)を更新します。例: スタイルシートファイルも自動的に再フォーマットするには、次のようにデフォルトパターンに
css,sass,scss
を追加します。**/*.{js,ts,jsx,tsx,vue,astro,css,scss,sass}サブフォルダーを含む特定のフォルダーからファイルを再フォーマットするには、
**/*
を<path to the folder>/**/*
に置き換えます。次のような構造のプロジェクトがあるとします。
Prettier を src フォルダー内のファイルにのみ自動的に適用するには、次のようにパターンを更新します。
src/*.{js,ts,jsx,tsx,vue,astro}その結果、ファイル dog.ts は保存時に再フォーマットされ、animal.ts は変更されません。
Prettier をデフォルトのフォーマッターとして設定する
設定ダイアログ(Ctrl+Alt+S)を開き、 に移動します。
手動 Prettier 構成を選択し、'コードの整形' アクション時に実行チェックボックスをオンにします。Prettier 構成の詳細については、Prettier パッケージと構成ファイルを検出する方法を選択するを参照してください。
ファイルに対して実行フィールドで、常に Prettier で再フォーマットされるファイルのセットを定義するパターンを指定します。デフォルトのパターンを受け入れるか、保存時に Prettier を自動的に実行するに従ってそれをカスタマイズします。
新しいプロジェクトの保存時または再フォーマット時に実行するように Prettier を構成する
に進みます。開いたダイアログで、 に移動します。
'コードの整形' アクション時に実行および
On save
チェックボックスを使用して、Prettier をトリガーするアクションを指定します。必要に応じて、保存時に Prettier を自動的に実行する説明に従って、ファイルに対して実行フィールドのデフォルトパターンを更新します。
Prettier コードスタイルルールを適用する
PyCharm は、Prettier の構成から PyCharm コードスタイル設定にキーコードスタイルルールを適用して、生成されたコード(リファクタリングやクイックフィックス後など)と Prettier ですでに処理されたコードが一貫してフォーマットされるようにできます。
Prettier が有効になっているプロジェクトで、package.json を開き、タブ上部のペインではいをクリックします。
Prettier コードスタイルを再適用するには(ペインでいいえをクリックするかコードスタイルを変更した後)、Ctrl+Shift+A を押してアクションの検索リストから Prettier コードスタイルルールを適用するを選択します。
Prettier オフィシャル Web サイト(英語)から Prettier コードスタイルルールを構成する方法の詳細を参照してください。
関連ページ:
Node.js
Node.js は、サーバーやコマンドラインなど、ブラウザーの外部で JavaScript を実行するための軽量ランタイム環境です。PyCharm は Node.js と統合されており、アプリケーションの構成、編集、実行、デバッグ、テスト、プロファイリング、保守を支援します。Node.js がアプリケーションのローカルランタイムとして、または npm パッケージの管理、JavaScript リンターの実行、ツールのビルド、フレームワークのテストなどにのみ必要な場合は、Node.js をインストールす...
プラグインのインストール
プラグインは PyCharm のコア機能を拡張します。例: プラグインをインストールして、次の機能を取得します。バージョン管理システム、課題追跡システム、ビルド管理サーバー、その他のツールとの統合。さまざまな言語とフレームワークのコーディング支援サポート。ショートカットのヒント、ライブプレビュー、ファイルウォッチャーなど。新しいプログラミング言語を学ぶのに役立つコーディング演習。プラグイン設定を開くを押して設定を開き、を選択します。マーケットプレースタブを使用して、JetBrains マーケット...
PhoneGap と Cordova
PhoneGap と Apache Cordova は、単一の HTML、CSS、Javascript/Typescript コードベースを使用してモバイルアプリケーションを開発し、Android を含むさまざまなモバイルプラットフォームをターゲットにするためのフレームワークです。始める前に:お使いのコンピューターに Node.js がインストールされていることを確認してください。JetBrains マーケットプレイスからプラグインをインストールする説明に従って、設定 | プラグインページのマーケットプレ...
React のサポート
React は、カプセル化されたコンポーネントから複雑なインタラクティブユーザーインターフェースを構築するための JavaScript ライブラリです。React オフィシャル Web サイトからライブラリの詳細を参照してください。PyCharm は、React と統合され、lint の設定、編集、実行、デバッグ、アプリケーションの保守を支援します。始める前に:お使いのコンピューターに Node.js がインストールされていることを確認してください。設定 | プラグインページのインストール済みタブで...