Open4

prettierでコードをフォーマットしたい

cordeliacordelia

目的

フレームワークを使わずにシンプルなNode環境だけで動かします。


手順

package.jsonを作成します。

npm init -y


Prettierをプロジェクトにインストールします。

npm i -D  prettier


プロジェクト直下にPrettierの設定ファイル.prettierrcを作成します。今回は何も書かずにデフォルト設定でフォーマットします。

.prettierrc
{
本来はここに設定を書く
}


不要なフォーマットを避けるための設定ファイル.prettierignoreを作成します。このファイルに書かれたものはフォーマットの対象外になります。

以下は設定例です。.prettierrcとマークダウンファイルをフォーマットの対象外にします。

.prettierignore
.prettierrc
*.md


index.jsを作成して適当なコードを書きます。

index.js
const users=['alice',"bob","charlie"]


package.jsonに以下のスクリプトを設定してフォーマットを実行します。

package.json
"scripts": {
  "format": "prettier . --write"
}
npm run format


フォーマット前と後のindex.jsの変化

index.js
// フォーマット前
const users=['alice',"bob","charlie"]

// フォーマット後
const users = ["alice", "bob", "charlie"];


最終的なディレクトリ構成

/
├── node_modules
├── .prettierignore
├── .prettierrc
├── index.js
├── package-lock.json
├── package.json
└── README.md
cordeliacordelia

メモ

  • 拡張子ごとに別の設定を適用したい
cordeliacordelia

メモ

  • npm i --save-exact の意味
  • ファイルごとに別の設定を適用するには?
  • インストールする時はdevDependencysにすること。開発時以外は必要ないから