目次

はじめに

環境構築ができるようになろう
環境構築スキルの習得は難しい
対象読者
本書が扱う内容
筆者の動作環境とサンプルコードについての注意事項
謝辞

第1章 Node.jsを使ったビルド環境整備

1.1 Node.jsとは
1.2 Node.jsのインストール
1.3 JavaScriptプロジェクトを管理する
1.4 ライブラリに付随するコマンドを実行する
1.5 まとめ

第2章 Babelを使ったトランスパイル

2.1 Babel とは
2.2 Babelを実行する
2.3 pluginとは
2.4 複数のpluginをpresetで管理する
2.5 ブラウザの差異をpolyfillで管理する
2.6 まとめ

第3章 TypeScriptを使ったコンパイル

3.1 TypeScriptとは
3.2 tscのインストール
3.3 Reactを動かす
3.4 まとめ

第4章 webpackを使ったバンドルとビルド

4.1 webpackの使い方
4.2 webpackの設定ファイル
4.3 まとめ

第5章 ESLintを使った静的解析

5.1 ESLintのしくみ
5.2 ESLintの使い方
5.3 ESLintで設定する項目
5.4 TypeScriptとReact用の設定をする
5.5 まとめ

第6章 Prettierを使ったフォーマット

6.1 prettierの使い方
6.2 ESLintとの協調
6.3 TypeScriptとの協調
6.4 まとめ

第7章 Storybookを使ったコンポーネント管理

7.1 Storybookを設定する
7.2 Storybookをaddonで拡張する
7.3 まとめ

第8章 Jestを使ったテスト

8.1 Jestの使い方
8.2 Reactのテスト
8.3 Jestで設定する項目
8.4 まとめ

第9章 0から環境を作ってみる

9.1 Node.jsの設定
9.2 TypeScriptの設定
9.3 webpackの設定
9.4 Prettierの設定
9.5 ESLintの設定
9.6 ESLintとPrettierを共存させる設定
9.7 Jestの設定
9.8 StoryBookの設定
9.9 まとめ

付録A バージョンの追従

A.1 環境構築で増えすぎた依存
A.2 package gardening
A.3 CI
A.4 各種レポートのホスティングとプレビュー

さいごに

はじめに

 本書は、コピー&ペーストに頼らない環境構築ができるようになるための本です。技術書典応援祭1で出版した、「JavaScript環境構築の設定をひとつずつ丁寧に-そのプラグインってどうして必要なの!?-2」という同人誌が原案になっています。私自身がフロントエンド環境構築がとても苦手で、克服するために勉強したことを、その同人誌にまとめました。私はそのときの執筆やレビューを通して、なぜそのツール・プラグインが必要なのか を明らかにすると、理解が深まることに気付きました。そこで、「プラグインの役割に着目しながら、環境構築をおさらいできるような教材を作れないか」と思い、本書を執筆しています。本書が、環境構築が苦手という方にとって、よき教材や手引きとなればうれしいです。

環境構築ができるようになろう

 フロントエンドにおける環境構築は、年々複雑化しています。昔は、スクリプトタグでライブラリを読み込むだけで、開発に必要なものをそろえていました。しかし今では、ビルドや静的検証のパイプラインを構築する、といったこともするようになっています。それに伴い、Package Manager、Transpiler、Bundler、Linter、Formatter、Test Runner、AltJSなど、たくさんの周辺ツールも生まれました。もちろん、ビルドという観点だけで見ると全部は不要ですが、開発効率を上げるという点では、押さえておきたいツールたちです。それらを押さえた上で、ビルドのパイプラインを組み立てることが要求されることもあり、ただHello Worldするだけの難易度は上がっています。

なぜ環境構築を覚える必要があるのか

 環境構築に要求されるツールが増える一方で、便利なプリセットも生まれており、簡単に構築を済ませられるツールも生まれています。たとえばcreate-react-appやNext.jsは、環境構築を代替できる便利なツールです。しかし、手組みで環境構築した経験がなければ、いざ手組みで整備しなければいけなくなった場合に苦労します。もしかしたら、将来的にビルドを別のツールと連携しながら行うことや、何らかの最適化を行うことが必要になってくるかもしれません。そのような事態に備え、環境構築は手組みでゼロからできるようになっておいた方が良いと、筆者は考えています。

環境構築スキルの習得は難しい

 そこで、環境構築スキルの習得を目指していきたいのですが、挫折するポイントが多く潜んでいます。そのため、独学では困難だと、筆者は感じています。

経験値を得づらい

 そもそも、仕事で環境構築をする機会は少ないです。環境構築を行う時期は、プロジェクトが立ち上がるときか、非機能要件の磨き込みに時間を割けるときです。

デバッグのしづらさと成長のしづらさ

 環境構築をデバッグするためには、ある程度が動くようにしてからではないと難しいです。そのため、どこが原因で動かないかという原因の切り分けがしづらい分野です。デバッグの末に、仮にビルドに成功しても、どの修正によって成功したかの判断がつかないこともあります。たとえば、「実は間違ったことをしていたけど、ビルドだけは通るようになった」ということもあります。

対象読者

 そこで本書では、環境構築に挑戦したい人に向けて、少しずつ動かしながら「こう設定すればこうなる」を理解できるような説明を心がけました。

 そのため本書は、ビルド設定に困っている自分でもビルド環境を作れるようになりたいという方向けに書かれており、JavaScript の初学者に向けては書かれていません。なるべく基本的な用語や概念も解説するようにはしましたが、それでも説明不足に感じるところがあるかもしれません。

 また、各章は独立しているため、自分の読みたい章から読めます。ただし、環境構築の全体感を想像できない方は、最初から読むことをお勧めします。第9章の「0から環境を作ってみる」は、いわゆる「やってみた」という内容で、実践的なハンズオンです。写経をすれば、全体の雰囲気をつかむことができるでしょう。ソースコードも公開しています。3

 タイトルではReactを扱うと書いていますが、ここで紹介するツールやエコシステムは、React以外のフレームワークやライブラリを使った開発においても使われているものです。Reactを使わない開発者にとっても、CLIやプリセットに頼らない開発をする場面では、本書が役に立つかもしれません。もし気になる場合は、目次を確認してください。

本書が扱う内容

 本書では、フロントエンドアプリケーションのビルドと検証をするための方法を学びます。各章では次のような内容を扱います。

 ・実行基盤となるNode.js(エコシステムの基盤)

 ・Babelによるトランスパイル(ビルド)

 ・TypeScript Compilerによるトランスパイル(ビルド)

 ・webpackによるバンドル(ビルド)

 ・ESLintによるリント(検証)

 ・Prettierによるフォーマット(検証)

 ・Jestによるテスト(検証)

 ・Storybookによるコンポーネント管理(検証)

 環境構築に登場するツールの役割は、大きくビルドか検証ツールかに分けられ、それぞれに代表的なライブラリが存在します。そのライブラリの数はさほど多くはありませんが、それらに多くのプラグインを挿していくので、結果的には利用するライブラリの数が膨大になります。ビルド複雑化の原因は、大量に挿すプラグインにあると言っても過言ではありません。本書では、プラグインを挿される側のライブラリの粒度で、章を分けて整理します。そして、それぞれで利用するプラグインの役割を紹介していくことで、説明を図っています。そのため、章ごとにツールとプラグインの役割を確認しながら読み進めると、役割に関する混乱は緩和できます。

筆者の動作環境とサンプルコードについての注意事項

 ・筆者のPC環境は、macOS Catalina(Version:10.15.2)です。Node.jsの環境はv12.16.3で、nvm(v0.35.3)で管理しています。

 ・第9章は、完全な形でのサンプルコード4を提供しています。本書で使ったライブラリのバージョンは、ここに書かれているpackage.jsonのものです。

 ・各章ではコマンドの出力を表記していますが、誌面の都合で適宜編集を加えています。

謝辞

 ・クレスウェア代表の奥野賢太郎さん(@okunokentaro)、長年TypeScriptを利用されている経験や、過去の執筆経験からアドバイスをいただき、ありがとうございました。レビューを通してお互いに異なる方針を持っていたことがわかり、それを議論できたことも楽しかったです。

 ・TechBowl CEOの小澤政生さん(@zawamasa)、日本最大級のエンジニアコミュニティTechTrain のメンターやメンティーにレビューを依頼できる仕組みを作ってくださり、ありがとうございました。上級者の方から初級者の方まで、幅広い意見を取り入れることができ、とても助かりました。

 ・TechTrainメンターの、大木優さん(@gurusu_program、株式会社TechBowl)、今川裕士さん(@ug23_、弁護士ドットコム株式会社)、徳田祥さん(@haze_it_ac)、寺嶋祐稀さん(@y_temp4)、吉野雅耶さん(@ayasamind、株式会社Fusic)、ありがとうございます。日ごろの業務の経験談にもとづいたアドバイスをいただき、ブラッシュアップさせていくことができました。

 ・TechTrain メンティーの門田朋己さん(@tmk815)、tktcorporationさん(@tktcorporation)、西田吉克さん(@nsd244)、小越雄太さん(@ykotti1)、ありがとうございます。説明や手順の不足を指摘していただいたことで、当初の荒削りな原稿を読みやすくできました。特に小越雄太さんには実際に説明やコードの検証をしていただいたことで、執筆する上での不安を和らげることができました。本当にありがとうございます。

1. https://techbookfest.org/market

2. その本では、Webフロントエンド開発の環境構築手順をひとつずつ丁寧に見ていき、設定が足りない状態で動かすとどうなるのか、といった実験をしていました。たとえばbabel-cliを使わずにトランスパイルしたり、css-loaderを使わずにstyle-loaderだけを使おうとしたりして、どうしてそれらのライブラリが必要なのかを説明しました。https://techbookfest.org/product/6209306726760448

3. https://github.com/sadnessOjisan/js-build-book-support

4. https://github.com/sadnessOjisan/js-build-book-support

第1章 Node.jsを使ったビルド環境整備

1.1 Node.jsとは

 Node.js®は、ChromeのV8 JavaScriptエンジンで動作するJavaScript環境です。1Node.jsは、サーバやCLIツールとして使われています。クライアントサイドJavaScriptの環境構築は、このNode.jsのエコシステム上で行います。本章では、そのNode.jsについて学びます。

1.2 Node.jsのインストール

 Node.jsは、公式HP2からダウンロードできます。各プラットフォームごとにインストーラが用意されており、インストールできます。また、公式HPではHomebrewなどのパッケージマネージャーを使ったインストール方法も紹介されています。本書はNode.js v12.16.3を利用しますが、releaseページ3からバージョンを細かく指定して、ダウンロードすることもできます。4ご自身にあった手法でインストールしてください。

 また、公式にのっとった方法ではありませんが、バージョンマネージャーを使っても良いです。本書はNode.js v12.16.3を利用しますが、バージョンマネージャーを使うと、該当バージョンをピンポイントで入れることが容易になります。既にNode.jsを持っている人にとっては、該当バージョンへの切り替えが容易になるメリットもあります。5Node.jsのVersion Managerには、さまざまなものがありますが、筆者はnvm6を利用しています。本書ではnvmのインストール方法や利用方法は説明しませんが、詳しいことはnvm公式に全て書かれているため、そちらを参照してください。7

1.3 JavaScriptプロジェクトを管理する

 JavaScriptプロジェクトはpackage.jsonと呼ばれるファイルで、その構成を管理します。このファイルではたとえば、次の項目を管理できます。

 ・パッケージ名

 ・バージョン

 ・依存ライブラリ

 ・エントリポイント

 ・script

 ・ライセンス

 依存ライブラリをpackage.jsonファイルで管理できるため、Gitの管理下に含めておくと、依存ライブラリの更新や、その更新に失敗した際の差し戻しが容易になります。またパッケージ名・バージョン・エントリポイントは、プロジェクト自体をライブラリとして提供する際に、利用者が参照する大切な情報です。たとえば、nameはそのままnpm公式サイトでのパッケージの検索に使われます。開発やエコシステムとの連携という観点で、このファイルはとても大切なものです。

1.3.1 package.jsonを生成する

 package.jsonは、npm initコマンドで作成できます。もちろん、ただのjsonファイルなので、すべて手書きしても問題ありません。

$ npm init

 このコマンドを実行すると、次のようなファイルが作成されます。

リスト1.1: package.json

{
    "name": "npmtst",
    "version": "1.0.0",
    "description": "",
    "main": "index.js",
    "scripts": {
      "test": "echo \"Error: no test specified\" && exit 1"
    },
    "author": "",
    "license": "ISC",
  }

1.3.2 packageを追加する

 Node.jsには、npmと呼ばれるpackage managerとコマンドが付随しています。8このnpmを使うことで、ライブラリをダウンロードできます。

 npmを使ってpackageを追加します。npm install reactなどとすれば、packageを入手できます。

 どのようなpackageを保存したか9は、package.jsonに記録され、packageの実体は node_modulesというフォルダに保存されます。またそのpackage自体が持つ依存の管理には、package-lock.jsonファイルが使われます。これはlockファイルと呼ばれているものです。そのためpackage.jsonとpackage-lock.jsonさえあれば、node_modulesを削除しても環境を再現できます。

# package.jsonとpackage-lock.jsonを元にpackageをDLしてnode_modulesに保存する

$ npm install

 パッケージを追加するとpackage.jsonが次のようになります。たとえば、reactを追加したときはこのようになります。

リスト1.2: dependencies

{
    "dependencies": {
      "react": "^16.13.1"
    }
  }

 これはreactを依存として含めることを意味します。

 一方で、このようなpackage.jsonもあります。

リスト1.3: devDependencies

{
    "devDependencies": {
      "typescript": "^3.8.3"
    }
  }

 ここでの違いは、dependenciesかdevDependenciesかという違いです。devDependenciesに指定されているpackageはdependenciesと違って、このプロジェクト自体がライブラリとして使われる際に依存を含めません。今回の例だと、TypeScriptコンパイラは開発用のツールであり、ライブラリとしての機能には関わってきません。そのため、dependenciesではなくdevDependenciesに指定します。このように開発時のみに使うツールかどうかで、dependenciesとdevDependenciesを使い分けます。全部dependenciesに含めると、ライブラリとして使われるときに利用者に不要なインストールを強いることになるため、気を付けましょう。devDependenciesとしてライブラリをダウンロードするためには、-Dオプションを使います。

$ npm install -D typescript

 ここまでに出てきた、ライブラリをダウンロードするために利用するnpmコマンドを復習していきます。

# アプリで使うライブラリとしてreactをDL

$ npm install react


# 開発用ライブラリとしてTypeScriptをDL

$ npm install -D typescript


# package.jsonとpackage-lock.jsonを元に、そのプロジェクトに必要なライブラリをすべてDL

$ npm install


# installと打たなくても短縮形が使える

$ npm i

試し読みはここまでです。
この続きは、製品版でお楽しみください。