🍣
VS Code + Cursor で自動整形を始めてみる
VS Code + Cursor で開発する際に、prettierなどを使用しての開発は必須だと思います。
以下の設定を.vscode/settings.json
に書くだけで、Prettier を使ったフォーマットと未使用 import の削除&ソートが自動で行われます。
{
// 保存時にコードを整形
"editor.formatOnSave": true,
// 整形に Prettier を使う
"editor.defaultFormatter": "esbenp.prettier-vscode",
// 保存時に未使用 import を削除&並び替え
"editor.codeActionsOnSave": {
"source.organizeImports": "explicit"
}
}
設定を順毎に解説すると以下になります。
-
formatOnSave
保存(Ctrl + S)すると、Prettier が自動でコードを整形してくれます。 -
defaultFormatter
複数のフォーマッタが入っているときに「Prettier」を明示的に指定します。 -
organizeImports
未使用の import を削除し、残った import 文をアルファベット順などに並び替えます。
Cursor 拡張との連携
もし Cursor(コード補完/ナビゲーション拡張)を入れているなら、この設定と併用することで、書きかけのコードを補完後に即整形→保存でき、さらに快適になります。
- コマンドパレット(⌘ + Shift + P)で「Format Document」を実行すれば、手動でも整形可能
- 保存時以外にショートカットでも整形可能
- Windows: Shift + Alt + F
- Mac: Shift + Option + F
終わりに
最近PCを買い替えて設定方法を忘れてしまったので、改めて記事にまとめました。
誰かの役に立てば幸いです!
もしおすすめの設定や他の便利な拡張があれば、コメントで教えてください。
Discussion