resolve-source-map v0.0.3

resolve-source-map

A simple utility to resolve source maps.

Dependencies

CoffeeScript

To use the shell script, the coffee command from the coffee-script package must be available:

npm install coffee-script -g

Installation

For nodejs via npm:

npm install resolve-source-map

Or, install globally (recommended):

npm install resolve-source-map -g

Using the shell script to resolve a position

A simple shell script is provided with the package. To use it, you should install the package globally (see Installation).

resolve-source-map path line column

Where path is the path to the .map file, and line and column indicate the position within the compiled source code to resolve.

Command Output

The command will output the following information about the original source file:

path:line:column

Tests for executable

The following snippet acts as a simple test for the executable:

cmd = './node_modules/.bin/resolve-source-map ./test/test.map 8 22'

require('child_process').exec cmd, (error, stdout, stderr) ->
  throw error if error?
  assert.equal "test.coffee:4:12\n", stdout
  assert.equal "", stderr

API

To use the API, just require the module:

ResolveSourceMap = require('resolve-source-map')

We'll use the assert library to demonstrate behavior in the examples:

assert = require 'assert'

Resolve a position

Call the resolve method, passing in the path to the .map file, the line number and column number, followed by a callback to handle the results:

The following demonstrates this functionality, using the test.map and test.coffee files located in this package:

ResolveSourceMap.resolve './test/test.map', 8, 22, (error, mapping) ->
  assert.equal 'test.coffee', mapping.source
  assert.equal 4, mapping.line
  assert.equal 12, mapping.column