77 lines
2.5 KiB
Markdown
77 lines
2.5 KiB
Markdown
|
# @jridgewell/trace-mapping
|
||
|
|
|
||
|
|
> Trace the original position through a source map
|
||
|
|
|
||
|
|
`trace-mapping` allows you to take the line and column of an output file and trace it to the
|
||
|
|
original location in the source file through a source map.
|
||
|
|
|
||
|
|
You may already be familiar with the [`source-map`][source-map] package's `SourceMapConsumer`. This
|
||
|
|
provides the same `originalPositionFor` API, without requires WASM.
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
```sh
|
||
|
|
npm install @jridgewell/trace-mapping
|
||
|
|
```
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
```typescript
|
||
|
|
import { TraceMap } from '@jridgewell/trace-mapping';
|
||
|
|
// also exported as default.
|
||
|
|
|
||
|
|
const tracer = new TraceMap({
|
||
|
|
version: 3,
|
||
|
|
sources: ['input.js'],
|
||
|
|
names: ['foo'],
|
||
|
|
mappings: 'KAyCIA',
|
||
|
|
});
|
||
|
|
|
||
|
|
// Lines start at line 1, columns at column 0.
|
||
|
|
const traced = tracer.originalPositionFor({ line: 1, column: 5 });
|
||
|
|
assert.deepEqual(traced, {
|
||
|
|
source: 'input.js',
|
||
|
|
line: 42,
|
||
|
|
column: 4,
|
||
|
|
name: 'foo',
|
||
|
|
});
|
||
|
|
```
|
||
|
|
|
||
|
|
We also provide a lower level API to get the actual segment that matches our line and column. Unlike
|
||
|
|
`originalPositionFor`, `traceSegment` uses a 0-base for `line`:
|
||
|
|
|
||
|
|
```typescript
|
||
|
|
// line is 0-base.
|
||
|
|
const traced = tracer.originalPositionFor(/* line */ 0, /* column */ 5);
|
||
|
|
|
||
|
|
// Segments are [outputColumn, sourcesIndex, sourceLine, sourceColumn, namesIndex]
|
||
|
|
// Again, line is 0-base and so is sourceLine
|
||
|
|
assert.deepEqual(traced, [5, 0, 41, 4, 0]);
|
||
|
|
```
|
||
|
|
|
||
|
|
## Benchmarks
|
||
|
|
|
||
|
|
`trace-mapping` is the fastest source map tracing library, by a factor of 4-5x when
|
||
|
|
constructing/parsing source maps and another 4-5x when using `originalPositionFor` on an already
|
||
|
|
constructed instance.
|
||
|
|
|
||
|
|
```
|
||
|
|
node v16.13.2
|
||
|
|
|
||
|
|
trace-mapping: decoded JSON input x 4,224 ops/sec ±0.23% (98 runs sampled)
|
||
|
|
trace-mapping: encoded JSON input x 4,803 ops/sec ±0.38% (99 runs sampled)
|
||
|
|
trace-mapping: decoded Object input x 105,471 ops/sec ±0.10% (100 runs sampled)
|
||
|
|
trace-mapping: encoded Object input x 4,913 ops/sec ±0.36% (100 runs sampled)
|
||
|
|
source-map-js: encoded Object input x 3,610 ops/sec ±0.24% (97 runs sampled)
|
||
|
|
source-map: encoded Object input x 1,467 ops/sec ±0.22% (97 runs sampled)
|
||
|
|
Fastest is trace-mapping: decoded Object input
|
||
|
|
|
||
|
|
trace-mapping: decoded originalPositionFor x 7,588 ops/sec ±0.09% (101 runs sampled)
|
||
|
|
trace-mapping: encoded originalPositionFor x 7,704 ops/sec ±0.19% (101 runs sampled)
|
||
|
|
source-map-js: encoded originalPositionFor x 1,657 ops/sec ±0.18% (100 runs sampled)
|
||
|
|
source-map: encoded originalPositionFor x 927 ops/sec ±0.28% (99 runs sampled)
|
||
|
|
Fastest is trace-mapping: encoded originalPositionFor
|
||
|
|
```
|
||
|
|
|
||
|
|
[source-map]: https://www.npmjs.com/package/source-map
|