Skip to content

Latest commit

 

History

History
115 lines (74 loc) · 4.31 KB

README.md

File metadata and controls

115 lines (74 loc) · 4.31 KB

Sourcemapify

source-map plugin for Browserify

Cross-Platform Compatibility Build Status

Coverage Status Dependencies

npm License Buy us a tree

The default sourcemap that Browserify generates uses paths that are relative to the current directory, which may not always be what you want. This plugin lets you change the relative path, or use absolute paths.

This plugin was inspired by browserify-sourcemap-root-transform, so check that one out if this one doesn't meet your needs.

Related Projects

  • simplifyify
    A simplified Browserify and Watchify CLI

  • globify
    Run browserify and watchify with globs - even on Windows

  • browserify-banner
    Add a comment (and/or code) to the top of your Browserify bundle

Installation

Install using npm:

npm install @jsdevtools/sourcemapify

Usage

Command Line

Use Browserify's sub-argument command-line syntax, like this:

browserify -p [ @jsdevtools/sourcemapify --root "../../" ] --debug

Browserify API

Use the plugin programmatically like this: full example

var browserify = require('browserify');
var sourcemapify = require('@jsdevtools/sourcemapify');

browserify({debug: true})
  .plugin(sourcemapify, {base: 'www/js'})
  .bundle()
  .pipe(fs.createWriteStream('www/js/bundle.js', 'utf8'));

Options

The following options can be set via the API or command-line:

root (string)

The root path for all files in the source map. It can be an absolute or relative path. This string will be prepended as-is to each file path.

base (string)

The base path of the bundle (i.e. the bundle file's directory, relative to cwd). This path will be used to determine the relative path of each file. It can be an absolute or relative path.

Contributing

Contributions, enhancements, and bug-fixes are welcome! Open an issue on GitHub and submit a pull request.

Building

To build the project locally on your computer:

  1. Clone this repo
    git clone https://github.com/JS-DevTools/sourcemapify.git

  2. Install dependencies
    npm install

  3. Link the module to itself (so Browserify can find the plugin)
    npm link
    npm link @jsdevtools/sourcemapify

  4. Run the tests
    npm test

License

Sourcemapify is 100% free and open-source, under the MIT license. Use it however you want.

This package is Treeware. If you use it in production, then we ask that you buy the world a tree to thank us for our work. By contributing to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.

Big Thanks To

Thanks to these awesome companies for their support of Open Source developers ❤

Travis CI SauceLabs Coveralls