1
3

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

More than 3 years have passed since last update.

【初心者向け】Visual Studio Code への Prettier 導入について

Last updated at Posted at 2021-01-07

Prettier は、JavaScript、TypeScript、CSS、HTML などのコードフォーマッタでソースコードの自動整形をすることができるソフトウェアです。

これを Visual Studio Code (VS Code) に組み込む際に色々なサイトを参考にさせて頂きましたが、 VS Code のプラグインだけインストールすれば良いのか npm module をインストールする必要があるのか非常に分かりにくかったため、ここに覚え書きしておきます。

導入方法についてはこちら → Visual Studio Code へ ESLint と Prettier を導入する

結論

結論からいうと、

  • コードエディタとして VS Code のみを利用する場合は、npm module のインストールは不要
  • 他のエディタを使用する場合は、npm で prettier をインストールしてコマンドラインから prettier を実行する必要がある
  • つまり、プロジェクトなどで開発者が別々のエディタを使用している場合は npm module を導入する必要がある

Prettier - Code formatter

VS Code の Prettier プラグインはこちら。

名称 plugin id
Prettier - Code formatter esbenp.prettier-vscode
  • このプラグインは prettier 本体がバンドルされており、インストールするだけでコードフォーマッティングができる。
  • デフォルトでは、プロジェクトのpackage.json1prettierが含まれている場合は、ローカルインストールされた npm module の prettier を優先して使用する。
  • ただし、ローカルインストールされた npm module の prettier がない場合は、プラグインにバンドルされた prettier を使用する。
  • ローカルインストールされた npm module がない場合、かつ VS Code設定 (settings.json) のprettier.resolveGlobalModulestrueになっている場合は、グローバルインストールされた npm module の prettier を使用する。
  • ただし、上記と同様にグローバルインストールされた npm module の prettier がない場合は、プラグインにバンドルされた prettier を使用する。

参考サイト

Prettier - Code formatter


  1. ローカルインストールの npm module が記載されたファイル 

1
3
0

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
1
3

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?