Skip to content

Update documentation to note basis of lines and columns #277

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 22, 2017
Merged

Update documentation to note basis of lines and columns #277

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 27 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,9 +248,13 @@ Returns the original source, line, and column information for the generated
source's line and column positions provided. The only argument is an object with
the following properties:

* `line`: The line number in the generated source.
* `line`: The line number in the generated source. Line numbers in
this library are 1-based (note that the underlying source map
specification uses 0-based line numbers -- this library handles the
translation).

* `column`: The column number in the generated source.
* `column`: The column number in the generated source. Column numbers
in this library are 0-based.

* `bias`: Either `SourceMapConsumer.GREATEST_LOWER_BOUND` or
`SourceMapConsumer.LEAST_UPPER_BOUND`. Specifies whether to return the closest
Expand All @@ -264,10 +268,10 @@ and an object is returned with the following properties:
available.

* `line`: The line number in the original source, or null if this information is
not available.
not available. The line number is 1-based.

* `column`: The column number in the original source, or null if this
information is not available.
information is not available. The column number is 0-based.

* `name`: The original identifier, or null if this information is not available.

Expand All @@ -293,15 +297,19 @@ the following properties:

* `source`: The filename of the original source.

* `line`: The line number in the original source.
* `line`: The line number in the original source. The line number is
1-based.

* `column`: The column number in the original source.
* `column`: The column number in the original source. The column
number is 0-based.

and an object is returned with the following properties:

* `line`: The line number in the generated source, or null.
* `line`: The line number in the generated source, or null. The line
number is 1-based.

* `column`: The column number in the generated source, or null.
* `column`: The column number in the generated source, or null. The
column number is 0-based.

```js
consumer.generatedPositionFor({ source: "example.js", line: 2, column: 10 })
Expand All @@ -322,15 +330,19 @@ The only argument is an object with the following properties:

* `source`: The filename of the original source.

* `line`: The line number in the original source.
* `line`: The line number in the original source. The line number is
1-based.

* `column`: Optional. The column number in the original source.
* `column`: Optional. The column number in the original source. The
column number is 0-based.

and an array of objects is returned, each with the following properties:

* `line`: The line number in the generated source, or null.
* `line`: The line number in the generated source, or null. The line
number is 1-based.

* `column`: The column number in the generated source, or null.
* `column`: The column number in the generated source, or null. The
column number is 0-based.

```js
consumer.allGeneratedpositionsfor({ line: 2, source: "foo.coffee" })
Expand Down Expand Up @@ -534,10 +546,11 @@ use before outputting the generated JS and source map.
#### new SourceNode([line, column, source[, chunk[, name]]])

* `line`: The original line number associated with this source node, or null if
it isn't associated with an original line.
it isn't associated with an original line. The line number is 1-based.

* `column`: The original column number associated with this source node, or null
if it isn't associated with an original column.
if it isn't associated with an original column. The column number
is 0-based.

* `source`: The original source's filename; null if no filename is provided.

Expand Down
82 changes: 61 additions & 21 deletions dist/source-map.debug.js
View file
Open in desktop

Large diffs are not rendered by default.

80 changes: 60 additions & 20 deletions dist/source-map.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,15 @@ return /******/ (function(modules) { // webpackBootstrap
generator.addMapping(newMapping);
});
aSourceMapConsumer.sources.forEach(function (sourceFile) {
var sourceRelative = sourceFile;
if (sourceRoot !== null) {
sourceRelative = util.relative(sourceRoot, sourceFile);
}

if (!generator._sources.has(sourceRelative)) {
generator._sources.add(sourceRelative);
}

var content = aSourceMapConsumer.sourceContentFor(sourceFile);
if (content != null) {
generator.setSourceContent(sourceFile, content);
Expand Down Expand Up @@ -1013,7 +1022,7 @@ return /******/ (function(modules) { // webpackBootstrap
* stubbed out mapping.
*/
function compareByOriginalPositions(mappingA, mappingB, onlyCompareOriginal) {
var cmp = mappingA.source - mappingB.source;
var cmp = strcmp(mappingA.source, mappingB.source);
if (cmp !== 0) {
return cmp;
}
Expand All @@ -1038,7 +1047,7 @@ return /******/ (function(modules) { // webpackBootstrap
return cmp;
}

return mappingA.name - mappingB.name;
return strcmp(mappingA.name, mappingB.name);
}
exports.compareByOriginalPositions = compareByOriginalPositions;

Expand All @@ -1062,7 +1071,7 @@ return /******/ (function(modules) { // webpackBootstrap
return cmp;
}

cmp = mappingA.source - mappingB.source;
cmp = strcmp(mappingA.source, mappingB.source);
if (cmp !== 0) {
return cmp;
}
Expand All @@ -1077,7 +1086,7 @@ return /******/ (function(modules) { // webpackBootstrap
return cmp;
}

return mappingA.name - mappingB.name;
return strcmp(mappingA.name, mappingB.name);
}
exports.compareByGeneratedPositionsDeflated = compareByGeneratedPositionsDeflated;

Expand All @@ -1086,6 +1095,14 @@ return /******/ (function(modules) { // webpackBootstrap
return 0;
}

if (aStr1 === null) {
return 1; // aStr2 !== null
}

if (aStr2 === null) {
return -1; // aStr1 !== null
}

if (aStr1 > aStr2) {
return 1;
}
Expand Down Expand Up @@ -1409,6 +1426,8 @@ return /******/ (function(modules) { // webpackBootstrap

SourceMapConsumer.prototype.__generatedMappings = null;
Object.defineProperty(SourceMapConsumer.prototype, '_generatedMappings', {
configurable: true,
enumerable: true,
get: function () {
if (!this.__generatedMappings) {
this._parseMappings(this._mappings, this.sourceRoot);
Expand All @@ -1420,6 +1439,8 @@ return /******/ (function(modules) { // webpackBootstrap

SourceMapConsumer.prototype.__originalMappings = null;
Object.defineProperty(SourceMapConsumer.prototype, '_originalMappings', {
configurable: true,
enumerable: true,
get: function () {
if (!this.__originalMappings) {
this._parseMappings(this._mappings, this.sourceRoot);
Expand Down Expand Up @@ -1512,13 +1533,16 @@ return /******/ (function(modules) { // webpackBootstrap
* The only argument is an object with the following properties:
*
* - source: The filename of the original source.
* - line: The line number in the original source.
* - line: The line number in the original source. The line number is 1-based.
* - column: Optional. the column number in the original source.
* The column number is 0-based.
*
* and an array of objects is returned, each with the following properties:
*
* - line: The line number in the generated source, or null.
* - line: The line number in the generated source, or null. The
* line number is 1-based.
* - column: The column number in the generated source, or null.
* The column number is 0-based.
*/
SourceMapConsumer.prototype.allGeneratedPositionsFor =
function SourceMapConsumer_allGeneratedPositionsFor(aArgs) {
Expand Down Expand Up @@ -1925,8 +1949,10 @@ return /******/ (function(modules) { // webpackBootstrap
* source's line and column positions provided. The only argument is an object
* with the following properties:
*
* - line: The line number in the generated source.
* - column: The column number in the generated source.
* - line: The line number in the generated source. The line number
* is 1-based.
* - column: The column number in the generated source. The column
* number is 0-based.
* - bias: Either 'SourceMapConsumer.GREATEST_LOWER_BOUND' or
* 'SourceMapConsumer.LEAST_UPPER_BOUND'. Specifies whether to return the
* closest element that is smaller than or greater than the one we are
Expand All @@ -1936,8 +1962,10 @@ return /******/ (function(modules) { // webpackBootstrap
* and an object is returned with the following properties:
*
* - source: The original source file, or null.
* - line: The line number in the original source, or null.
* - column: The column number in the original source, or null.
* - line: The line number in the original source, or null. The
* line number is 1-based.
* - column: The column number in the original source, or null. The
* column number is 0-based.
* - name: The original identifier, or null.
*/
BasicSourceMapConsumer.prototype.originalPositionFor =
Expand Down Expand Up @@ -2057,8 +2085,10 @@ return /******/ (function(modules) { // webpackBootstrap
* the following properties:
*
* - source: The filename of the original source.
* - line: The line number in the original source.
* - column: The column number in the original source.
* - line: The line number in the original source. The line number
* is 1-based.
* - column: The column number in the original source. The column
* number is 0-based.
* - bias: Either 'SourceMapConsumer.GREATEST_LOWER_BOUND' or
* 'SourceMapConsumer.LEAST_UPPER_BOUND'. Specifies whether to return the
* closest element that is smaller than or greater than the one we are
Expand All @@ -2067,8 +2097,10 @@ return /******/ (function(modules) { // webpackBootstrap
*
* and an object is returned with the following properties:
*
* - line: The line number in the generated source, or null.
* - line: The line number in the generated source, or null. The
* line number is 1-based.
* - column: The column number in the generated source, or null.
* The column number is 0-based.
*/
BasicSourceMapConsumer.prototype.generatedPositionFor =
function SourceMapConsumer_generatedPositionFor(aArgs) {
Expand Down Expand Up @@ -2242,14 +2274,18 @@ return /******/ (function(modules) { // webpackBootstrap
* source's line and column positions provided. The only argument is an object
* with the following properties:
*
* - line: The line number in the generated source.
* - column: The column number in the generated source.
* - line: The line number in the generated source. The line number
* is 1-based.
* - column: The column number in the generated source. The column
* number is 0-based.
*
* and an object is returned with the following properties:
*
* - source: The original source file, or null.
* - line: The line number in the original source, or null.
* - column: The column number in the original source, or null.
* - line: The line number in the original source, or null. The
* line number is 1-based.
* - column: The column number in the original source, or null. The
* column number is 0-based.
* - name: The original identifier, or null.
*/
IndexedSourceMapConsumer.prototype.originalPositionFor =
Expand Down Expand Up @@ -2333,13 +2369,17 @@ return /******/ (function(modules) { // webpackBootstrap
* the following properties:
*
* - source: The filename of the original source.
* - line: The line number in the original source.
* - column: The column number in the original source.
* - line: The line number in the original source. The line number
* is 1-based.
* - column: The column number in the original source. The column
* number is 0-based.
*
* and an object is returned with the following properties:
*
* - line: The line number in the generated source, or null.
* - line: The line number in the generated source, or null. The
* line number is 1-based.
* - column: The column number in the generated source, or null.
* The column number is 0-based.
*/
IndexedSourceMapConsumer.prototype.generatedPositionFor =
function IndexedSourceMapConsumer_generatedPositionFor(aArgs) {
Expand Down
2 changes: 1 addition & 1 deletion dist/source-map.min.js
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dist/source-map.min.js.map
View file
Open in desktop

Large diffs are not rendered by default.

Loading