sfcode An Online Competing and Development Environment

webpack-sources

Contains multiple classes which represent a `Source`. A `Source` can be asked for source code, size, source map and hash.

# <tt>Source</tt>

Base class for all sources.

## Public methods

All methods should be considered as expensive as they may need to do computations.

### <tt>source</tt>

Source.prototype.source() -> String | ArrayBuffer

Returns the represented source code as string.

### <tt>size</tt>

Source.prototype.size() -> Number

Returns the size in chars of the represented source code.

### <tt>map</tt>

Source.prototype.map(options: Object) -> Object | null

Returns the SourceMap of the represented source code as JSON. May return `null` if no SourceMap is available.

The `options` object can contain the following keys:

- `columns: Boolean` (default `true`): If set to false the implementation may omit mappings for columns.
- `module: Boolean` (default `true`): If set to false the implementation may omit inner mappings for modules.

### <tt>sourceAndMap</tt>

Source.prototype.sourceAndMap(options: Object) -> {
source: String,
map: Object
}

Returns both, source code (like `Source.prototype.source()` and SourceMap (like `Source.prototype.map()`). This method could have better performance than calling `source()` and `map()` separately.

See `map()` for `options`.

### <tt>updateHash</tt>

Source.prototype.updateHash(hash: Hash) -> void

Updates the provided `Hash` object with the content of the represented source code. (`Hash` is an object with an `update` method, which is called with string values)

### <tt>node</tt> (optional)

Source.prototype.node(options: Object) -> SourceNode

This is an optional method. It may be `null` if not implemented.

Returns a `SourceNode` (see source-map library) for the represented source code.

See `map()` for `options`.

### <tt>listNode</tt> (optional)

Source.prototype.listNode(options: Object) -> SourceNode

This is an optional method. It may be `null` if not implemented.

Returns a `SourceListMap` (see source-list-map library) for the represented source code.

See `map()` for `options`.

# <tt>RawSource</tt>

Represents source code without SourceMap.

new RawSource(sourceCode: String)

# <tt>OriginalSource</tt>

Represents source code, which is a copy of the original file.

new OriginalSource(
sourceCode: String,
name: String
)

- `sourceCode`: The source code.
- `name`: The filename of the original source code.

OriginalSource tries to create column mappings if requested, by splitting the source code at typical statement borders (`;`, `{`, `}`).

# <tt>SourceMapSource</tt>

Represents source code with SourceMap, optionally having an additional SourceMap for the original source.

new SourceMapSource(
sourceCode: String,
name: String,
sourceMap: Object | String,
originalSource?: String,
innerSourceMap?: Object | String,
removeOriginalSource?: boolean
)

- `sourceCode`: The source code.
- `name`: The filename of the original source code.
- `sourceMap`: The SourceMap for the source code.
- `originalSource`: The source code of the original file. Can be omitted if the `sourceMap` already contains the original source code.
- `innerSourceMap`: The SourceMap for the `originalSource`/`name`.
- `removeOriginalSource`: Removes the source code for `name` from the final map, keeping only the deeper mappings for that file.

The `SourceMapSource` supports "identity" mappings for the `innerSourceMap`. When original source matches generated source for a mapping it's assumed to be mapped char by char allowing to keep finer mappings from `sourceMap`.

# <tt>LineToLineMappedSource</tt>

Represents source code, which is mapped line by line to the original file.

new LineToLineMappedSource(
sourceCode: String,
name: String,
originalSource: String
)

- `sourceCode`: The source code.
- `name`: The filename of the original source code.
- `originalSource`: The original source code.

# <tt>CachedSource</tt>

Decorates a `Source` and caches returned results of `map`, `source`, `size` and `sourceAndMap` in memory. Every other operation is delegated to the wrapped `Source`.

new CachedSource(source: Source)

# <tt>PrefixSource</tt>

Prefix every line of the decorated `Source` with a provided string.

new PrefixSource(
prefix: String,
source: Source
)

# <tt>ConcatSource</tt>

Concatenate multiple `Source`s or strings to a single source.

new ConcatSource(
...items?: Source | String
)

## Public methods

### <tt>add</tt>

ConcatSource.prototype.add(item: Source | String)

Adds an item to the source.

# <tt>ReplaceSource</tt>

Decorates a `Source` with replacements and insertions of source code.

The `ReplaceSource` supports "identity" mappings for child source. When original source matches generated source for a mapping it's assumed to be mapped char by char allowing to split mappings at replacements/insertions.

## Public methods

### <tt>replace</tt>

ReplaceSource.prototype.replace(
start: Number,
end: Number,
replacement: String
)

Replaces chars from `start` (0-indexed, inclusive) to `end` (0-indexed, inclusive) with `replacement`.

Locations represents locations in the original source and are not influenced by other replacements or insertions.

### <tt>insert</tt>

ReplaceSource.prototype.insert(
pos: Number,
insertion: String
)

Inserts the `insertion` before char `pos` (0-indexed).

Location represents location in the original source and is not influenced by other replacements or insertions.

### <tt>original</tt>

Get decorated `Source`.