Skip to content
forked from mikeal/ipjs

Universal JavaScript Build and Packaging

Notifications You must be signed in to change notification settings

achingbrain/ipjs

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

59 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Universal JavaScript Build and Packaging

This is a toolchain for the next phase of JavaScript development. It enables developers to write JavaScript modules in ESM that work universally across many environments (Node.js import, Node.js require, Browser, Deno, etc).

You start by just writing a standard ESM module. You'll need to include "type": "module" in your package.json, as well as a "main" entry point or an export map.

npx ipjs build

This will build a package in the dist directory that has different versions of your files compiled for different environments and a new package.json file that exposes all of these files to the correct Node.js and compiler entry points.

That's it ;)

You can also compile your tests.

npx ipjs build --tests

Note: You'll need to use "named self imports", import mymodule from "mymodule", in your tests so that we can compile different CJS versions of those tests for Node.js and the browser.

You can publish to by either running npm publish in the dist directory or using:

npx ipjs publish

Requirements

There's a few Node.js and ESM features you need to stick to using and a few you need to avoid. Some are because there just isn't a very good way to provide consistent representations and some are because we need some more explicit information about your library in order to detect the dependency tree and built it successfully.

Do not use mixed default default and named exports/imports

Only export individual files in export map (no directories or pattern matching)

About

Universal JavaScript Build and Packaging

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%