sourcemap-validator

sourcemap-validator

Mapped all the things? Now validate all the maps.

Usage

validate(minifiedCode, [sourceMap], [sourceContent]);

• minifiedCode is your minified code as a string
• sourceMap is your sourcemap as a JSON string
  • Optional - If left empty, the inline sourcemap in minifiedCode will be used
• sourceContent is a map to the raw source files
  • Optional - If left empty, the inline sourceContent in sourceMap will be used

If your sourceMap has inline sourceContent, those files will take precedence over the first argument to validate, so you can pass an empty object in.

Examples

var validate('sourcemap-validator')
  , fs = require('fs')
  , assert = require('assert')
  , raw = fs.readFileSync('jquery.js')
  , min = fs.readFileSync('jquery.min.js')
  , map = fs.readFileSync('jquery.min.map');

assert.doesNotThrow(function () {
  validate({'jquery.js': raw}, min, map);
}, 'The sourcemap is not valid');

var validate('sourcemap-validator')
  , fs = require('fs')
  , assert = require('assert')
  , min = fs.readFileSync('bundle.min.js')
  , map = fs.readFileSync('bundle.min.map');

// Browserify bundles have inline sourceContent in their maps
// so pass an emtpy object as the first argument.
assert.doesNotThrow(function () {
  validate({}, min, map);
}, 'The sourcemap is not valid');

validate(sourceContent, minifiedCode, mapJSON)

Notes

The sourcemap spec isn't exactly very mature, so this module only aims to give you a Pretty Good™ idea of whether or not your sourcemap is correct.

Quoted keys in object literals

If a sourcemap maps "literal" without the quotes to column 3, we will consider that valid.

Example

var v = {
  literal: true
//^-- ok to map {name: literal, column: 3} here
};

var t = {
  "literal": true
//^-- ok to map {name: literal, column: 3} here, even though the token actually appears in column 4
};

See the discussion here

However, mapping something totally wrong like "cookie" to that index will throw an exception.

Missing mappings

There is no way for the validator to know if you are missing mappings. It can only ensure that the ones you made are sensible. The validator will consider a sourcemap with zero mappings invalid as a sanity check, but if your map at least one sensisble mapping, it is a valid map.

License

The MIT License (MIT)

Copyright (c) 2013 Ben Ng

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.