espolar 0.1.5 → 0.2.0

package/README.md

@@ -75,8 +75,8 @@ Main entry point. Returns `PrintResult<Data>`.
 | --------------------- | ---------------------------------- | ------------------------------------------------------------------------------------------ |
 | `source`              | `string`                           | The original source code (required)                                                        |
 | `isUntouched`         | `(node) => boolean \| SourceRange` | Determine if a node should be preserved from source. Default: checks `range`/`start`/`end` |
-| `getMappingData`      | `(node?) => Data`                  | Extract data for each mapping entry. Default: `() => ({})`                                 |
-| `combineMappingData`  | `(left, right) => Data`            | Merge data when adjacent mappings are combined. Default: returns `right`                   |
+| `getMappingData`      | `(node?) => Data`                  | Extract data for each mapping entry. Default: `() => undefined`                            |
+| `combineMappingData`  | `(left, right) => Data`            | Merge data when adjacent mappings are combined. Default: throws if `left !== right`        |
 | `printers`            | `Printers<Data>`                   | Override printers for specific `AST_NODE_TYPES`                                            |
 | `getLeadingComments`  | `(node) => Comment[] \| undefined` | Return comments to print before a touched node                                             |
 | `getTrailingComments` | `(node) => Comment[] \| undefined` | Return comments to print after a touched node                                              |

package/dist/index.d.ts

@@ -62,10 +62,9 @@ interface PrintResult<Data> {
   code: string;
   mappings: Mapping<Data>[];
 }
-interface PrintOptions<Data> {
+interface PrintOptionsBase<Data> {
   source: string;
   isUntouched?: (node: AST.Node) => boolean | SourceRange;
-  getMappingData?: (node?: AST.Node | null) => Data;
   combineMappingData?: (left: Data, right: Data) => Data;
   printers?: Printers<Data>;
   getLeadingComments?: (node: AST.Node) => Comment[] | undefined;
@@ -81,6 +80,11 @@ interface PrintOptions<Data> {
    */
   experimentalGetLeftParenSourceRange?: (node: AST.CallExpression | AST.NewExpression) => SourceRange | undefined;
 }
+interface MappingDataOptions<Data> {
+  getMappingData: (node?: AST.Node | null) => Data;
+}
+type MappingDataUndefinedOptions = { [K in keyof MappingDataOptions<0>]?: undefined };
+type PrintOptions<Data> = PrintOptionsBase<Data> & ([Data] extends [undefined] ? MappingDataUndefinedOptions : MappingDataOptions<Data>);
 interface PrinterContext<Data = any> {
   readonly options: PrintOptions<Data>;
   readonly source: string;
@@ -93,6 +97,8 @@ interface PrinterContext<Data = any> {
   writeSource(start: number, end: number, data?: Data): void;
   writePreservedNode(node: AST.Node): void;
   appendMapping(sourceRange: SourceRange, generatedStart: number, generatedEnd: number, data?: Data): void;
+  /** Extra mappings that won't be merged automatically */
+  createExtraMapping(sourceRange: SourceRange, generatedStart: number, generatedEnd: number, data?: Data): void;
 }
 type NodePrinter<Key extends AST_NODE_TYPES, Data> = (node: Extract<AST.Node, {
   type: Key;
@@ -100,12 +106,11 @@ type NodePrinter<Key extends AST_NODE_TYPES, Data> = (node: Extract<AST.Node, {
 type Printers<Data> = { [K in AST_NODE_TYPES]?: NodePrinter<K, Data> };
 //#endregion
 //#region src/printer.d.ts
-declare function print<Data>(node: AST.Node, options: PrintOptions<Data>): PrintResult<Data>;
-declare function print<Data>(node: import("estree").Node, options: PrintOptions<Data>): PrintResult<Data>;
-declare function print<Data>(node: NodeLike, options: PrintOptions<Data>): PrintResult<Data>;
+declare function print<Data = undefined>(node: AST.Node, options: PrintOptions<Data>): PrintResult<Data>;
+declare function print<Data = undefined>(node: import("estree").Node, options: PrintOptions<Data>): PrintResult<Data>;
+declare function print<Data = undefined>(node: NodeLike, options: PrintOptions<Data>): PrintResult<Data>;
 declare function defaultIsUntouched(node: AST.Node): boolean | SourceRange;
-declare function defaultGetMappingData(node?: AST.Node | null): unknown;
-declare function defaultCombineMappingData(left: unknown, right: unknown): unknown;
+declare function defaultCombineMappingData<T>(left: T, right: T): T;
 //#endregion
 //#region src/printers.d.ts
 declare const defaultPrinters: {
@@ -385,4 +390,4 @@ declare function printKeywordType(node: Extract<AST.Node, {
   type: `${string}Keyword`;
 }>, context: PrinterContext): void;
 //#endregion
-export { type AST, type Comment, type NodeLike, type NodePrinter, type PrintOptions, type PrintResult, type PrinterContext, type SourceRange, defaultCombineMappingData, defaultGetMappingData, defaultIsUntouched, defaultPrinters, print };
+export { type AST, type Comment, type NodeLike, type NodePrinter, type PrintOptions, type PrintResult, type PrinterContext, type SourceRange, defaultCombineMappingData, defaultIsUntouched, defaultPrinters, print };

package/dist/index.js

@@ -1346,8 +1346,14 @@ function pushMapping(mappings, mapping, combineMappingData) {
 	}
 	mappings.push(mapping);
 }
+/**
+* Two adjacent mappings with identical lengths can be merged into one mapping.
+* @param left 
+* @param right 
+* @returns 
+*/
 function canMerge(left, right) {
-	return left.sourceStart + left.sourceEnd === right.sourceStart && left.generatedStart + left.generatedEnd === right.generatedStart;
+	return left.sourceEnd - left.sourceStart === left.generatedEnd - left.generatedStart && right.sourceEnd - right.sourceStart === right.generatedEnd - right.generatedStart && left.sourceEnd === right.sourceStart && left.generatedEnd === right.generatedStart;
 }
 function toVolarMapping(mapping) {
 	const sourceLength = mapping.sourceEnd - mapping.sourceStart;
@@ -1377,19 +1383,18 @@ function print(node, options) {
 function defaultIsUntouched(node) {
 	return getNodeRange(node) || false;
 }
-function defaultGetMappingData(node) {
-	return {};
-}
 function defaultCombineMappingData(left, right) {
-	return right;
+	if (left === right) return left;
+	throw new Error("Cannot combine mapping data with different values when no custom combineMappingData function is provided");
 }
 function createPrinterContext(options) {
 	const chunks = [];
 	const mappings = [];
+	const extraMappings = [];
 	let generatedOffset = 0;
 	const isUntouched = options.isUntouched ?? defaultIsUntouched;
-	const getMappingData = options.getMappingData ?? defaultGetMappingData;
-	const combineMappingData = options.combineMappingData ?? (options.getMappingData ? (left) => left : defaultCombineMappingData);
+	const getMappingData = options.getMappingData ?? (() => void 0);
+	const combineMappingData = options.combineMappingData ?? defaultCombineMappingData;
 	const printers = {
 		...defaultPrinters,
 		...options.printers
@@ -1486,14 +1491,23 @@ function createPrinterContext(options) {
 			context.writeSource(range.start, range.end, getMappingData(node));
 		},
 		appendMapping,
+		createExtraMapping(sourceRange, generatedStart, generatedEnd, data) {
+			extraMappings.push({
+				sourceStart: sourceRange.start,
+				sourceEnd: sourceRange.end,
+				generatedStart,
+				generatedEnd,
+				data
+			});
+		},
 		result() {
 			return {
 				code: chunks.join(""),
-				mappings: mappings.map(toVolarMapping)
+				mappings: [...mappings, ...extraMappings].map(toVolarMapping)
 			};
 		}
 	};
 	return context;
 }
 //#endregion
-export { defaultCombineMappingData, defaultGetMappingData, defaultIsUntouched, defaultPrinters, print };
+export { defaultCombineMappingData, defaultIsUntouched, defaultPrinters, print };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "espolar",
-  "version": "0.1.5",
+  "version": "0.2.0",
   "type": "module",
   "types": "./dist/index.d.ts",
   "exports": {