※このブログではサーバー運用、技術の検証等の費用のため広告をいれています。
記事が見づらいなどの問題がありましたらContactからお知らせください。


【TypeScript】PrettierによるVSCode上での自動フォーマット設定

VSCode TypeScript Prettier 自動フォーマット

投稿日:2020年11月29日

このエントリーをはてなブックマークに追加
この記事ではTypeScriptでPrettierの設定をし、VSCodeで自動フォーマットする方法について解説しています。

はじめに

この記事について

この記事ではTypeScriptでPrettierの設定をし、VSCodeで自動フォーマットする方法について解説しています。

Prettier

Prettierは複数の言語をサポートするコードフォーマッタです。

簡単にコードをキレイに整えたりすることができ、複数のエディタでサポートされているためWebエンジニアにはおすすめのフォーマッタです。

Prettierがどの様にフォーマットするのか気になる方は次のサイトから動作を試してから考えると良いでしょう。


実践

まずはプロジェクトを作成してnpmで初期化しましょう。

プロジェクトのディレクトリ名はprettier_tsとします。

ターミナル
$ mkdir prettier_ts # プロジェクトを作成
$ cd prettier_ts
$ npm init # 全てデフォルトを選択

次に必要なパッケージのprettierをインストールします。

ターミナル
$ npm install --save-dev prettier

インストールできたらPrettierの設定ファイル.prettierrcを作成します。

設定値については公式ドキュメントを参考にしましょう。

.prettierrc
{
  "semi": true,
  "trailingComma": "none",
  "singleQuote": true,
  "printWidth": 80
}

これでPrettierが正しく使えるか確認してみます。

まずは適当なTypeScriptファイルを作成します。

index.ts
function sample(username:string){console.log(username)}
const a=10;

今回パッケージはPrettierはローカルにインストールしたのでnpxから呼び出します。

ターミナル
$ npx prettier --config ./.prettierrc --write index.ts

index.tsを確認するとキレイに改行やスペースの入れられたコードが確認できると思います。

index.ts
function sample(username: string) {
  console.log(username);
}
const a = 10;

VSCodeの拡張機能をインストールします。

拡張機能としてesbenp.prettier-vscodeを検索しインストールします。

Ctrl + ,で設定を開き、Format On Saveにチェックを入れDefault Formatteresbenp.prettier-vscodeを設定します。

右上の設定(UI)を開くからsettings.jsonを開き、以下の設定を追加することでこの設定をすることができます。

settings.json
[...]

"editor.defaultFormatter": "esbenp.prettier-vscode",
"editor.formatOnSave": true,

[...]

これでPrettierの設定は完了です。

これでTypeScriptファイルを作成して保存してみましょう。

自動的にフォーマットされるはずです。

このエントリーをはてなブックマークに追加


関連記事

記事へのコメント
    
検索