近代的なWeb開発には欠かせないwebpackの最低限のメモ。
webpackとは何か？
一言で言うと「モジュールバンドラツール」の１つ。ということになりますが、よくわかりませんね。
ここでは「jsファイルやcssやらを（１つの）jsファイルにまとめるためのツール」くらいに思っていてよいかと思います。また、まとめる際にいろいろな処理を入れたりもできます。
実用的にはTypeScriptをコンパイルしてjsして、配置する。React(JSX)をコンパイルして配置するなどでの利用が一般的でしょうかね。
インストール
とりあえずグルーバルに入れておきます。
npm install -g webpack webpack-cli
package.jsonスクリプト中にwebpackを含める場合など結局ローカルインストールが必要になることもあります・・・。
使ってみる
では、とりあえず使ってみましょう。
作業場所の確保と作業ファイルの作成
作業場所と取り急ぎの作業ファイルを作ります。
index.htmlは生成したjsの動作確認用。index.jsは生成の元となるjsファイルです。
mkdir webpack-test
cd webpackptest
touch index.html index.js
別にtouchで作る必要はありません。
各ファイルを編集
最低限の記述をします。classは定義してるだけ。bundle.jsはwebpackが生成するアウトプットファイル（js）の想定です。
<!DOCTYPE html>
<html>
<body>
<p class="hello">こんにちは</p>
<script src="bundle.js"></script>
</body>
</html>
とりあえずhelloとalertを出す命令を記述。
const hello = () => {
alert("hello");
}
hello();
webpackを利用する
ではwebpackを使ってコンパイル（バンドルファイルの生成）をします。
index.jsを入力ファイルとし、bundle.jsを出力ファイルとして指定しています。
webpack index.js -o bundle.js --mode=development
--modeを指定しないとwarningがでるので追記しています。
上記コマンドを実行するとbundle.jsが出力されたと思います。
動作確認
では動作確認してみます。
index.htmlを開いてみましょう。helloとalertが表示されるはずです。
とりあえず動きましたが、ここまでの作業だけなら「index.jsを直接呼べばいいじゃん？」って話です。
では、ファイルを追加、編集してみましょう。
ただ、入力ファイルを受け取り、何か処理して出力するのだな・・・ということはわかったと思います。
ファイルを追加してみる
では、ファイルの手を加えて見ましょう。
まず、新しいjsファイルを作ります。
touch lib.js
byeと表示する関数を実装します。
module.exports.bye = () => {
alert("bye");
}
ちなみにmodule.exportsという書き方は、commonjs（古いJS）で利用できる関数や変数をexportする命令です。
で、index.jsでlib.jsを読み込んでみます。
+const lib = require('./lib');
const hello = () => {
alert("hello");
}
hello();
+lib.bye();
ここまでできたらwebpackを実行し、bundle.jsを更新します。
webpack index.js -o bundle.js --mode=development
で、再度index.htmlを（更新して）見てみます。
helloにつづき、byeのalertも表示されました。
lib.jsを追加しましたが、利用しているのはbundle.jsだけです。
webpackが２つのファイルを1つにまとめて（バンドルして）くれたのがわかります。
webpack.config.jsを利用する
ここまではwebpackコマンド実行時に各種オプションを渡してきましたが、実用においてはwebpack.config.jsに動作を記述します。
では、上記で指定していたオプションをwebpack.config.jsに記述してみます。
ファイルを生成。
touch webpack.config.js
内容を記述。そんなに難しいことはありません。
module.exports = {
mode: 'development',
entry: './index.js',
output: {
path: __dirname,
filename: 'bundle.js',
}
}
webpack.config.jsができたら、それがあるディレクトリでwebpackコマンドを実行すると自動的に読み込んで実行してくれます。
webpack
結果は同じです。
CSSをバンドルしてみる
jsだけでは「まあ、復数でもrequireするだけじゃん」ということになるので、cssもバンドルも試してみたいと思います。
cssを作ります。
touch styles.css
pタグにhelloというclass名を付けていたので、それ用のスタイルを記述します。
ここでは文字を赤くしています。
.hello {
color: red;
}
cssを正しくバンドルするためには追加のLoaderといわれるモジュールが必要なのでインストールします。
npm install --save css-loader style-loader
index.jsにてcssをimportします。
const lib = require('./lib');
+import './styles.css';
const hello = () => {
alert("hello");
}
hello();
lib.bye();
cssを正しく処理できるようにwebpack.config.jsにローダーに関する設定を追加します。
testにて適用するファイル形式（ここでは.cssという末尾）を指定しています。
useにて適用するローダーを設定しています。css-loader -> style-loaderの順で適用されます。
module.exports = {
mode: 'development',
entry: './index.js',
output: {
path: __dirname,
filename: 'bundle.js',
},
+ module: {
+ rules: [
+ {
+ test: /\.css$/,
+ use: ['style-loader', 'css-loader'],
+ }
+ ]
+ }
}
ではwebpackを実行し、index.htmlを確認してみてください。
linkでcssを取り込んでいるわけでもないのにスタイルができようされています！。どうしてこんなことができるのかはググりましょう。
ここまでで、webpackがweb（だけじゃないけど）に必要な各種リソースを1つのjsファイルにまとめられることがわかりました。
css以外にもjsonや画像等もまとめることができます。もちろん、TypeScript等をコンパイルした結果もOKです。
onclick等からの呼び出しに対応する（関数化する）
ここまででのサンプルではjsがいきなり実行されていました。サンプルとしてはいいですが、実用性はありません。
そこで、onclick等のeventから関数を利用できるようにコードを変更してみます。
index.jsを下記のようにします。window.関数名という感じにします。
もっと汎用化するならoutputにlibraryやlibraryTargetを指定する方法もあります。詳しくはこちら。
const lib = require('./lib');
import './styles.css';
const hello = () => {
alert("hello");
}
+window.hello = hello;
+window.bye = lib.bye;
で、HTMLの方からonclickで読んでみます。
<!DOCTYPE html>
<html>
<body>
<p class="hello">こんにちは</p>
+ <button onclick="hello()">hello</button>
+ <button onclick="bye()">bye</button>
<script src="bundle.js"></script>
</body>
</html>
どうでしょう。動きました？（うごくはず）
Loaderが何をしているか理解する（ために作ってみる）
最後にLoaderが何をしているか作ることで理解してみます。余裕のない人は読み飛ばしてください。
とりあえずテストにつかうファイルを生成します。
ここでは読み込んだテキストデータを大文字にして返すというLoaderを作ってみたいと思います。
touch test-loader.js test.txt
インプットとなるテキストファイル。
abcd
ローダー。読み込んで大文字にして（JSON文字列形式）で返します。
module.exports = (context, map, meta) => {
return `module.exports = ${JSON.stringify(context.toUpperCase())}`;
}
ローダーを使うように設定します。
module.exports = {
mode: 'development',
entry: './index.js',
output: {
path: __dirname,
filename: 'bundle.js',
},
module: {
rules: [
{
test: /\.css$/,
use: ['style-loader', 'css-loader'],
},
+ {
+ test: /\.txt/,
+ loader: './test-loader.js',
+ }
]
}
}
index.jsにてtest.txtをインポートします（実際はローダーで処理してJSでimportできる形式になっているのでimportできます）。
const lib = require('./lib');
import './styles.css';
+import upperText from './test.txt';
const hello = () => {
alert("hello");
}
+console.log(upperText);
window.hello = hello;
window.bye = lib.bye;
実行してみます。
小文字が大文字に変換されて、出力されています。
ま、とりあえずLoaderは特定のファイルを読み込んで必要な処理をするための機能。というレベルの理解でいいかと思います。
応用
- とりあえずTypeScriptのトランスパイルで利用する方法はこちら。