espolar 0.3.1 → 0.5.0

package/dist/index.d.ts

@@ -85,16 +85,29 @@ interface MappingDataOptions<Data> {
 }
 type MappingDataUndefinedOptions = { [K in keyof MappingDataOptions<0>]?: undefined };
 type PrintOptions<Data> = PrintOptionsBase<Data> & ([Data] extends [undefined] ? MappingDataUndefinedOptions : MappingDataOptions<Data>);
+interface WriteNodeOptions {
+  noLeadingComment?: boolean;
+  noTrailingComment?: boolean;
+}
 interface PrinterContext<Data = any> {
   readonly options: PrintOptions<Data>;
   readonly source: string;
   readonly generatedOffset: number;
   write(text: string): void;
   writeMapped(text: string, sourceStart: number, sourceEnd: number, data?: Data): void;
-  writeNode(node: AST.Node | null | undefined): void;
+  writeNode(node: AST.Node | null | undefined, options?: WriteNodeOptions): void;
   writeNodeList(nodes: readonly (AST.Node | null)[], separator: string): void;
   writeExpressionListWithCommaSep(nodes: readonly (AST.Expression | AST.SpreadElement | null)[]): void;
-  writeNodeListWithNewLineSep(nodes: readonly (AST.ProgramStatement | AST.ClassElement)[]): void;
+  /**
+   * Write `nodes` with "newline" separator, but if for node either:
+   * - it is the first or the last node, ranged, and `listRange` is also provided,
+   * - two adjacent nodes are both ranged,
+   * Then the source text ranging between the two adjacent nodes/boundaries will be preserved
+   * instead of printing a newline character.
+   * @param nodes
+   * @param lastRangeEnd
+   */
+  writeNodeListWithNewLineSep(nodes: readonly (AST.ProgramStatement | AST.ClassElement)[], listRange?: SourceRange): void;
   writeSource(start: number, end: number, data?: Data): void;
   writePreservedNode(node: AST.Node): void;
   appendMapping(sourceRange: SourceRange, generatedStart: number, generatedEnd: number, data?: Data): void;

package/dist/index.js

@@ -1,4 +1,8 @@
 //#region src/printers.ts
+/**
+* Precedence table for expressions.
+* @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Operator_Precedence#table
+*/
 const EXPRESSIONS_PRECEDENCE = {
 	ArrayPattern: 20,
 	ObjectPattern: 20,
@@ -274,7 +278,12 @@ const defaultPrinters = {
 	TSIntrinsicKeyword: printKeywordType
 };
 function printProgram(program, context) {
-	context.writeNodeListWithNewLineSep(program.body);
+	let listRange;
+	if (program.range) listRange = {
+		start: program.range[0],
+		end: program.range[1]
+	};
+	context.writeNodeListWithNewLineSep(program.body, listRange);
 }
 function canStartExpressionStatement(node) {
 	let lhs;
@@ -335,8 +344,11 @@ function printVariableDeclaration(declaration, context) {
 	context.write(";");
 }
 function printVariableDeclarator(declarator, context) {
-	context.writeNode(declarator.id);
-	if (declarator.definite === true) context.write("!");
+	if (declarator.definite === true) {
+		context.write(String(declarator.id.name));
+		context.write("!");
+		writeOptionalTypeAnnotation(declarator.id, context);
+	} else context.writeNode(declarator.id);
 	if (declarator.init) {
 		context.write(" = ");
 		if (expectAssignmentExprNeedsParen(declarator.init)) {
@@ -350,9 +362,12 @@ function printBlockStatement(block, context) {
 	const body = block.body;
 	context.write("{");
 	if (body.length > 0) {
-		context.write("\n");
-		context.writeNodeListWithNewLineSep(body);
-		context.write("\n");
+		let listRange;
+		if (block.range) listRange = {
+			start: block.range[0] + 1,
+			end: block.range[1] - 1
+		};
+		context.writeNodeListWithNewLineSep(body, listRange);
 	}
 	context.write("}");
 }
@@ -870,9 +885,12 @@ function printClassBody(node, context) {
 	context.write("{");
 	const body = node.body;
 	if (body.length > 0) {
-		context.write("\n");
-		context.writeNodeListWithNewLineSep(body);
-		context.write("\n");
+		let listRange;
+		if (node.range) listRange = {
+			start: node.range[0] + 1,
+			end: node.range[1] - 1
+		};
+		context.writeNodeListWithNewLineSep(body, listRange);
 	}
 	context.write("}");
 }
@@ -880,9 +898,12 @@ function printStaticBlock(node, context) {
 	context.write("static {");
 	const body = node.body;
 	if (body.length > 0) {
-		context.write("\n");
-		context.writeNodeListWithNewLineSep(body);
-		context.write("\n");
+		let listRange;
+		if (node.range) listRange = {
+			start: node.range[0] + 1,
+			end: node.range[1] - 1
+		};
+		context.writeNodeListWithNewLineSep(body, listRange);
 	}
 	context.write("}");
 }
@@ -1425,9 +1446,14 @@ function printTSModuleDeclaration(node, context) {
 	}
 }
 function printTSModuleBlock(node, context) {
-	context.write("{\n");
-	context.writeNodeListWithNewLineSep(node.body);
-	context.write("\n}");
+	context.write("{");
+	let listRange;
+	if (node.range) listRange = {
+		start: node.range[0] + 1,
+		end: node.range[1] - 1
+	};
+	context.writeNodeListWithNewLineSep(node.body, listRange);
+	context.write("}");
 }
 function printTSDeclareFunction(node, context) {
 	context.write("declare ");
@@ -1571,6 +1597,7 @@ function createPrinterContext(options) {
 	};
 	const context = {
 		options,
+		_skipLeadingComment: false,
 		source: options.source,
 		get generatedOffset() {
 			return generatedOffset;
@@ -1589,7 +1616,7 @@ function createPrinterContext(options) {
 				end: sourceEnd
 			}, generatedStart, generatedOffset, data ?? getMappingData(null));
 		},
-		writeNode(node) {
+		writeNode(node, writeOpt = {}) {
 			if (!node) return;
 			const range = getNodeRange(node);
 			const untouchedRet = isUntouched(node);
@@ -1601,13 +1628,17 @@ function createPrinterContext(options) {
 			}
 			const printer = printers[node.type];
 			if (!printer) throw new Error(`No printer registered for node type ${node.type}`);
-			const leadingComments = options.getLeadingComments?.(node);
-			if (leadingComments) for (const comment of leadingComments) writeComment(comment, context);
+			if (!writeOpt.noLeadingComment) {
+				const leadingComments = options.getLeadingComments?.(node);
+				if (leadingComments && !context._skipLeadingComment) for (const comment of leadingComments) writeComment(comment, context);
+			}
 			const generatedStart = generatedOffset;
 			printer(node, context);
 			const generatedEnd = generatedOffset;
-			const trailingComments = options.getTrailingComments?.(node);
-			if (trailingComments) for (const comment of trailingComments) writeComment(comment, context);
+			if (!writeOpt.noTrailingComment) {
+				const trailingComments = options.getTrailingComments?.(node);
+				if (trailingComments) for (const comment of trailingComments) writeComment(comment, context);
+			}
 			const lastMappingGeneratedEnd = mappings.at(-1)?.generatedEnd ?? 0;
 			if (range && lastMappingGeneratedEnd <= generatedStart) appendMapping(range, generatedStart, generatedEnd, getMappingData(node));
 		},
@@ -1639,19 +1670,30 @@ function createPrinterContext(options) {
 				needsSeparator = true;
 			}
 		},
-		writeNodeListWithNewLineSep(nodes) {
+		writeNodeListWithNewLineSep(nodes, parentRange) {
 			let lastRangeEnd;
-			let wroteNode = false;
-			for (const node of nodes) {
-				if (!node) continue;
+			let trailingSepEnd;
+			if (parentRange) {
+				lastRangeEnd = parentRange.start;
+				trailingSepEnd = parentRange.end;
+			}
+			for (let i = 0; i < nodes.length; i++) {
+				const node = nodes[i];
 				const range = getNodeRange(node);
-				if (wroteNode) if (lastRangeEnd !== void 0 && range && range.start >= lastRangeEnd) context.writeSource(lastRangeEnd, range.start, getMappingData(null));
-				else context.write("\n");
-				context.writeNode(node);
-				wroteNode = true;
+				let noLeadingComment = false;
+				let noTrailingComment = i < nodes.length - 1 ? true : range !== void 0 && parentRange !== void 0;
+				if (lastRangeEnd !== void 0 && range && range.start >= lastRangeEnd) {
+					context.writeSource(lastRangeEnd, range.start, getMappingData(null));
+					noLeadingComment = true;
+				} else if (i > 0) context.write("\n");
+				context.writeNode(node, {
+					noLeadingComment,
+					noTrailingComment
+				});
 				if (range) lastRangeEnd = range.end;
 				else lastRangeEnd = void 0;
 			}
+			if (trailingSepEnd !== void 0 && lastRangeEnd !== void 0) context.writeSource(lastRangeEnd, trailingSepEnd, getMappingData(null));
 		},
 		writeSource(start, end, data) {
 			if (end < start) return;

package/package.json

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

package/src/api.ts

@@ -41,6 +41,11 @@ export type PrintOptions<Data> = PrintOptionsBase<Data> &
     ? MappingDataUndefinedOptions
     : MappingDataOptions<Data>);
 
+export interface WriteNodeOptions {
+  noLeadingComment?: boolean;
+  noTrailingComment?: boolean;
+}
+
 export interface PrinterContext<Data = any> {
   readonly options: PrintOptions<Data>;
   readonly source: string;
@@ -52,13 +57,23 @@ export interface PrinterContext<Data = any> {
     sourceEnd: number,
     data?: Data,
   ): void;
-  writeNode(node: AST.Node | null | undefined): void;
+  writeNode(node: AST.Node | null | undefined, options?: WriteNodeOptions): void;
   writeNodeList(nodes: readonly (AST.Node | null)[], separator: string): void;
   writeExpressionListWithCommaSep(
     nodes: readonly (AST.Expression | AST.SpreadElement | null)[],
   ): void;
+  /**
+   * Write `nodes` with "newline" separator, but if for node either:
+   * - it is the first or the last node, ranged, and `listRange` is also provided,
+   * - two adjacent nodes are both ranged,
+   * Then the source text ranging between the two adjacent nodes/boundaries will be preserved 
+   * instead of printing a newline character.
+   * @param nodes 
+   * @param lastRangeEnd 
+   */
   writeNodeListWithNewLineSep(
     nodes: readonly (AST.ProgramStatement | AST.ClassElement)[],
+    listRange?: SourceRange,
   ): void;
   writeSource(start: number, end: number, data?: Data): void;
   writePreservedNode(node: AST.Node): void;

package/src/printer.ts

@@ -22,6 +22,7 @@ import {
 interface InternalPrinterContext extends PrinterContext<any> {
   // make typescript happy about complex types
   options: any;
+  _skipLeadingComment: boolean;
   result(): PrintResult<any>;
 }
 
@@ -97,6 +98,7 @@ function createPrinterContext<Data>(
 
   const context: InternalPrinterContext = {
     options: options,
+    _skipLeadingComment: false,
     source: options.source,
     get generatedOffset() {
       return generatedOffset;
@@ -121,7 +123,7 @@ function createPrinterContext<Data>(
         data ?? getMappingData(null),
       );
     },
-    writeNode(node) {
+    writeNode(node, writeOpt = {}) {
       if (!node) {
         return;
       }
@@ -150,10 +152,12 @@ function createPrinterContext<Data>(
         throw new Error(`No printer registered for node type ${node.type}`);
       }
 
-      const leadingComments = options.getLeadingComments?.(node);
-      if (leadingComments) {
-        for (const comment of leadingComments) {
-          writeComment(comment, context);
+      if (!writeOpt.noLeadingComment) {
+        const leadingComments = options.getLeadingComments?.(node);
+        if (leadingComments && !context._skipLeadingComment) {
+          for (const comment of leadingComments) {
+            writeComment(comment, context);
+          }
         }
       }
 
@@ -161,12 +165,15 @@ function createPrinterContext<Data>(
       printer(node, context);
       const generatedEnd = generatedOffset;
 
-      const trailingComments = options.getTrailingComments?.(node);
-      if (trailingComments) {
-        for (const comment of trailingComments) {
-          writeComment(comment, context);
+      if (!writeOpt.noTrailingComment) {
+        const trailingComments = options.getTrailingComments?.(node);
+        if (trailingComments) {
+          for (const comment of trailingComments) {
+            writeComment(comment, context);
+          }
         }
       }
+
       // If children nodes don't emit any mapping but the parent node itself
       // can produce mapping, add that mapping
       const lastMappingGeneratedEnd = mappings.at(-1)?.generatedEnd ?? 0;
@@ -220,41 +227,44 @@ function createPrinterContext<Data>(
         needsSeparator = true;
       }
     },
-    writeNodeListWithNewLineSep(nodes) {
+    writeNodeListWithNewLineSep(nodes, parentRange) {
       let lastRangeEnd: number | undefined;
-      let wroteNode = false;
-
-      for (const node of nodes) {
-        if (!node) {
-          continue;
-        }
-
+      let trailingSepEnd: number | undefined;
+      if (parentRange) {
+        lastRangeEnd = parentRange.start;
+        trailingSepEnd = parentRange.end;
+      }
+      for (let i = 0; i < nodes.length; i++) {
+        const node = nodes[i];
         const range = getNodeRange(node);
-        if (wroteNode) {
-          if (
-            lastRangeEnd !== undefined &&
-            range &&
-            range.start >= lastRangeEnd
-          ) {
-            context.writeSource(
-              lastRangeEnd,
-              range.start,
-              getMappingData(null),
-            );
-          } else {
-            context.write("\n");
-          }
+        let noLeadingComment = false;
+        let noTrailingComment =
+          i < nodes.length - 1
+            ? true
+            : range !== undefined && parentRange !== undefined;
+        if (
+          lastRangeEnd !== undefined &&
+          range &&
+          range.start >= lastRangeEnd
+        ) {
+          context.writeSource(lastRangeEnd, range.start, getMappingData(null));
+          noLeadingComment = true;
+        } else if (i > 0) {
+          context.write("\n");
         }
-
-        context.writeNode(node);
-        wroteNode = true;
-
+        context.writeNode(node, {
+          noLeadingComment,
+          noTrailingComment,
+        });
         if (range) {
           lastRangeEnd = range.end;
         } else {
           lastRangeEnd = undefined;
         }
       }
+      if (trailingSepEnd !== undefined && lastRangeEnd !== undefined) {
+        context.writeSource(lastRangeEnd, trailingSepEnd, getMappingData(null));
+      }
     },
     writeSource(start, end, data) {
       if (end < start) {

package/src/printers.ts

@@ -1,6 +1,11 @@
 import type { PrinterContext, Printers } from "./api.ts";
+import type { SourceRange } from "./mappings.ts";
 import type { AST, AST_NODE_TYPES, Comment } from "./types.ts";
 
+/**
+ * Precedence table for expressions.
+ * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Operator_Precedence#table
+ */
 const EXPRESSIONS_PRECEDENCE = {
   // LHS of =, must NOT parenthesized
   ArrayPattern: 20,
@@ -48,7 +53,9 @@ const EXPRESSIONS_PRECEDENCE = {
 
   // ranges from 13-5 depending on operator
   BinaryExpression: 13,
-  // as/satisfies have same precedence as relational operators
+  // as/satisfies have same precedence as relational operators, e.g.
+  // `1 < 2 as number` is `(1 < 2) as number`, but
+  // `1 === 2 as number` is `1 === (2 as number)`
   TSAsExpression: 9,
   TSSatisfiesExpression: 9,
   // ranges from 4-3 depending on operator
@@ -426,7 +433,14 @@ export const defaultPrinters = {
 // JS – Statements
 
 function printProgram(program: AST.Program, context: PrinterContext): void {
-  context.writeNodeListWithNewLineSep(program.body);
+  let listRange: SourceRange | undefined;
+  if (program.range) {
+    listRange = {
+      start: program.range[0],
+      end: program.range[1],
+    };
+  }
+  context.writeNodeListWithNewLineSep(program.body, listRange);
 }
 
 function canStartExpressionStatement(
@@ -518,9 +532,18 @@ function printVariableDeclarator(
   declarator: AST.VariableDeclarator,
   context: PrinterContext,
 ): void {
-  context.writeNode(declarator.id);
   if (declarator.definite === true) {
+    context.write(String((declarator.id as AST.Identifier).name));
     context.write("!");
+    writeOptionalTypeAnnotation(
+      declarator.id as unknown as {
+        optional?: boolean;
+        typeAnnotation?: AST.Node | null;
+      },
+      context,
+    );
+  } else {
+    context.writeNode(declarator.id);
   }
   if (declarator.init) {
     context.write(" = ");
@@ -542,9 +565,14 @@ function printBlockStatement(
   const body = block.body;
   context.write("{");
   if (body.length > 0) {
-    context.write("\n");
-    context.writeNodeListWithNewLineSep(body);
-    context.write("\n");
+    let listRange: SourceRange | undefined;
+    if (block.range) {
+      listRange = {
+        start: block.range[0] + 1,
+        end: block.range[1] - 1,
+      };
+    }
+    context.writeNodeListWithNewLineSep(body, listRange);
   }
   context.write("}");
 }
@@ -1457,9 +1485,14 @@ function printClassBody(node: AST.ClassBody, context: PrinterContext): void {
   context.write("{");
   const body = node.body;
   if (body.length > 0) {
-    context.write("\n");
-    context.writeNodeListWithNewLineSep(body);
-    context.write("\n");
+    let listRange: SourceRange | undefined;
+    if (node.range) {
+      listRange = {
+        start: node.range[0] + 1,
+        end: node.range[1] - 1,
+      };
+    }
+    context.writeNodeListWithNewLineSep(body, listRange);
   }
   context.write("}");
 }
@@ -1471,9 +1504,14 @@ function printStaticBlock(
   context.write("static {");
   const body = node.body;
   if (body.length > 0) {
-    context.write("\n");
-    context.writeNodeListWithNewLineSep(body);
-    context.write("\n");
+    let listRange: SourceRange | undefined;
+    if (node.range) {
+      listRange = {
+        start: node.range[0] + 1,
+        end: node.range[1] - 1,
+      };
+    }
+    context.writeNodeListWithNewLineSep(body, listRange);
   }
   context.write("}");
 }
@@ -2512,9 +2550,16 @@ function printTSModuleBlock(
   node: AST.TSModuleBlock,
   context: PrinterContext,
 ): void {
-  context.write("{\n");
-  context.writeNodeListWithNewLineSep(node.body);
-  context.write("\n}");
+  context.write("{");
+  let listRange: SourceRange | undefined;
+  if (node.range) {
+    listRange = {
+      start: node.range[0] + 1,
+      end: node.range[1] - 1,
+    };
+  }
+  context.writeNodeListWithNewLineSep(node.body, listRange);
+  context.write("}");
 }
 
 function printTSDeclareFunction(