Apprenez les bases du système de modules JavaScript et créez votre propre bibliothèque

Dernièrement, nous avons tous beaucoup entendu parler des «modules JavaScript». Tout le monde se demande probablement quoi en faire, et comment jouent-ils même un rôle vital dans notre vie quotidienne…?

Alors, quel est le système de module JS? ?

À mesure que le développement JavaScript est de plus en plus répandu, les espaces de noms et les dépendances deviennent beaucoup plus difficiles à gérer. Différentes solutions ont été développées pour faire face à ce problème sous la forme de systèmes de modules.

Pourquoi est-il important de comprendre le système de modules JS?

Laissez-moi vous raconter une histoire.

Raconter des histoires est aussi fondamental pour les êtres humains que de manger. Plus encore, en fait, car si la nourriture nous fait vivre, ce sont les histoires qui valent la peine d'être vécues - Richard Kearney

Pourquoi est-ce que je parle même de tout ça?

Donc, mon travail quotidien consiste à concevoir et à architecturer des projets, et je me suis rapidement rendu compte qu'il y avait de nombreuses fonctionnalités communes requises à travers les projets. J'ai toujours fini par copier-coller ces fonctionnalités dans de nouveaux projets encore et encore.

Le problème était que chaque fois qu'une partie du code changeait, je devais synchroniser manuellement ces modifications dans tous mes projets. Pour éviter toutes ces tâches manuelles fastidieuses, j'ai décidé d'extraire les fonctionnalités communes et d'en composer un package npm. De cette façon, les autres membres de l'équipe pourraient les réutiliser en tant que dépendances et simplement les mettre à jour chaque fois qu'une nouvelle version est déployée.

Cette approche présentait certains avantages:

  • S'il y avait un changement dans la bibliothèque principale, alors un changement devait seulement être fait à un seul endroit sans refactoriser le code de toutes les applications pour la même chose.
  • Toutes les applications sont restées synchronisées. Chaque fois qu'une modification était apportée, toutes les applications avaient juste besoin d'exécuter la commande «npm update».

La prochaine étape consistait donc à publier la bibliothèque. Droite? ?

C'était la partie la plus difficile, car il y avait un tas de choses qui rebondissaient dans ma tête, comme:

  1. Comment rendre l'arbre secouable?
  2. Quels systèmes de modules JS dois-je cibler (commonjs, amd, harmonie).
  3. Dois-je transpiler la source?
  4. Dois-je regrouper la source?
  5. Quels fichiers dois-je publier?

Chacun de nous a eu ce genre de questions bouillonnantes dans nos têtes lors de la création d'une bibliothèque. Droite?

Je vais essayer de répondre à toutes les questions ci-dessus maintenant.

Différents types de systèmes de modules JS?

1. CommonJS

  • Implémenté par nœud
  • Utilisé pour le côté serveur lorsque des modules sont installés
  • Aucun chargement de module d'exécution / asynchrone
  • importer via " exiger "
  • exporter via " module.exports "
  • Lorsque vous importez, vous récupérez un objet
  • Pas de tremblement d'arbre, car lorsque vous importez, vous obtenez un objet
  • Aucune analyse statique, lorsque vous obtenez un objet, donc la recherche de propriété est au moment de l'exécution
  • Vous obtenez toujours une copie d'un objet, donc pas de changements en direct dans le module lui-même
  • Mauvaise gestion des dépendances cycliques
  • Syntaxe simple

2. AMD: définition du module asynchrone

  • Mis en œuvre par RequireJs
  • Utilisé pour le côté client (navigateur) lorsque vous souhaitez un chargement dynamique des modules
  • Importer via "exiger"
  • Syntaxe complexe

3. UMD: définition de module universel

  • Combinaison de CommonJs + AMD (c'est-à-dire, Syntaxe de CommonJs + chargement asynchrone d'AMD)
  • Peut être utilisé pour les environnements AMD / CommonJs
  • UMD crée essentiellement un moyen d'utiliser l'un des deux, tout en prenant également en charge la définition de variable globale. En conséquence, les modules UMD sont capables de fonctionner à la fois sur le client et le serveur .

4. ECMAScript Harmony (ES6)

  • Utilisé pour les client / serveur côté
  • Runtime / chargement statique des modules pris en charge
  • Lorsque vous importez, vous récupérez la valeur des liaisons (valeur réelle)
  • Importer via «import» et exporter via «exporter»
  • Analyse statique - Vous pouvez déterminer les importations et les exportations au moment de la compilation (statiquement) - vous n'avez qu'à regarder le code source, vous n'avez pas à l'exécuter
  • Arbre secouable, en raison de l'analyse statique prise en charge par ES6
  • Obtenez toujours une valeur réelle afin de vivre les changements dans le module lui-même
  • Meilleure gestion des dépendances cycliques que CommonJS

Vous savez maintenant tout sur les différents types de systèmes de modules JS et sur leur évolution.

Bien que le système de modules ES Harmony soit pris en charge par tous les outils et navigateurs modernes, nous ne savons jamais, lors de la publication de bibliothèques, comment nos consommateurs pourraient les utiliser. Nous devons donc toujours nous assurer que nos bibliothèques fonctionnent dans tous les environnements.

Allons plus loin et concevons un exemple de bibliothèque pour répondre à toutes les questions liées à la publication d'une bibliothèque de la bonne manière.

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? ?

    Le odule champ m du p ackage.json est utilisé pour pointer vers la S version E de la bibliothèque / du package. Auparavant, de nombreux champs étaient utilisés comme j s:next et j s:main , mais m odule est maintenant normalisé et est utilisé par les bundlers comme une recherche de la version S vde la bibliothèque / du package.

Fait moins connu: Webpack utilise resol.mainfields pour déterminer quels champs package.jsonsont vérifiés. Conseil de performance: essayez toujours de publier également la ESversion de votre bibliothèque / package, car tous les navigateurs modernes prennent désormais en charge les ESmodules. Ainsi, vous pouvez moins transpiler, et vous finirez par envoyer moins de code à vos utilisateurs. Cela augmentera les performances de votre application.

Alors maintenant, quelle est la prochaine étape? Transpilation ou groupage? Quels outils devrions-nous utiliser?

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!?