Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

magic-string

Package Overview
Dependencies
Maintainers
0
Versions
121
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

magic-string - npm Package Compare versions

Comparing version 0.30.15 to 0.30.16

480

dist/magic-string.cjs.d.ts
export interface BundleOptions {
intro?: string;
separator?: string;
intro?: string;
separator?: string;
}
export interface SourceMapOptions {
/**
* Whether the mapping should be high-resolution.
* Hi-res mappings map every single character, meaning (for example) your devtools will always
* be able to pinpoint the exact location of function calls and so on.
* With lo-res mappings, devtools may only be able to identify the correct
* line - but they're quicker to generate and less bulky.
* You can also set `"boundary"` to generate a semi-hi-res mappings segmented per word boundary
* instead of per character, suitable for string semantics that are separated by words.
* If sourcemap locations have been specified with s.addSourceMapLocation(), they will be used here.
*/
hires?: boolean | 'boundary';
/**
* The filename where you plan to write the sourcemap.
*/
file?: string;
/**
* The filename of the file containing the original source.
*/
source?: string;
/**
* Whether to include the original content in the map's sourcesContent array.
*/
includeContent?: boolean;
/**
* Whether the mapping should be high-resolution.
* Hi-res mappings map every single character, meaning (for example) your devtools will always
* be able to pinpoint the exact location of function calls and so on.
* With lo-res mappings, devtools may only be able to identify the correct
* line - but they're quicker to generate and less bulky.
* You can also set `"boundary"` to generate a semi-hi-res mappings segmented per word boundary
* instead of per character, suitable for string semantics that are separated by words.
* If sourcemap locations have been specified with s.addSourceMapLocation(), they will be used here.
*/
hires?: boolean | 'boundary';
/**
* The filename where you plan to write the sourcemap.
*/
file?: string;
/**
* The filename of the file containing the original source.
*/
source?: string;
/**
* Whether to include the original content in the map's sourcesContent array.
*/
includeContent?: boolean;
}
export type SourceMapSegment =
| [number]
| [number, number, number, number]
| [number, number, number, number, number];
| [number]
| [number, number, number, number]
| [number, number, number, number, number];
export interface DecodedSourceMap {
file: string;
sources: string[];
sourcesContent?: string[];
names: string[];
mappings: SourceMapSegment[][];
x_google_ignoreList?: number[];
file: string;
sources: string[];
sourcesContent?: string[];
names: string[];
mappings: SourceMapSegment[][];
x_google_ignoreList?: number[];
}
export class SourceMap {
constructor(properties: DecodedSourceMap);
constructor(properties: DecodedSourceMap);
version: number;
file: string;
sources: string[];
sourcesContent?: string[];
names: string[];
mappings: string;
x_google_ignoreList?: number[];
debugId?: string;
version: number;
file: string;
sources: string[];
sourcesContent?: string[];
names: string[];
mappings: string;
x_google_ignoreList?: number[];
debugId?: string;
/**
* Returns the equivalent of `JSON.stringify(map)`
*/
toString(): string;
/**
* Returns a DataURI containing the sourcemap. Useful for doing this sort of thing:
* `generateMap(options?: SourceMapOptions): SourceMap;`
*/
toUrl(): string;
/**
* Returns the equivalent of `JSON.stringify(map)`
*/
toString(): string;
/**
* Returns a DataURI containing the sourcemap. Useful for doing this sort of thing:
* `generateMap(options?: SourceMapOptions): SourceMap;`
*/
toUrl(): string;
}
export class Bundle {
constructor(options?: BundleOptions);
/**
* Adds the specified source to the bundle, which can either be a `MagicString` object directly,
* or an options object that holds a magic string `content` property and optionally provides
* a `filename` for the source within the bundle, as well as an optional `ignoreList` hint
* (which defaults to `false`). The `filename` is used when constructing the source map for the
* bundle, to identify this `source` in the source map's `sources` field. The `ignoreList` hint
* is used to populate the `x_google_ignoreList` extension field in the source map, which is a
* mechanism for tools to signal to debuggers that certain sources should be ignored by default
* (depending on user preferences).
*/
addSource(source: MagicString | { filename?: string, content: MagicString, ignoreList?: boolean }): this;
append(str: string, options?: BundleOptions): this;
clone(): this;
generateMap(options?: SourceMapOptions): Omit<SourceMap, 'sourcesContent'> & { sourcesContent: Array<string | null> };
generateDecodedMap(options?: SourceMapOptions): Omit<DecodedSourceMap, 'sourcesContent'> & { sourcesContent: Array<string | null> };
getIndentString(): string;
indent(indentStr?: string): this;
indentExclusionRanges: ExclusionRange | Array<ExclusionRange>;
prepend(str: string): this;
toString(): string;
trimLines(): this;
trim(charType?: string): this;
trimStart(charType?: string): this;
trimEnd(charType?: string): this;
isEmpty(): boolean;
length(): number;
constructor(options?: BundleOptions);
/**
* Adds the specified source to the bundle, which can either be a `MagicString` object directly,
* or an options object that holds a magic string `content` property and optionally provides
* a `filename` for the source within the bundle, as well as an optional `ignoreList` hint
* (which defaults to `false`). The `filename` is used when constructing the source map for the
* bundle, to identify this `source` in the source map's `sources` field. The `ignoreList` hint
* is used to populate the `x_google_ignoreList` extension field in the source map, which is a
* mechanism for tools to signal to debuggers that certain sources should be ignored by default
* (depending on user preferences).
*/
addSource(
source: MagicString | { filename?: string; content: MagicString; ignoreList?: boolean },
): this;
append(str: string, options?: BundleOptions): this;
clone(): this;
generateMap(
options?: SourceMapOptions,
): Omit<SourceMap, 'sourcesContent'> & { sourcesContent: Array<string | null> };
generateDecodedMap(
options?: SourceMapOptions,
): Omit<DecodedSourceMap, 'sourcesContent'> & { sourcesContent: Array<string | null> };
getIndentString(): string;
indent(indentStr?: string): this;
indentExclusionRanges: ExclusionRange | Array<ExclusionRange>;
prepend(str: string): this;
toString(): string;
trimLines(): this;
trim(charType?: string): this;
trimStart(charType?: string): this;
trimEnd(charType?: string): this;
isEmpty(): boolean;
length(): number;
}
export type ExclusionRange = [ number, number ];
export type ExclusionRange = [number, number];
export interface MagicStringOptions {
filename?: string,
indentExclusionRanges?: ExclusionRange | Array<ExclusionRange>;
filename?: string;
indentExclusionRanges?: ExclusionRange | Array<ExclusionRange>;
offset?: number;
}
export interface IndentOptions {
exclude?: ExclusionRange | Array<ExclusionRange>;
indentStart?: boolean;
exclude?: ExclusionRange | Array<ExclusionRange>;
indentStart?: boolean;
}
export interface OverwriteOptions {
storeName?: boolean;
contentOnly?: boolean;
storeName?: boolean;
contentOnly?: boolean;
}
export interface UpdateOptions {
storeName?: boolean;
overwrite?: boolean;
storeName?: boolean;
overwrite?: boolean;
}
export default class MagicString {
constructor(str: string, options?: MagicStringOptions);
/**
* Adds the specified character index (with respect to the original string) to sourcemap mappings, if `hires` is false.
*/
addSourcemapLocation(char: number): void;
/**
* Appends the specified content to the end of the string.
*/
append(content: string): this;
/**
* Appends the specified content at the index in the original string.
* If a range *ending* with index is subsequently moved, the insert will be moved with it.
* See also `s.prependLeft(...)`.
*/
appendLeft(index: number, content: string): this;
/**
* Appends the specified content at the index in the original string.
* If a range *starting* with index is subsequently moved, the insert will be moved with it.
* See also `s.prependRight(...)`.
*/
appendRight(index: number, content: string): this;
/**
* Does what you'd expect.
*/
clone(): this;
/**
* Generates a version 3 sourcemap.
*/
generateMap(options?: SourceMapOptions): SourceMap;
/**
* Generates a sourcemap object with raw mappings in array form, rather than encoded as a string.
* Useful if you need to manipulate the sourcemap further, but most of the time you will use `generateMap` instead.
*/
generateDecodedMap(options?: SourceMapOptions): DecodedSourceMap;
getIndentString(): string;
constructor(str: string, options?: MagicStringOptions);
/**
* Adds the specified character index (with respect to the original string) to sourcemap mappings, if `hires` is false.
*/
addSourcemapLocation(char: number): void;
/**
* Appends the specified content to the end of the string.
*/
append(content: string): this;
/**
* Appends the specified content at the index in the original string.
* If a range *ending* with index is subsequently moved, the insert will be moved with it.
* See also `s.prependLeft(...)`.
*/
appendLeft(index: number, content: string): this;
/**
* Appends the specified content at the index in the original string.
* If a range *starting* with index is subsequently moved, the insert will be moved with it.
* See also `s.prependRight(...)`.
*/
appendRight(index: number, content: string): this;
/**
* Does what you'd expect.
*/
clone(): this;
/**
* Generates a version 3 sourcemap.
*/
generateMap(options?: SourceMapOptions): SourceMap;
/**
* Generates a sourcemap object with raw mappings in array form, rather than encoded as a string.
* Useful if you need to manipulate the sourcemap further, but most of the time you will use `generateMap` instead.
*/
generateDecodedMap(options?: SourceMapOptions): DecodedSourceMap;
getIndentString(): string;
/**
* Prefixes each line of the string with prefix.
* If prefix is not supplied, the indentation will be guessed from the original content, falling back to a single tab character.
*/
indent(options?: IndentOptions): this;
/**
* Prefixes each line of the string with prefix.
* If prefix is not supplied, the indentation will be guessed from the original content, falling back to a single tab character.
*
* The options argument can have an exclude property, which is an array of [start, end] character ranges.
* These ranges will be excluded from the indentation - useful for (e.g.) multiline strings.
*/
indent(indentStr?: string, options?: IndentOptions): this;
indentExclusionRanges: ExclusionRange | Array<ExclusionRange>;
/**
* Prefixes each line of the string with prefix.
* If prefix is not supplied, the indentation will be guessed from the original content, falling back to a single tab character.
*/
indent(options?: IndentOptions): this;
/**
* Prefixes each line of the string with prefix.
* If prefix is not supplied, the indentation will be guessed from the original content, falling back to a single tab character.
*
* The options argument can have an exclude property, which is an array of [start, end] character ranges.
* These ranges will be excluded from the indentation - useful for (e.g.) multiline strings.
*/
indent(indentStr?: string, options?: IndentOptions): this;
indentExclusionRanges: ExclusionRange | Array<ExclusionRange>;
/**
* Moves the characters from `start` and `end` to `index`.
*/
move(start: number, end: number, index: number): this;
/**
* Replaces the characters from `start` to `end` with `content`, along with the appended/prepended content in
* that range. The same restrictions as `s.remove()` apply.
*
* The fourth argument is optional. It can have a storeName property — if true, the original name will be stored
* for later inclusion in a sourcemap's names array — and a contentOnly property which determines whether only
* the content is overwritten, or anything that was appended/prepended to the range as well.
*
* It may be preferred to use `s.update(...)` instead if you wish to avoid overwriting the appended/prepended content.
*/
overwrite(start: number, end: number, content: string, options?: boolean | OverwriteOptions): this;
/**
* Replaces the characters from `start` to `end` with `content`. The same restrictions as `s.remove()` apply.
*
* The fourth argument is optional. It can have a storeName property — if true, the original name will be stored
* for later inclusion in a sourcemap's names array — and an overwrite property which determines whether only
* the content is overwritten, or anything that was appended/prepended to the range as well.
*/
update(start: number, end: number, content: string, options?: boolean | UpdateOptions): this;
/**
* Prepends the string with the specified content.
*/
prepend(content: string): this;
/**
* Same as `s.appendLeft(...)`, except that the inserted content will go *before* any previous appends or prepends at index
*/
prependLeft(index: number, content: string): this;
/**
* Same as `s.appendRight(...)`, except that the inserted content will go *before* any previous appends or prepends at `index`
*/
prependRight(index: number, content: string): this;
/**
* Removes the characters from `start` to `end` (of the original string, **not** the generated string).
* Removing the same content twice, or making removals that partially overlap, will cause an error.
*/
remove(start: number, end: number): this;
/**
* Reset the modified characters from `start` to `end` (of the original string, **not** the generated string).
*/
reset(start: number, end: number): this;
/**
* Returns the content of the generated string that corresponds to the slice between `start` and `end` of the original string.
* Throws error if the indices are for characters that were already removed.
*/
slice(start: number, end: number): string;
/**
* Returns a clone of `s`, with all content before the `start` and `end` characters of the original string removed.
*/
snip(start: number, end: number): this;
/**
* Trims content matching `charType` (defaults to `\s`, i.e. whitespace) from the start and end.
*/
trim(charType?: string): this;
/**
* Trims content matching `charType` (defaults to `\s`, i.e. whitespace) from the start.
*/
trimStart(charType?: string): this;
/**
* Trims content matching `charType` (defaults to `\s`, i.e. whitespace) from the end.
*/
trimEnd(charType?: string): this;
/**
* Removes empty lines from the start and end.
*/
trimLines(): this;
/**
* String replacement with RegExp or string.
*/
replace(regex: RegExp | string, replacement: string | ((substring: string, ...args: any[]) => string)): this;
/**
* Same as `s.replace`, but replace all matched strings instead of just one.
*/
replaceAll(regex: RegExp | string, replacement: string | ((substring: string, ...args: any[]) => string)): this;
/**
* Moves the characters from `start` and `end` to `index`.
*/
move(start: number, end: number, index: number): this;
/**
* Replaces the characters from `start` to `end` with `content`, along with the appended/prepended content in
* that range. The same restrictions as `s.remove()` apply.
*
* The fourth argument is optional. It can have a storeName property — if true, the original name will be stored
* for later inclusion in a sourcemap's names array — and a contentOnly property which determines whether only
* the content is overwritten, or anything that was appended/prepended to the range as well.
*
* It may be preferred to use `s.update(...)` instead if you wish to avoid overwriting the appended/prepended content.
*/
overwrite(
start: number,
end: number,
content: string,
options?: boolean | OverwriteOptions,
): this;
/**
* Replaces the characters from `start` to `end` with `content`. The same restrictions as `s.remove()` apply.
*
* The fourth argument is optional. It can have a storeName property — if true, the original name will be stored
* for later inclusion in a sourcemap's names array — and an overwrite property which determines whether only
* the content is overwritten, or anything that was appended/prepended to the range as well.
*/
update(start: number, end: number, content: string, options?: boolean | UpdateOptions): this;
/**
* Prepends the string with the specified content.
*/
prepend(content: string): this;
/**
* Same as `s.appendLeft(...)`, except that the inserted content will go *before* any previous appends or prepends at index
*/
prependLeft(index: number, content: string): this;
/**
* Same as `s.appendRight(...)`, except that the inserted content will go *before* any previous appends or prepends at `index`
*/
prependRight(index: number, content: string): this;
/**
* Removes the characters from `start` to `end` (of the original string, **not** the generated string).
* Removing the same content twice, or making removals that partially overlap, will cause an error.
*/
remove(start: number, end: number): this;
/**
* Reset the modified characters from `start` to `end` (of the original string, **not** the generated string).
*/
reset(start: number, end: number): this;
/**
* Returns the content of the generated string that corresponds to the slice between `start` and `end` of the original string.
* Throws error if the indices are for characters that were already removed.
*/
slice(start: number, end: number): string;
/**
* Returns a clone of `s`, with all content before the `start` and `end` characters of the original string removed.
*/
snip(start: number, end: number): this;
/**
* Trims content matching `charType` (defaults to `\s`, i.e. whitespace) from the start and end.
*/
trim(charType?: string): this;
/**
* Trims content matching `charType` (defaults to `\s`, i.e. whitespace) from the start.
*/
trimStart(charType?: string): this;
/**
* Trims content matching `charType` (defaults to `\s`, i.e. whitespace) from the end.
*/
trimEnd(charType?: string): this;
/**
* Removes empty lines from the start and end.
*/
trimLines(): this;
/**
* String replacement with RegExp or string.
*/
replace(
regex: RegExp | string,
replacement: string | ((substring: string, ...args: any[]) => string),
): this;
/**
* Same as `s.replace`, but replace all matched strings instead of just one.
*/
replaceAll(
regex: RegExp | string,
replacement: string | ((substring: string, ...args: any[]) => string),
): this;
lastChar(): string;
lastLine(): string;
/**
* Returns true if the resulting source is empty (disregarding white space).
*/
isEmpty(): boolean;
length(): number;
lastChar(): string;
lastLine(): string;
/**
* Returns true if the resulting source is empty (disregarding white space).
*/
isEmpty(): boolean;
length(): number;
/**
* Indicates if the string has been changed.
*/
hasChanged(): boolean;
/**
* Indicates if the string has been changed.
*/
hasChanged(): boolean;
original: string;
/**
* Returns the generated string.
*/
toString(): string;
original: string;
/**
* Returns the generated string.
*/
toString(): string;
offset: number;
}

@@ -130,3 +130,3 @@ 'use strict';

// ✔️ edit -> '' + 'test'
// ✖️ edit -> 'test' + ''
// ✖️ edit -> 'test' + ''
// TODO is this block necessary?...

@@ -378,2 +378,3 @@ newChunk.edit('', false);

first = true;
charInHiresBoundary = false;
} else {

@@ -456,2 +457,3 @@ if (this.hires || first || sourcemapLocations.has(originalCharIndex)) {

ignoreList: { writable: true, value: options.ignoreList },
offset: { writable: true, value: options.offset || 0 },
});

@@ -475,2 +477,4 @@

appendLeft(index, content) {
index = index + this.offset;
if (typeof content !== 'string') throw new TypeError('inserted content must be a string');

@@ -491,2 +495,4 @@

appendRight(index, content) {
index = index + this.offset;
if (typeof content !== 'string') throw new TypeError('inserted content must be a string');

@@ -507,3 +513,3 @@

clone() {
const cloned = new MagicString(this.original, { filename: this.filename });
const cloned = new MagicString(this.original, { filename: this.filename, offset: this.offset });

@@ -706,3 +712,3 @@ let originalChunk = this.firstChunk;

'magicString.insertLeft(...) is deprecated. Use magicString.appendLeft(...) instead',
); // eslint-disable-line no-console
);
warned.insertLeft = true;

@@ -718,3 +724,3 @@ }

'magicString.insertRight(...) is deprecated. Use magicString.prependRight(...) instead',
); // eslint-disable-line no-console
);
warned.insertRight = true;

@@ -727,2 +733,6 @@ }

move(start, end, index) {
start = start + this.offset;
end = end + this.offset;
index = index + this.offset;
if (index >= start && index <= end) throw new Error('Cannot move a selection inside itself');

@@ -770,2 +780,5 @@

update(start, end, content, options) {
start = start + this.offset;
end = end + this.offset;
if (typeof content !== 'string') throw new TypeError('replacement content must be a string');

@@ -791,3 +804,3 @@

'The final argument to magicString.overwrite(...) should be an options object. See https://github.com/rich-harris/magic-string',
); // eslint-disable-line no-console
);
warned.storeName = true;

@@ -843,2 +856,4 @@ }

prependLeft(index, content) {
index = index + this.offset;
if (typeof content !== 'string') throw new TypeError('inserted content must be a string');

@@ -859,2 +874,4 @@

prependRight(index, content) {
index = index + this.offset;
if (typeof content !== 'string') throw new TypeError('inserted content must be a string');

@@ -875,2 +892,5 @@

remove(start, end) {
start = start + this.offset;
end = end + this.offset;
if (this.original.length !== 0) {

@@ -902,2 +922,5 @@ while (start < 0) start += this.original.length;

reset(start, end) {
start = start + this.offset;
end = end + this.offset;
if (this.original.length !== 0) {

@@ -967,3 +990,6 @@ while (start < 0) start += this.original.length;

slice(start = 0, end = this.original.length) {
slice(start = 0, end = this.original.length - this.offset) {
start = start + this.offset;
end = end + this.offset;
if (this.original.length !== 0) {

@@ -1204,7 +1230,3 @@ while (start < 0) start += this.original.length;

if (replacement !== match[0]) {
this.overwrite(
match.index,
match.index + match[0].length,
replacement
);
this.overwrite(match.index, match.index + match[0].length, replacement);
}

@@ -1218,7 +1240,3 @@ }

if (replacement !== match[0]) {
this.overwrite(
match.index,
match.index + match[0].length,
replacement
);
this.overwrite(match.index, match.index + match[0].length, replacement);
}

@@ -1258,4 +1276,3 @@ }

const previous = original.slice(index, index + stringLength);
if (previous !== replacement)
this.overwrite(index, index + stringLength, replacement);
if (previous !== replacement) this.overwrite(index, index + stringLength, replacement);
}

@@ -1262,0 +1279,0 @@

@@ -132,3 +132,3 @@ (function (global, factory) {

// ✔️ edit -> '' + 'test'
// ✖️ edit -> 'test' + ''
// ✖️ edit -> 'test' + ''
// TODO is this block necessary?...

@@ -473,2 +473,3 @@ newChunk.edit('', false);

first = true;
charInHiresBoundary = false;
} else {

@@ -551,2 +552,3 @@ if (this.hires || first || sourcemapLocations.has(originalCharIndex)) {

ignoreList: { writable: true, value: options.ignoreList },
offset: { writable: true, value: options.offset || 0 },
});

@@ -570,2 +572,4 @@

appendLeft(index, content) {
index = index + this.offset;
if (typeof content !== 'string') throw new TypeError('inserted content must be a string');

@@ -586,2 +590,4 @@

appendRight(index, content) {
index = index + this.offset;
if (typeof content !== 'string') throw new TypeError('inserted content must be a string');

@@ -602,3 +608,3 @@

clone() {
const cloned = new MagicString(this.original, { filename: this.filename });
const cloned = new MagicString(this.original, { filename: this.filename, offset: this.offset });

@@ -801,3 +807,3 @@ let originalChunk = this.firstChunk;

'magicString.insertLeft(...) is deprecated. Use magicString.appendLeft(...) instead',
); // eslint-disable-line no-console
);
warned.insertLeft = true;

@@ -813,3 +819,3 @@ }

'magicString.insertRight(...) is deprecated. Use magicString.prependRight(...) instead',
); // eslint-disable-line no-console
);
warned.insertRight = true;

@@ -822,2 +828,6 @@ }

move(start, end, index) {
start = start + this.offset;
end = end + this.offset;
index = index + this.offset;
if (index >= start && index <= end) throw new Error('Cannot move a selection inside itself');

@@ -865,2 +875,5 @@

update(start, end, content, options) {
start = start + this.offset;
end = end + this.offset;
if (typeof content !== 'string') throw new TypeError('replacement content must be a string');

@@ -886,3 +899,3 @@

'The final argument to magicString.overwrite(...) should be an options object. See https://github.com/rich-harris/magic-string',
); // eslint-disable-line no-console
);
warned.storeName = true;

@@ -938,2 +951,4 @@ }

prependLeft(index, content) {
index = index + this.offset;
if (typeof content !== 'string') throw new TypeError('inserted content must be a string');

@@ -954,2 +969,4 @@

prependRight(index, content) {
index = index + this.offset;
if (typeof content !== 'string') throw new TypeError('inserted content must be a string');

@@ -970,2 +987,5 @@

remove(start, end) {
start = start + this.offset;
end = end + this.offset;
if (this.original.length !== 0) {

@@ -997,2 +1017,5 @@ while (start < 0) start += this.original.length;

reset(start, end) {
start = start + this.offset;
end = end + this.offset;
if (this.original.length !== 0) {

@@ -1062,3 +1085,6 @@ while (start < 0) start += this.original.length;

slice(start = 0, end = this.original.length) {
slice(start = 0, end = this.original.length - this.offset) {
start = start + this.offset;
end = end + this.offset;
if (this.original.length !== 0) {

@@ -1299,7 +1325,3 @@ while (start < 0) start += this.original.length;

if (replacement !== match[0]) {
this.overwrite(
match.index,
match.index + match[0].length,
replacement
);
this.overwrite(match.index, match.index + match[0].length, replacement);
}

@@ -1313,7 +1335,3 @@ }

if (replacement !== match[0]) {
this.overwrite(
match.index,
match.index + match[0].length,
replacement
);
this.overwrite(match.index, match.index + match[0].length, replacement);
}

@@ -1353,4 +1371,3 @@ }

const previous = original.slice(index, index + stringLength);
if (previous !== replacement)
this.overwrite(index, index + stringLength, replacement);
if (previous !== replacement) this.overwrite(index, index + stringLength, replacement);
}

@@ -1357,0 +1374,0 @@

{
"name": "magic-string",
"version": "0.30.15",
"packageManager": "pnpm@9.6.0",
"description": "Modify strings, generate sourcemaps",
"keywords": [
"string",
"string manipulation",
"sourcemap",
"templating",
"transpilation"
],
"repository": "https://github.com/rich-harris/magic-string",
"license": "MIT",
"author": "Rich Harris",
"main": "./dist/magic-string.cjs.js",
"module": "./dist/magic-string.es.mjs",
"sideEffects": false,
"jsnext:main": "./dist/magic-string.es.mjs",
"types": "./dist/magic-string.cjs.d.ts",
"exports": {
"./package.json": "./package.json",
".": {
"import": "./dist/magic-string.es.mjs",
"require": "./dist/magic-string.cjs.js"
}
},
"files": [
"dist/*",
"index.d.ts",
"README.md"
],
"scripts": {
"build": "rollup -c",
"changelog": "conventional-changelog -p angular -i CHANGELOG.md -s",
"format": "prettier --single-quote --print-width 100 --use-tabs --write src/*.js src/**/*.js",
"lint": "eslint src test && publint",
"lint:fix": "eslint src test --fix",
"prepare": "npm run build",
"prepublishOnly": "npm run lint && rm -rf dist && npm test",
"release": "bumpp -x \"npm run changelog\" --all --commit --tag --push && npm publish",
"pretest": "npm run build",
"test": "mocha",
"bench": "npm run build && node benchmark/index.mjs",
"watch": "rollup -cw"
},
"devDependencies": {
"@rollup/plugin-node-resolve": "^15.2.3",
"@rollup/plugin-replace": "^5.0.7",
"benchmark": "^2.1.4",
"bumpp": "^9.4.1",
"conventional-changelog-cli": "^3.0.0",
"eslint": "^8.57.0",
"mocha": "^10.7.0",
"prettier": "^3.3.3",
"publint": "^0.2.9",
"rollup": "^3.29.4",
"source-map-js": "^1.2.0",
"source-map-support": "^0.5.21"
},
"dependencies": {
"@jridgewell/sourcemap-codec": "^1.5.0"
}
"name": "magic-string",
"version": "0.30.16",
"packageManager": "pnpm@9.15.0",
"description": "Modify strings, generate sourcemaps",
"keywords": [
"string",
"string manipulation",
"sourcemap",
"templating",
"transpilation"
],
"type": "module",
"repository": "https://github.com/rich-harris/magic-string",
"license": "MIT",
"author": "Rich Harris",
"main": "./dist/magic-string.cjs.js",
"module": "./dist/magic-string.es.mjs",
"sideEffects": false,
"jsnext:main": "./dist/magic-string.es.mjs",
"types": "./dist/magic-string.cjs.d.ts",
"exports": {
"./package.json": "./package.json",
".": {
"import": "./dist/magic-string.es.mjs",
"require": "./dist/magic-string.cjs.js"
}
},
"files": [
"dist/*",
"index.d.ts",
"README.md"
],
"scripts": {
"build": "rollup -c",
"changelog": "conventional-changelog -p angular -i CHANGELOG.md -s",
"format": "prettier --single-quote --print-width 100 --use-tabs --write .",
"lint": "eslint src test && publint",
"lint:fix": "eslint src test --fix",
"prepare": "npm run build",
"prepublishOnly": "npm run lint && rm -rf dist && npm test",
"release": "bumpp -x \"npm run changelog\" --all --commit --tag --push && npm publish",
"pretest": "npm run build",
"test": "vitest run",
"test:dev": "vitest",
"bench": "npm run build && node benchmark/index.mjs",
"watch": "rollup -cw"
},
"devDependencies": {
"@eslint/js": "^9.16.0",
"@rollup/plugin-node-resolve": "^15.3.0",
"@rollup/plugin-replace": "^5.0.7",
"benchmark": "^2.1.4",
"bumpp": "^9.9.1",
"conventional-changelog-cli": "^3.0.0",
"eslint": "^9.16.0",
"prettier": "^3.4.2",
"publint": "^0.2.12",
"rollup": "^3.29.5",
"source-map-js": "^1.2.1",
"source-map-support": "^0.5.21",
"vitest": "^2.1.8"
},
"dependencies": {
"@jridgewell/sourcemap-codec": "^1.5.0"
}
}

@@ -31,3 +31,3 @@ # magic-string

```html
<script src='magic-string.umd.js'></script>
<script src="magic-string.umd.js"></script>
```

@@ -43,3 +43,3 @@

import MagicString from 'magic-string';
import fs from 'fs'
import fs from 'fs';

@@ -58,5 +58,5 @@ const s = new MagicString('problems = 99');

const map = s.generateMap({
source: 'source.js',
file: 'converted.js.map',
includeContent: true
source: 'source.js',
file: 'converted.js.map',
includeContent: true,
}); // generates a v3 sourcemap

@@ -72,10 +72,28 @@

const s = new MagicString(someCode, {
// these options will be used if you later call `bundle.addSource( s )` - see below
filename: 'foo.js',
indentExclusionRanges: [/*...*/],
// mark source as ignore in DevTools, see below #Bundling
ignoreList: false
// these options will be used if you later call `bundle.addSource( s )` - see below
filename: 'foo.js',
indentExclusionRanges: [
/*...*/
],
// mark source as ignore in DevTools, see below #Bundling
ignoreList: false,
// adjust the incoming position - see below
offset: 0,
});
```
## Properties
### s.offset
Sets the offset property to adjust the incoming position for the following APIs: `slice`, `update`, `overwrite`, `appendLeft`, `prependLeft`, `appendRight`, `prependRight`, `move`, `reset`, and `remove`.
Example usage:
```ts
const s = new MagicString('hello world', { offset: 0 });
s.offset = 6;
s.slice() === 'world';
```
## Methods

@@ -93,7 +111,7 @@

Appends the specified `content` at the `index` in the original string. If a range *ending* with `index` is subsequently moved, the insert will be moved with it. Returns `this`. See also `s.prependLeft(...)`.
Appends the specified `content` at the `index` in the original string. If a range _ending_ with `index` is subsequently moved, the insert will be moved with it. Returns `this`. See also `s.prependLeft(...)`.
### s.appendRight( index, content )
Appends the specified `content` at the `index` in the original string. If a range *starting* with `index` is subsequently moved, the insert will be moved with it. Returns `this`. See also `s.prependRight(...)`.
Appends the specified `content` at the `index` in the original string. If a range _starting_ with `index` is subsequently moved, the insert will be moved with it. Returns `this`. See also `s.prependRight(...)`.

@@ -112,11 +130,11 @@ ### s.clone()

* `file` - the filename where you plan to write the sourcemap
* `source` - the filename of the file containing the original source
* `includeContent` - whether to include the original content in the map's `sourcesContent` array
* `hires` - whether the mapping should be high-resolution. Hi-res mappings map every single character, meaning (for example) your devtools will always be able to pinpoint the exact location of function calls and so on. With lo-res mappings, devtools may only be able to identify the correct line - but they're quicker to generate and less bulky. You can also set `"boundary"` to generate a semi-hi-res mappings segmented per word boundary instead of per character, suitable for string semantics that are separated by words. If sourcemap locations have been specified with `s.addSourcemapLocation()`, they will be used here.
- `file` - the filename where you plan to write the sourcemap
- `source` - the filename of the file containing the original source
- `includeContent` - whether to include the original content in the map's `sourcesContent` array
- `hires` - whether the mapping should be high-resolution. Hi-res mappings map every single character, meaning (for example) your devtools will always be able to pinpoint the exact location of function calls and so on. With lo-res mappings, devtools may only be able to identify the correct line - but they're quicker to generate and less bulky. You can also set `"boundary"` to generate a semi-hi-res mappings segmented per word boundary instead of per character, suitable for string semantics that are separated by words. If sourcemap locations have been specified with `s.addSourcemapLocation()`, they will be used here.
The returned sourcemap has two (non-enumerable) methods attached for convenience:
* `toString` - returns the equivalent of `JSON.stringify(map)`
* `toUrl` - returns a DataURI containing the sourcemap. Useful for doing this sort of thing:
- `toString` - returns the equivalent of `JSON.stringify(map)`
- `toUrl` - returns a DataURI containing the sourcemap. Useful for doing this sort of thing:

@@ -175,7 +193,7 @@ ```js

Same as `s.appendLeft(...)`, except that the inserted content will go *before* any previous appends or prepends at `index`
Same as `s.appendLeft(...)`, except that the inserted content will go _before_ any previous appends or prepends at `index`
### s.prependRight ( index, content )
Same as `s.appendRight(...)`, except that the inserted content will go *before* any previous appends or prepends at `index`
Same as `s.appendRight(...)`, except that the inserted content will go _before_ any previous appends or prepends at `index`

@@ -187,12 +205,13 @@ ### s.replace( regexpOrString, substitution )

```ts
import MagicString from 'magic-string'
import MagicString from 'magic-string';
const s = new MagicString(source)
const s = new MagicString(source);
s.replace('foo', 'bar')
s.replace(/foo/g, 'bar')
s.replace(/(\w)(\d+)/g, (_, $1, $2) => $1.toUpperCase() + $2)
s.replace('foo', 'bar');
s.replace(/foo/g, 'bar');
s.replace(/(\w)(\d+)/g, (_, $1, $2) => $1.toUpperCase() + $2);
```
The differences from [`String.replace`]((https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/replace)):
The differences from [`String.replace`](<(https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/replace)>):
- It will always match against the **original string**

@@ -259,9 +278,9 @@ - It mutates the magic string state (use `.clone()` to be immutable)

bundle.addSource({
filename: 'foo.js',
content: new MagicString('var answer = 42;')
filename: 'foo.js',
content: new MagicString('var answer = 42;'),
});
bundle.addSource({
filename: 'bar.js',
content: new MagicString('console.log( answer )')
filename: 'bar.js',
content: new MagicString('console.log( answer )'),
});

@@ -273,6 +292,6 @@

bundle.addSource({
filename: 'some-3rdparty-library.js',
content: new MagicString('function myLib(){}'),
ignoreList: false // <--
})
filename: 'some-3rdparty-library.js',
content: new MagicString('function myLib(){}'),
ignoreList: false, // <--
});

@@ -283,5 +302,6 @@ // Advanced: a source can include an `indentExclusionRanges` property

bundle.indent() // optionally, pass an indent string, otherwise it will be guessed
.prepend('(function () {\n')
.append('}());');
bundle
.indent() // optionally, pass an indent string, otherwise it will be guessed
.prepend('(function () {\n')
.append('}());');

@@ -296,5 +316,5 @@ bundle.toString();

const map = bundle.generateMap({
file: 'bundle.js',
includeContent: true,
hires: true
file: 'bundle.js',
includeContent: true,
hires: true,
});

@@ -308,3 +328,3 @@ ```

const source = new MagicString(someCode, {
filename: 'foo.js'
filename: 'foo.js',
});

@@ -311,0 +331,0 @@

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc