LoginSignup
31
23

More than 3 years have passed since last update.

VSCodeでファイル保存時にPrettierを走らせる方法

Posted at

はじめに

macOSを新しく買ってVsCodeをインストールし直した時にファイル保存時にPrettierを走らせる設定方法を忘れてしまい半日以上溶かした。

ググってみたけど体系的にまとまった情報がなくてなかなか時間を溶かしたので

はじめての方でも、この記事を見れば「VSCodeユーザーなら誰でもファイル保存時にPrettierを走らせることができる」ようにいちから丁寧に記事を書いた。

対象読者

  • VSCodeユーザー
  • ファイル保存時にPrettierが走らない人

目次

  1. PrettierをVSCodeにインストール
  2. defaultFormatterの設定を変更する
  3. Format On Saveにチェックを入れる
  4. Settings及びPluginを反映させる為にいったん画面をReloadする

1. PrettierをVSCodeにインストール

VSCodeからインストールする方法とブラウザからインストールする方法がある。

VSCodeを立ち上げて、Prettier -Code formatter の拡張機能タブが表示されたら、[インストール]ボタンをクリックする。これでPrettierが有効になります。

VSCodeからではなく以下のリンクから「install」ボタンをクリックしてもいけます。
Prettier

下の画像のように、VSCodeのインストール済みのところにあればOK。
スクリーンショット 2020-10-26 16.04.58.png

2. defaultFormatterの設定を変更する

まず、VSCodeの設定画面を開く

開くには画面左下の:gear:アイコンから「Settings」を選択すればいい

ちなみにショートカットキーを使えば一発で開けるので参考まで
(macOSの場合 : 「 command + , 」 windowsの場合 : 「 ctrl + , 」)
設定画面.png

次に「defaultformatter」と検索する
null.png

最後に「Default Formatter」を「null」から「esbenp.prettier-vscode」に変更する
defaultformatter.png

3. Format On Saveにチェックを入れる

VSCodeの設定画面を開き「save」と検索する
スクリーンショット 2020-10-26 16.28.50.png

次に「Format On Save」にチェックマークを入れる
スクリーンショット 2020-10-26 16.28.55.png

4 Settings及びPluginを反映させる為にいったん画面をReloadする

これをやらないと設定が反映されないから注意!

「command + shift + P」でコマンドパレットを開き
「Reload Window」をクリックして画面をリロードさせる

(windowsの場合「ctrl + shift + P」でコマンドパレットを開ける)

まとめ

これでファイル保存時にPrettierが走るはず。Just do it!

参考文献

Vscode上でファイル保存時にPrettierを走らせる
デフォルト整形ツールにPrettierを使う
Prettier入門 ~ESLintとの違いを理解して併用する~

31
23
2

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
31
23