Aprenda los conceptos básicos del sistema de módulos JavaScript y cree su propia biblioteca

Últimamente todos hemos escuchado mucho sobre los “módulos JavaScript”. Es probable que todos se pregunten qué hacer con ellos y cómo pueden desempeñar un papel vital en nuestra vida diaria…?

Entonces, ¿qué diablos es el sistema de módulos JS? ?

A medida que el desarrollo de JavaScript se generaliza cada vez más, los espacios de nombres y las dependencias se vuelven mucho más difíciles de manejar. Se han desarrollado diferentes soluciones para hacer frente a este problema en forma de sistemas de módulos.

¿Por qué es importante comprender el sistema de módulos JS?

Dejame contarte una historia.

Contar historias es tan básico para los seres humanos como comer. Más aún, de hecho, porque mientras la comida nos hace vivir, las historias son las que hacen que valga la pena vivir nuestra vida - Richard Kearney

¿Por qué estoy hablando de todas estas cosas?

Entonces, mi trabajo diario es diseñar y diseñar proyectos, y rápidamente me di cuenta de que se requerían muchas funcionalidades comunes en todos los proyectos. Siempre terminaba copiando y pegando esas funcionalidades en nuevos proyectos una y otra vez.

El problema era que cada vez que cambiaba una parte del código, necesitaba sincronizar manualmente esos cambios en todos mis proyectos. Para evitar todas estas tediosas tareas manuales, decidí extraer las funcionalidades comunes y componer un paquete npm a partir de ellas. De esta manera, otros miembros del equipo podrían reutilizarlos como dependencias y simplemente actualizarlos cada vez que se lanzara una nueva versión.

Este enfoque tenía algunas ventajas:

  • Si había algún cambio en la biblioteca central, entonces solo se tenía que hacer un cambio en un lugar sin refactorizar todo el código de las aplicaciones para lo mismo.
  • Todas las aplicaciones permanecieron sincronizadas. Siempre que se realizaba un cambio, todas las aplicaciones solo necesitaban ejecutar el comando "npm update".

Entonces, el siguiente paso fue publicar la biblioteca. ¿Correcto? ?

Esta fue la parte más difícil, porque había un montón de cosas dando vueltas en mi cabeza, como:

  1. ¿Cómo hago temblar el árbol?
  2. ¿A qué sistemas de módulos JS debería apuntarme (commonjs, amd, harmony)?
  3. ¿Debo transpilar la fuente?
  4. ¿Debería agrupar la fuente?
  5. ¿Qué archivos debo publicar?

Todos hemos tenido este tipo de preguntas burbujeando en nuestras cabezas al crear una biblioteca. ¿Correcto?

Intentaré abordar todas las preguntas anteriores ahora.

¿Diferentes tipos de sistemas de módulos JS?

1. CommonJS

  • Implementado por nodo
  • Se usa para el lado del servidor cuando tiene módulos instalados
  • Sin carga de módulo en tiempo de ejecución / asíncrono
  • importar a través de " requerir "
  • exportar a través de " module.exports "
  • Cuando importas, recuperas un objeto
  • Sin sacudidas de árboles, porque cuando importas obtienes un objeto
  • Sin análisis estático, ya que obtiene un objeto, por lo que la búsqueda de propiedades se realiza en tiempo de ejecución
  • Siempre obtienes una copia de un objeto, por lo que no hay cambios en vivo en el módulo en sí
  • Gestión deficiente de la dependencia cíclica
  • Sintaxis simple

2. AMD: Definición de módulo asíncrono

  • Implementado por RequireJs
  • Se usa para el lado del cliente (navegador) cuando desea la carga dinámica de módulos
  • Importar a través de "requerir"
  • Sintaxis compleja

3. UMD: Definición de módulo universal

  • Combinación de CommonJs + AMD (es decir, sintaxis de CommonJs + carga asíncrona de AMD)
  • Se puede utilizar para entornos AMD / CommonJs
  • UMD esencialmente crea una forma de usar cualquiera de los dos, al mismo tiempo que admite la definición de variable global. Como resultado, los módulos UMD pueden funcionar tanto en el cliente como en el servidor .

4. ECMAScript Harmony (ES6)

  • Se utiliza tanto para servidor / cliente lado
  • Tiempo de ejecución / carga estática de módulos admitidos
  • Cuando importa, recupera el valor de las vinculaciones (valor real)
  • Importar mediante "importar" y exportar mediante "exportar"
  • Análisis estático : puede determinar las importaciones y exportaciones en tiempo de compilación (estáticamente); solo tiene que mirar el código fuente, no tiene que ejecutarlo
  • Árbol sacudible, debido al análisis estático compatible con ES6
  • Obtenga siempre un valor real para que los cambios en vivo en el módulo mismo
  • Mejor gestión de la dependencia cíclica que CommonJS

Ahora ya sabe todo sobre los diferentes tipos de sistemas de módulos JS y cómo han evolucionado.

Aunque el sistema del módulo ES Harmony es compatible con todas las herramientas y los navegadores modernos, nunca sabemos al publicar bibliotecas cómo podrían utilizarlas nuestros consumidores. Por tanto, siempre debemos asegurarnos de que nuestras bibliotecas funcionen en todos los entornos.

Profundicemos y diseñemos una biblioteca de muestra para responder a todas las preguntas relacionadas con la publicación de una biblioteca de la manera adecuada.

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

    El odule campo m de la p ackage.json se usa para señalar la S versión E de la biblioteca / paquete. Anteriormente, se usaban muchos campos como j s:next y j s:main , pero m odule ahora está estandarizado y los S vempaquetadores lo usan como una búsqueda para la E ersión de la biblioteca / paquete.

Hecho menos conocido: Webpack usa resolve.mainfields para determinar qué campos package.jsonestán marcados . Consejo de rendimiento: intente siempre publicar también la ESversión de su biblioteca / paquete, porque todos los navegadores modernos ahora admiten ESmódulos. Por lo tanto, puede transpilar menos y, en última instancia, terminará enviando menos código a sus usuarios. Esto aumentará el rendimiento de su aplicación.

Entonces, ¿qué sigue ahora? ¿Transpilación o agrupación? ¿Qué herramientas debemos utilizar?

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 a t/> tag. Now if my consumer wants to use jus t 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 ver sion (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. ?

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