eslint-plugin-vueの導入
本レッスンはVue.jsでESLintを使用するプラグイン「eslint-plugin-vue」についてのレッスンです。
コードの書き方は個人のクセや好みによって書き方にばらつきがあります。しかし、そのばらつきを許容すると以下のような問題が生まれます。
- 共同作業者がコードを読みにくくなる
- 不要な差分がGitに現れることがある
それを防ぐのがESLintと呼ばれる、JavaScriptのコードチェッカーです。書き方のばらつきや使用していない変数をチェックすることでコードの品質を一定に保つ働きがあります。
プロジェクトメンバーで決めた、コードの末尾にセミコロンを付けるか、シングルコーテーションかダブルコーテーションか、という記法やチェックの厳しさといったルールを独自に設定できます。
npmコマンド
Vue CLIにはデフォルトでESLintが入っています。package.jsonを開くと、devDependenciesの項目にeslintがあるのがわかりますね。また、scriptsの項目にlintというコマンドがあります。このコマンドを実行すると、コードのチェックや一部のコード(セミコロンの有無など)を設定した形式に自動で変換してくれます。
試しに、App.vueからセミコロンを消去して、lintコマンドを実行してみましょう。
// 末尾のセミコロンを消去した
import HelloWorld from "./components/HelloWorld.vue"
▼ターミナルで以下を実行
npm run lint
結果は以下のようになりました。src\App.vueが自動で修正されたと表記されています。
> vue-cli-service lint
The following files have been auto-fixed:
src\App.vue
DONE All lint errors auto-fixed.
Done in 1.56s.
実際の現場ではhuskyやlint-stagedと呼ばれるプラグインまたはCIと組み合わせることで、Gitのコミット時やプッシュ時に自動でフォーマットされるような運用もされています。
この続きはPlusプラン限定です