asset-pipe-js-writer

asset-pipe-js-writer

This is an internal module intended for use by other modules in the asset-pipe project.

This module reads a CommonJS module entry point for javascript files and resolves all the dependencies into an asset feed. It returns an Browserify instance.

The output of this module can be piped into the asset-pipe-js-reader module to build executable javascript bundles for the browser.

Data format

What we refere to as an asset feed is the internal data format used in Browserify. We use the exact same data format as Browserify in the asset-pipe project.

When Browserify resolves CommonJS modules each dependency will be read and transformed into an object which looks something like this:

{
    "id":"c645cf572a8f5acf8716e4846b408d3b1ca45c58",
    "source":"\"use strict\";module.exports.world=function(){return\"world\"};",
    "deps":{},
    "file":"./assets/js/bar.js"
}

Each such object is emitted on a stream for each dependency. This is the asset feed.

Installation

$ npm install asset-pipe-js-writer

Usage

Read an CommonJS module entry point and pipe the feed to a JSON on disc:

const JSONStream = require('JSONStream');
const Writer = require('asset-pipe-js-writer');
const fs = require('fs');

const writer = new Writer('./js/browser.main.js');
writer.bundle().pipe(JSONStream.stringify()).pipe(fs.createWriteStream('./feed/a.json'));

API

This module have the following API:

constructor(files, opts, bundle, minify)

Supported arguments are:

• files - Same as files in the Browserify constructor
• opts - Same as opts in the Browserify constructor
• bundle - Boolean - If true this module will output a executable javascript bundle. Default: false.
• minify - Boolean - If true the source in the asset feed will be minified. Default: false.

Returns a Readable stream.

transform()

Same as the Browserify transform method.

plugin()

Same as the Browserify plugin method.

License

The MIT License (MIT)

Copyright (c) 2017 - Trygve Lie - [e-mail]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.