Научете основите на модулната система JavaScript и изградете своя собствена библиотека

Напоследък всички чуваме много за „JavaScript модули“. Всички вероятно се чудят какво да правят с тях и как изобщо играят жизненоважна роля в нашето ежедневие ...?

И така, какво, по дяволите, е JS модулната система? ?

Тъй като разработката на JavaScript става все по-широко разпространена, пространствата от имена и зависимости стават много по-трудни за работа. Разработени са различни решения за справяне с този проблем под формата на модулни системи.

Защо разбирането на JS Module System е важно?

Нека ви разкажа една история.

Разказването на истории е толкова важно за хората, колкото и храненето. Още повече, че всъщност докато храната ни кара да живеем, историите са това, което кара живота ни да си струва - Ричард Кърни

Защо изобщо говоря за всички тези неща?

И така, ежедневната ми работа е да проектирам и да проектирам проекти и бързо разбрах, че има много общи функции, необходими за проектите. Винаги в крайна сметка копирах тези функционалности в нови проекти отново и отново.

Проблемът беше, че когато се променяше една част от кода, трябваше да синхронизирам ръчно тези промени във всичките си проекти. За да избегна всички тези досадни ръчни задачи, реших да извлека общите функционалности и да съставя npm пакет от тях. По този начин другите от екипа ще могат да ги използват повторно като зависимости и просто да ги актуализират при пускането на нова версия.

Този подход имаше някои предимства:

  • Ако имаше някаква промяна в основната библиотека, тогава промяната трябваше да бъде направена само на едно място, без да се рефакторира кодът на всички приложения за едно и също нещо.
  • Всички приложения останаха синхронизирани. Всеки път, когато е направена промяна, всички приложения просто трябва да изпълнят командата “npm update”.

И така, следващата стъпка беше да публикуваме библиотеката. Нали? ?

Това беше най-трудната част, защото в главата ми се подскачаха куп неща, като:

  1. Как да направя дървото разклащащо се?
  2. Към какви JS модулни системи трябва да се насоча (commonjs, amd, хармония).
  3. Трябва ли да транпилирам източника?
  4. Трябва ли да обединя източника?
  5. Какви файлове трябва да публикувам?

Всеки от нас е имал този вид въпроси, които бълбукат в главите ни, докато създаваме библиотека. Нали?

Ще се опитам да отговоря на всички горепосочени въпроси сега.

Различни видове JS модулни системи?

1. CommonJS

  • Изпълнено от възел
  • Използва се за сървърната страна, когато имате инсталирани модули
  • Без зареждане на модул за изпълнение / асинхронизация
  • импортиране чрез „ изисквам
  • експортиране чрез „ module.exports
  • Когато импортирате, получавате обратно обект
  • Няма треперене на дърво, защото при импортиране получавате обект
  • Няма статичен анализ, тъй като получавате обект, така че търсенето на свойства е по време на изпълнение
  • Винаги получавате копие на обект, така че няма промени в самия модул
  • Лошо управление на цикличната зависимост
  • Прост синтаксис

2. AMD: Определение на асинхронния модул

  • Изпълнено от RequireJs
  • Използва се за клиентската страна (браузър), когато искате динамично зареждане на модули
  • Импортиране чрез „изискване“
  • Сложен синтаксис

3. UMD: Дефиниция на универсален модул

  • Комбинация от CommonJs + AMD (т.е. Синтаксис на CommonJs + асинхронно зареждане на AMD)
  • Може да се използва и за двете среди на AMD / CommonJs
  • UMD по същество създава начин за използване на някое от двете, като същевременно поддържа дефиницията на глобалната променлива. В резултат на това UMD модулите могат да работят както на клиент, така и на сървър .

4. ECMAScript Harmony (ES6)

  • Използва се както за сървър / клиентска страна
  • Времетраене / статично зареждане на поддържаните модули
  • Когато импортирате, получавате обратно стойност на обвързванията (действителна стойност)
  • Внос чрез „внос“ и износ чрез „износ“
  • Статичен анализ - Можете да определите вноса и износа по време на компилиране (статично) - трябва само да погледнете изходния код, не е нужно да го изпълнявате
  • Дървото се разклаща поради статичен анализ, поддържан от ES6
  • Винаги получавайте действителна стойност, така че да се правят промени в самия модул
  • По-добро управление на цикличната зависимост от CommonJS

Така че сега знаете всичко за различните видове JS модулни системи и как те са се развили.

Въпреки че модулната система ES Harmony се поддържа от всички инструменти и съвременни браузъри, ние никога не знаем, когато публикуваме библиотеки как нашите потребители могат да ги използват. Затова винаги трябва да гарантираме, че нашите библиотеки работят във всякаква среда.

Нека да се потопим по-дълбоко и да проектираме примерна библиотека, за да отговорим на всички въпроси, свързани с издаването на библиотека по правилния начин.

I’ve built a small UI library (you can find the source code on GitHub), and I’ll share all my experiences and explorations for transpiling, bundling, and publishing it.

Here we have a small UI library which has 3 components: Button, Card, and NavBar. Let’s transpile and publish it step by step.

Best practices before publishing ?

  1. Tree Shaking ?
  • Tree shaking is a term commonly used in the context of JavaScript for dead-code elimination. It relies on the static structure of ES2015 module syntax, that is, import and export. The name and concept have been popularized by the ES2015 module bundler rollup.
  • Webpack and Rollup both support Tree Shaking, meaning we need to keep certain things in mind so that our code is tree shakeable.

2. Publish all module variants

  • We should publish all the module variants, like UMD and ES, because we never know which browser/webpack versions our consumers might use this library/package in.
  • Even though all the bundlers like Webpack and Rollupunderstand ES modules, if our consumer is using Webpack 1.x, then it cannot understand the ES module.
// package.json
{"name": "js-module-system","version": "0.0.1",...
"main": "dist/index.js","module": "dist/index.es.js",
...}
  • The main field of the package.json file is usually used to point to the UMD version of the library/package.
  • You might be wondering — how can I release the ES version of my library/package? ?

    Полето m odule на p ackage.json се използва за посочване на Е S версията на библиотеката / пакета. Преди това се използваха много полета като j s:next и j s:main , но odule сега m е стандартизиран и се използва от пакетите като справка за E S version на библиотеката / пакета.

По-малко известен факт: Webpack използва resol.mainfields, за да определи кои полета package.jsonса проверени. Съвет за ефективност: Винаги се опитвайте да публикувате и ESверсията на вашата библиотека / пакет, защото всички съвременни браузъри вече поддържат ESмодули. Така че можете да транслирате по-малко и в крайна сметка ще изпратите по-малко код на потребителите си. Това ще повиши производителността на вашето приложение.

И така, какво следва? Транспилация или групиране? Какви инструменти трябва да използваме?

Ah, here comes the trickiest part! Let’s dive in. ?

Webpack vs Rollup vs Babel?

These are all the tools we use in our day to day lives to ship our applications/libraries/packages. I cannot imagine modern web development without them — #blessed. Therefore, we cannot compare them, so that would be the wrong question to ask! ❌

Each tool has it’s own benefits and serves different purpose based on your needs.

Let’s look at each of these tools now:

Webpack

Webpack is a great module bundler ? that is widely accepted and mostly used for building SPAs. It gives you all the features out of the box like code splitting, async loading of bundles, tree shaking, and so on. It uses the CommonJS module system.

PS: Webpack-4.0.0 alpha is already out ?. Hopefully with the stable release it will become the universal bundler for all types of module systems.

RollupJS

Rollup is also a module bundler similar to Webpack. However, the main advantage of rollup is that it follows new standardized formatting for code modules included in the ES6 revision, so you can use it to bundle the ES module variant of your library/package. It doesn’t support async loading of bundles.

Babel

Babel is a transpiler for JavaScript best known for its ability to turn ES6 code into code that runs in your browser (or on your server) today. Remember that it just transpiles and doesn’t bundle your code.

My advice: use Rollup for libraries and Webpack for apps.

Transpile (Babel-ify) the source or Bundle it

Again there’s a story behind this one. ?

I spent most of my time trying to figure out the answer to this question when I was building this library. I started digging out my node_modules to lookup all the great libraries and check out their build systems.

After looking at the build output for different libraries/packages, I got a clear picture of what different strategies the authors of these libraries might have had in mind before publishing. Below are my observations.

As you can see in the above image, I’ve divided these libraries/packages into two groups based on their characteristics:

  1. UI Libraries (styled-components, material-ui)
  2. Core Packages (react, react-dom)

If you’re a good observer ? you might have figured out the difference between these two groups.

UI Libraries have a dist folder that has the bundled and minified version for ES and UMD/CJSmodule systems as a target. There is a lib folder that has the transpiled version of the library.

Core Packages havejust one folder which has the bundled and minified version for CJS or UMD module system as a target.

But why is there a difference in build output of UI libraries and Core Packages? ?

UI Libraries

Imagine if we just publish the bundled version of our library and host it on CDN. Our consumer will use it directly in at/> tag. Now if my consumer wants to use just the <;Button/> component, they have to load the entire library. Also, in a browser, there is no bundler which will take care of tree shaking, and we’ll end up shipping the whole library code to our consumer. We don’t want this.

import {Button} from "//unpkg.com/uilibrary/index.js";

Now if we simply transpile the src into lib and host the lib on a CDN, our consumers can actually get whatever they want without any overhead. “Ship less, load faster”. ✅

import {Button} from "//unpkg.com/uilibrary/lib/button.js";

Core Packages

Core packages are never utilized via the t/> tag, as they need to be part of main application. So we can safely release the bundled version (UMD, ES) for these kinds of packages and leave the build system up to the consumers.

For example, they can use the UMD variant but no tree shaking, or they can use the ES variant if the bundler is capable of identifying and getting the benefits of tree shaking.

// CJS requireconst Button = require("uilibrary/button");
// ES importimport {Button} from "uilibrary";

But…what about our question: should we transpile (Babelify) the source or bundle it? ?

For the UI Library, we need to transpile the source with Babel with the es module system as a target, and place it in lib. We can even host the lib on a CDN.

We should bundle and minifythe source using rollup for cjs/umd module system and es module system as a target. Modify the package.json to point to the proper target systems.

// package.json
{"name": "js-module-system","version": "0.0.1",...
"main": "dist/index.js", // for umd/cjs builds"module": "dist/index.es.js", // for es build
...}

For core packages, we don’t need the lib version.

We just need to bundle and minifythe source using rollup for cjs/umd module system and es module system as a target. Modify the package.json to point to the proper target systems, same as above.

Tip: We can host the dist folder on the CDN as well, for the consumers who are willing to download the whole library/package via t/> tag.

How should we build this?

We should have different scripts for each target system in package.json . You can find the rollup config in the GitHub repo.

// package.json
{..."scripts": {"clean": "rimraf dist","build": "run-s clean && run-p build:es build:cjs build:lib:es","build:es": "NODE_ENV=es rollup -c","build:cjs": "NODE_ENV=cjs rollup -c","build:lib:es": "BABEL_ENV=es babel src -d lib"}...}

What should we publish?

  • License
  • README
  • Changelog
  • Metadata(main , module, bin) — package.json
  • Control through package.jsonfiles property

In package.json , the "files" field is an array of file patterns that describes the entries to be included when your package is installed as a dependency. If you name a folder in the array, then it will also include the files inside that folder.

We will include the lib and dist folders in "files" field in our case.

// package.json
{..."files": ["dist", "lib"]...}

Finally the library is ready to publish. Just type the npm run build command in the terminal, and you can see the following output. Closely look at the dist and lib folders. ?

Original text


Wrap up

Wow! Where does the time go? That was a wild ride, but I sincerely hope it gave you a better understanding of the JavaScript Module system and how you can create your own library and publish it.

Just make sure you take care of the following things:

  1. Make it Tree Shakeable. ?
  2. Target at least ES Harmony and CJS module systems. ?
  3. Use Babel and Bundlers for libraries. ?
  4. Use Bundlers for Core packages. ?
  5. Set the module field of package.json to point to the ES version of your module (PS: It helps in tree shaking). ?
  6. Publish the folders which have transpiled as well as bundled versions of you module. ?

Trending this week ?

  1. Webpack-V4 alpha released. ?
  2. ParcelJs: Blazing fast, zero configuration web application bundler. ?
  3. Turbo: 5x faster than Yarn & NPM, and runs natively in-browser ?

Thanks to Juho Vepsäläinen and Lakshya Ranganath for their reviews & feedback, Sean T. Larkin and Tobias Koppers for sharing the insights of webpack at ReactiveConf, Addy Osmani for sharing workings of different JS module Systems in “Writing Modular JavaScript With AMD, CommonJS & ES Harmony”.

P.S. If you like this, make sure to recommend (by clap? ) , follow me on twitter, and share this with your friends!?