Разтърсващи ES6 модули в webpack 2

Webpack 2 току-що беше пуснат от бета версия миналата седмица. Той носи със себе си разнообразие от очаквани функции, включително естествена поддръжка за ES6 модули.

Вместо да използва var module = require('module')синтаксиса, webpack 2 поддържа ES6 importsи exports. Това отваря вратата за оптимизация на кода като разклащане на дървета .

Какво е треперенето на дървета?

Популяризирано от пакета за модули Rollup.js на Rich Harris, разклащането на дървета е възможността да включвате само кода във вашия пакет, който се използва.

Когато за първи път си поиграх с Rollup, бях изумен колко добре работи с ES6 модулите. Опитът от разработката просто се почувства ... правилен. Бих могъл да създам отделни модули, написани на „бъдещ JavaScript“, след което да ги включа навсякъде в моя код. Всеки код, който остава неизползван, не влиза в моя пакет. Гений!

Какъв проблем решава?

Ако пишете JavaScript през 2017 г. и разбирате (вижте: умора от JavaScript) различните инструменти наоколо, вашият опит за разработка вероятно се чувства доста течен. Това е важно, но това, което също е важно, е потребителският опит . Много от тези съвременни инструменти в крайна сметка надуват уеб приложения с масивни JavaScript файлове, което води до по-бавна производителност.

Това, което ми харесва в Rollup, е, че той забива по този въпрос и извежда решение на преден план в общността на JavaScript. Сега големи имена като webpack се опитват да го повторят.

Разклащането на дървета може да не е „решението за прекратяване на всички решения“, но е важно парче в по-големия пай.

Един прост пример

Преди да започнете, искам да ви дам тривиален пример за разклащане на дървета. Вашето приложение се състои от 2 файла index.jsи module.js.

Вътре в module.jsвас експортирате 2 имена със стрелки:

// module.js export const sayHello = name => `Hello ${name}!`; export const sayBye = name => `Bye ${name}!`

Само sayHelloсе импортира във index.jsфайл:

// index.js import { sayHello } from './module'; sayHello('World');

sayByeсе изнася, но никога не се внася. Навсякъде. Следователно, поради разклащане на дървета, той няма да бъде включен във вашия пакет:

// bundle.js const sayHello = name => `Hello ${name}!`; sayHello('World');

В зависимост от използвания пакет, изходният файл по-горе може да изглежда различно. Това е просто опростена версия, но вие разбирате идеята.

Наскоро прочетох статия, написана от Роман Лютиков, и той направи страхотна аналогия, за да визуализира концепцията за разклащане на дървета:

„Ако се чудите защо се нарича разклащане на дървета: помислете за приложението си като графика на зависимост, това е дърво и всеки износ е клон. Така че, ако разклатите дървото, мъртвите клони ще паднат. " - Роман Лютиков

Разклащане на дървета в уеб пакет 2

За съжаление на тези от нас, които използваме webpack, разклащането на дървета е „зад ключ“, ако искате. За разлика от Rollup, трябва да се направи някаква конфигурация, преди да можете да получите функционалността, която търсите. Частта „зад ключ“ може да обърка някои хора. Ще обясня.

Стъпка 1: Настройка на проекта

Ще предположа, че разбирате основите на webpack и можете да се ориентирате в основен конфигурационен файл на webpack.

Нека започнем със създаването на нова директория:

mkdir webpack-tree-shaking && cd webpack-tree-shaking

След като влезем, нека инициализираме нов npmпроект:

npm init -y

В -yопцията генерира package.jsonбързо без да е необходимо да се отговори на един куп въпроси.

След това нека инсталираме няколко зависимости от проекта:

npm i --save-dev [email protected] html-webpack-plugin

Командата по-горе ще инсталира най-новата бета версия на webpack 2 локално във вашия проект, както и полезен плъгин с име html-webpack-plugin. Последното не е необходимо за целта на това ръководство, но ще направи нещата малко по-бързи.

Забележка : Командата npm i --save-dev [email protected]все още се препоръчва от екипа на webpack по време на писането. [email protected]в крайна сметка ще бъде премахнат в полза на webpackпоследната команда. Вижте как да изтеглите?раздел на последната публикация на webpack за повече подробности.

Отворете package.jsonи се уверете, че са инсталирани като devDependencies.

Стъпка 2: Създайте JS файлове

За да видите разклащането на дървета в действие, трябва да имате малко JavaScript, с който да играете. В корена на проекта си създайте srcпапка с 2 файла вътре:

mkdir src && cd src touch index.js touch module.js

Забележка: В touchзаповедта се създава нов файл чрез терминала.

Копирайте кода по-долу в правилните файлове:

// module.js export const sayHello = name => `Hello ${name}!`; export const sayBye = name => `Bye ${name}!`;
// index.js import { sayHello } from './module'; const element = document.createElement('h1'); element.innerHTML = sayHello('World'); document.body.appendChild(element);

Ако сте стигнали толкова далеч, структурата на папките ви трябва да изглежда така:

/ | - node_modules/ | - src/ | | - index.js | | - module.js | - package.json

Стъпка 3: Webpack от CLI

Since you have no configuration file created for your project, the only way to get webpack to do any work at the moment is through the webpack CLI. Let’s perform a quick test.

In your terminal, run the following command in your project’s root:

node_modules/.bin/webpack

After running this command, you should see output like this:

No configuration file found and no output filename configured via CLI option. A configuration file could be named 'webpack.config.js' in the current directory. Use --help to display the CLI options.

The command doesn’t do anything, and the webpack CLI confirms this. You haven’t given webpack any information about what files you want to bundle up. You could provide this information via the command line or a configuration file. Let’s choose the former just to test that everything is working:

node_modules/.bin/webpack src/index.js dist/bundle.js

What you’ve done now is pass webpack an entry file and an output file via the CLI. This information tells webpack, "go to src/index.js and bundle up all the necessary code into dist/bundle.js". And it does just that. You'll notice that you now have a dist directory containing bundle.js.

Open it up and check it out. There’s some extra javascript in the bundle necessary for webpack to do its thing, but at the bottom of the file you should see your own code as well.

Step 4: Create a webpack configuration file

Webpack can handle a lot of things. I’ve spent a good chunk of my free time diving into this bundler and I still have barely scratched the surface. Once you’ve move passed trivial examples its best to leave the CLI behind and create a configuration file to handle the heavy lifting.

In your project’s root, create a webpack.config.js file:

touch webpack.config.js

This file can be as complicated as you make it. We’ll keep it light for the sake of this post:

// webpack.config.js const HtmlWebpackPlugin = require('html-webpack-plugin'); module.exports = { entry: './src/index.js', output: { filename: 'bundle.js', path: 'dist' }, plugins: [ new HtmlWebpackPlugin({ title: 'Tree-shaking' }) ] }

This file provides webpack with the same information you gave to the CLI earlier. You’ve defined index.js as your entry file and bundle.js as your output file. You've also added your html-webpack-plugin which will generate an html file in your dist directory. Convenient.

Go ahead and test this to make sure it’s still working. Remove your dist directory, and in the command line type:

webpack

If everything went smoothly, you can open up dist/index.html and see "Hello World!".

Note: The use of a configuration file gives us the convenience of typing webpack instead of node_modules/.bin/webpack. Small wins.

Step 5: Babel

I mentioned earlier that webpack 2 brings native support for ES6 modules. This is all true, but it doesn’t change the fact that ES6 is not fully supported across all browsers. Because of this, you’re required to transform your ES6 code into readily acceptable JavaScript using a tool like Babel. In conjunction with webpack, Babel gives us the ability to write your “future JavaScript” without worrying about the implications of unsupported browsers.

Let’s go ahead and install Babel in your project:

npm i --save-dev babel-core babel-loader babel-preset-es2015

Take note of the babel-preset-es2015 package. This little guy is the reason I sat down to write all of this up.

Step 6: babel-loader

Webpack can be configured to transform specific files into modules via loaders. Once they are transformed, they are added to a dependency graph. Webpack uses the graph to resolve dependencies and includes only what is needed into the final bundle. This is the basis for how webpack works.

You can now configure webpack to use babel-loader to transform all of your .js files:

// webpack.config.js const HtmlWebpackPlugin = require('html-webpack-plugin'); module.exports = { entry: './src/index.js', output: { filename: 'bundle.js', path: 'dist' }, module: { rules: [ { test: /\.js$/, exclude: /node_modules/, loader: 'babel-loader', options: { presets: [ 'es2015' ] } } ] }, plugins: [ new HtmlWebpackPlugin({ title: 'Tree-shaking' }) ] };

The module property provides a set of instructions for webpack. It says, "take any files ending in .js and transform them using babel-loader, but don't transform any files inside of node_modules!"

We’re also passing the babel-preset-es2015 package as an option to babel-loader. This just tells babel-loaderhow to transform the JavaScript.

Run webpack again to make sure everything is good. Yes? Great! What we've done is bundled up your JavaScript files while compiling them down to JavaScript thats readily supported across browsers.

The underlying problem

The package babel-preset-es2015 contains another package named babel-plugin-transform-es2015-modules-commonjs that turns all of your ES6 modules into CommonJS modules. This isn't ideal, and here's why.

Javascript bundlers such as webpack and Rollup can only perform tree-shaking on modules that have a static structure. If a module is static, then the bundler can determine its structure at build time, safely removing code that isn’t being imported anywhere.

CommonJS modules do not have a static structure. Because of this, webpack won’t be able to tree-shake unused code from the final bundle. Luckily, Babel has alleviated this issue by providing developers with an option that you can pass to your presets array along with babel-preset-es2015:

options: { presets: [ [ 'es2015', { modules: false } ] ] }

According to Babel’s documentation:

“modules - Enable transformation of ES6 module syntax to another module type (Enabled by default to "commonjs"). Can be false to not transform modules, or one of ["amd", "umd", "systemjs", "commonjs"]".

Slide that extra bit of code into your configuration and you’ll be cooking with peanut oil.

The final state of webpack.config.js looks like this:

// webpack.config.js const HtmlWebpackPlugin = require('html-webpack-plugin'); module.exports = { entry: './src/index.js', output: { filename: 'bundle.js', path: 'dist' }, module: { rules: [ { test: /\.js$/, exclude: /node_modules/, loader: 'babel-loader', options: { presets: [ [ 'es2015', { modules: false } ] ] } } ] }, plugins: [ new HtmlWebpackPlugin({ title: 'Tree-shaking' }) ] };

The Grand Finale

Run webpack again and pop open your bundle.js file. You won't notice any difference. Before you go crazy, know this! It's ok. We've been running webpack in development mode this whole time. Webpack knows that you have unused exports in your code. Even though it's included in the final bundle, sayBye will never make it to production.

If you still don’t believe me, run webpack -p in your terminal. The -p option stands for production. Webpack will perform a few extra performance optimizations, including minification, removing any unused code along the way.

Open up bundle.js. Since it's minified, go ahead and search for Hello. It should be there. Search for Bye. It shouldn't.

Voila! You now have a working implementation of tree-shaking in webpack 2!

For the curious, I’ve been slowly iterating over my own lightweight webpack configuration in a GitHub Repo:

jake-wies/webpack-hotplate

webpack-hotplate - A webpack boilerplate for personal projects

github.com

It’s not meant to be overly verbose and bloated. It’s focused on being an approachable boilerplate with walkthroughs at every turn. If you’re interested, check it out!

If you have any questions, feel free to reach out on Twitter!