node-migrator-bot/wrapup

WrapUp?

WrapUp compiles CommonJS 1.0 modules for the browser.
Wrapup does not try to have a working require implementation for the browser, infact the loader WrapUp uses is incredibly simple.
WrapUp ignores duplicates that may be present when using npm to install packages.
Wrapup supports building multiple versions of the same package.
Wrapup supports circular module dependencies.
WrapUp can watch source files for changes and rebuild automatically.

Installation

WrapUp is installed via npm:

npm install wrapup -g

After that, you will have access to wrup in your cli.

wrup --help

You can also install locally:

npm install wrapup

And require WrapUp in your node javascripts:

var wrup = require("wrapup")

Usage

In a nutshell, you tell WrapUp you require something, it calculates dependencies for something using static analysis, and compiles a single javascript file that only exposes that something you required. require paths inside modules are replaced with unique identifiers for brevity, and you will only be able to access directly that something you required, never dependencies (unless specifically required).

require()

The main WrapUp method is require(namespace, module).

It resolves a module using node's own modules and packages logic, so for instance, wrup.require("colors") would look in your node_modules folder for a package named colors, then proceed to load its main. The namespace parameter is optional, but it's used to expose the module to the browser. Without a namespace, the module will be required without being assigned. A bit like doing var x = require(y) vs require(y).

cli

wrup --require colors colors --require someName ./path/to/otherModule --require someOtherPackage

js

var wrup = require("wrapup")() // require + instantiate

wrup.require("colors", "colors")
    .require("someName", "./path/to/otherModule")
    .require("someOtherPackage")
    .up(/*...options...*/) //returns a string

the above would let you access colors and someName, while having someOtherPackage simply required without being assigned to any variable. The ouput code assigning variables would look like this:

window.colors = colors
window.someName = require(/*identifier*/)
require(/*identifier*/)

watch

WrapUp supports watching source files and rebuilds automatically whenever one of these changes.

var wrup = require("wrapup")() // require + instantiate
wrup.require("y", "./moduley.js").up({watch: true})

wrup.on("done", function(js){
    fs.writeFile("path/to/wherever", js)
})

wrup.on("change", function(file){
    console.log(file + " changed.")
})

In the above example, whenever moduley and any module required by moduley changes, .up() is called again. The done event is fired whenever WrapUp builds, either be a direct .up() call or an .up() call triggered by a changed file. The change event is fired whenever watch is set to true and one of the source files changes.

Options

globalize if set to true, will attach namespaces to the window object. Defaults to true.
compress if set to true, will compress the resulting javascript file using uglify-js. Defaults to false.
wrup if set to true, will attach the wrup method to the window object, allowing you to sort-of-require the specified namespaces at any given time. This is especially useful since modules are only executed when first required, and sometimes might be a good idea to execute a module only when the dom is fully loaded, for instance, or conditionally. Defaults to false.
watch if set to true, will watch required files and rebuilds automatically whenever one of these changes. The --watch option in the cli requires the --output option to be set as well. defaults to false.
--output only available in the cli, used to specify an output file. defaults to stdout.

cli

wrup --require ... --globalize yes --wrup no --compress yes --output path/to/file --watch

js

wrup.require(/*...*/).up({globalize: true, wrup: false, compress: true, watch: true})

Examples

coming soon... :)

node-migrator-bot / wrapup