VSCodeでPythonとPrettierを使う方法

VSCodeでPythonとPrettierを一緒に使う方法を紹介します。この設定により、Pythonと他の言語のコードを同じフォーマッタで整形することが可能になります。

Prettierとは

PrettierはJavaScript, TypeScript, YAML, HTMLなど多くの言語に対応したコードフォーマッタです。しかし、Pythonには対応していません。そのため、Pythonのコードを整形するためには、Python専用のフォーマッタであるBlackを使用します。

Prettierのインストール

VSCodeでPrettierを使用するには、まず拡張機能をインストールします。VS CodeのExtension panelでPrettier-Code Formatterを検索し、インストールします。

その後、VSCodeの設定を開き、editor.defaultFormatterを検索して、Prettier-Code Formatterを選択します。これで、デフォルトのフォーマッタをPrettierに設定することができます。

Blackのインストール

次に、Python専用のフォーマッタであるBlackをインストールします。以下のコマンドでBlackをインストールできます。

pip3 install black

その後、VSCodeの設定を開き、python.formatting.providerを検索して、blackを選択します。

しかし、このままではPythonのコードでもデフォルトのフォーマッタであるPrettierが適用されてしまい、エラーが出る可能性があります。そのため、Pythonのコードの場合だけはPrettierではなくBlackを適用するように設定を追加します。

PythonのコードにBlackを適用する設定

VSCodeの設定を開き、settings.jsonを開きます。その中に以下の設定を追加します。

"[python]": {
    "editor.defaultFormatter": null,
}

これにより、Pythonのコードの場合だけはPrettierではなくBlackが適用されるようになります。

以上がVSCodeでPythonとPrettierを一緒に使う方法です。この設定により、Pythonと他の言語のコードを同じフォーマッタで整形することが可能になります。