JavaScriptやTypeScriptのプロジェクトでコードの品質を保つためには、ESLintやPrettierの導入がとても重要です。本記事では、それぞれの役割の違いや、併用する方法、導入手順を初心者向けに丁寧に解説します。
ESLint
は、JavaScriptやTypeScriptのコードに潜むエラーや、ベストプラクティスに反する記述を検出してくれる「静的解析ツール」です。例として、「未使用の変数」や「構文ミス」などを検出し、警告を表示してくれます。
Prettier
は、コードの見た目(整形)に特化した「コードフォーマッター」です。インデントやセミコロン、クォーテーションの統一など、読みやすいコードに自動で整えてくれます。エラー検出は行いません。
つまり、ESLint
は「ルールに違反していないかを検査」、Prettier
は「見た目を整える」ツールです。
ESLintとPrettierを併用することで、コードの構文やルール違反を防ぎつつ、見た目も統一された読みやすいコードを保てます。ただし、ルールが重複しないように設定を調整する必要があります。
1npm install --save-dev eslint prettier eslint-config-prettier eslint-plugin-prettier
1npx eslint --init
対話形式で質問に答えると、適切な設定が自動で生成されます。
.eslintrc.js
に設定を追加1module.exports = {
2 extends: [
3 'eslint:recommended',
4 'plugin:prettier/recommended'
5 ],
6 plugins: ['prettier'],
7 rules: {
8 'prettier/prettier': 'error'
9 }
10};
.prettierrc
を作成(任意)1{
2 "semi": false,
3 "singleQuote": true
4}
1npx eslint . --fix
1npx prettier . --write
チーム開発や長期運用されるプロジェクトでは、ESLintとPrettierを導入して、コードの品質と統一性を確保することが非常に重要です。ぜひプロジェクトに取り入れてみてください。