16
10

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.

webstormでeslintとprettierを保存時に自動反映させる

Last updated at Posted at 2020-08-12

はじめに

WebStormを利用してプロジェクトごとに設定された.prettierrc.eslintrc.jsonファイルを元に保存時にコードを自動整形する設定方法を記載しています。
一度設定しておくと、開発効率が爆上がりするのでとてもおすすめです!

prettier設定

prettierは.js, .ts, .tsx, .css, .less, .scss, .jsonなどのファイルをフォーマットしてくれます。

プロジェクトのルートに.prettierrcという設定ファイルを配置しておきます。

導入手順は以下の通りです。
0. 事前設定
Node.jsのインストール

  1. prettier導入
    プロジェクトかグローバルにprettierを導入する

    • プロジェクト用prettier

npm install --save-dev --save-exact prettier

    - グローバル用prettier
  
    ```
npm install --global prettier
  1. WebStormの設定
    WebStormメニューのSettings/Preferences (⌘,)から
    Languages and FrameworksタブのJavaScript
    Prettierを選択 (下図の赤線参照)

Node interpreter:はデフォルト
Prettier package:はプロジェクトでprettierをインストールした場合はプロジェクトのprettierのパスを指定

最後にOn code reformatOn saveのチェックボックスにチェックをいれます。(下図の緑線参照)
これによって保存時にprettierの整形が実施されます。

prettier.png

Prettier - Help | IntelliJ IDEA - JetBrains

eslint設定

eslintはコードが設定ファイルのルールに従っているか文法チェック(リント)してくれます。コマンド実行時に--fixオプションをつけると修正までしてくれます。

プロジェクトのルートに.eslintrc.jsonという設定ファイルを配置しておきます。

導入手順は以下の通りです。
0. 事前設定
Node.jsのインストール

  1. eslint導入
    プロジェクトかグローバルにeslintを導入する

    • プロジェクト用eslint

npm install --save-dev eslint

    - グローバル用eslint
  
    ```
npm install --g eslint
  1. WebStormの設定
    WebStormメニューのSettings/Preferences (⌘,)から
    Languages and FrameworksタブのJavaScriptCode Quality Tools
    ESLintを選択 (下図の赤線参照)

Node interpreter:はデフォルト
ESLint package:はプロジェクトでeslintをインストールした場合はプロジェクトのeslintのパスを指定

Configuration FileAutomatic searchを選択します。
*デフォルト(Automatic search)でプロジェクトのnode_modulesフォルダーのESLintパッケージと、現在のファイルが保存されているフォルダーの.eslintrc.構成ファイルを使用します。

最後にRun eslint --fix on saveのチェックボックスにチェックをいれます。(下図の緑線参照)
これによって保存時にeslintのリントと修正が実施されます。

 eslint.png

ESLint - 公式ヘルプ | IntelliJ IDEA

(番外編) editorconfig設定

WebStormの場合はデフォルトでプロジェクト直下の.editorconfigの内容はエディターに反映されます。そのため、特段設定はいりません。
.editorconfigを使って設定していることもあるので知識として知っておくといいと思います。

終わりに

雑にコードを書いていってもprettierとeslintによって規定されたコード形式で保存されていくので、コミット作業がとても楽になります。

ただ、eslintの実行が少し重たいのが難点かなとも感じています。。

参照

Prettier - Help | IntelliJ IDEA - JetBrains
ESLint - 公式ヘルプ | IntelliJ IDEA

16
10
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
16
10

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?