espolar 0.3.0 → 0.4.0

package/dist/index.d.ts

@@ -94,7 +94,15 @@ interface PrinterContext<Data = any> {
   writeNode(node: AST.Node | null | undefined): 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 the node is ranged and either:
+   * - it is the first node with `lastRangeEnd` provided, or
+   * - the previous adjacent node is ranged too,
+   * Then the source text ranging between the two adjacent nodes will be preserved instead of printing a newline character.
+   * @param nodes
+   * @param lastRangeEnd
+   */
+  writeNodeListWithNewLineSep(nodes: readonly (AST.ProgramStatement | AST.ClassElement)[], lastRangeEnd?: number): 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,
@@ -109,13 +113,13 @@ function operandOfBinaryExprNeedsParens(node, parent, where) {
 * which not contains a CallExpression
 */
 function validUnparenthesizedNewOperand(node) {
+	if (node.type === "ChainExpression" || node.type === "ImportExpression") return false;
 	let cur = node;
 	while (true) if (cur.type === "CallExpression") return false;
 	else if (cur.type === "TSNonNullExpression") cur = cur.expression;
 	else if (cur.type === "MemberExpression") cur = cur.object;
 	else if (cur.type === "TaggedTemplateExpression") cur = cur.tag;
-	else if (cur.type === "MetaProperty" || cur.type === "NewExpression" || cur.type === "ImportExpression") return true;
-	else return cur !== node;
+	else return true;
 }
 function operandOfUnaryExprNeedsParens(node) {
 	return EXPRESSIONS_PRECEDENCE[node.type] < EXPRESSIONS_PRECEDENCE.UnaryExpression;
@@ -130,19 +134,6 @@ function commentNeedsNewline(comment) {
 	if (comment.type === "Line") return true;
 	return comment.value.includes("\n");
 }
-function arrowConciseBodyNeedsWrap(body) {
-	if (body.type === "BlockStatement") return false;
-	switch (body.type) {
-		case "ObjectExpression": return true;
-		case "AssignmentExpression": return body.left.type === "ObjectPattern";
-		case "LogicalExpression": return body.left.type === "ObjectExpression";
-		case "ConditionalExpression": return body.test.type === "ObjectExpression";
-		case "TSAsExpression":
-		case "TSSatisfiesExpression":
-		case "TSNonNullExpression": return body.expression ? arrowConciseBodyNeedsWrap(body.expression) : false;
-		default: return false;
-	}
-}
 const defaultPrinters = {
 	Program: printProgram,
 	Identifier: printIdentifier,
@@ -287,7 +278,7 @@ const defaultPrinters = {
 	TSIntrinsicKeyword: printKeywordType
 };
 function printProgram(program, context) {
-	context.writeNodeListWithNewLineSep(program.body);
+	context.writeNodeListWithNewLineSep(program.body, program.range?.[0]);
 }
 function canStartExpressionStatement(node) {
 	let lhs;
@@ -312,6 +303,7 @@ function canStartExpressionStatement(node) {
 			break;
 		case "MemberExpression":
 			lhs = node.object;
+			if (node.computed && lhs.type === "Identifier" && lhs.name === "let") return false;
 			break;
 		case "TaggedTemplateExpression":
 			lhs = node.tag;
@@ -347,8 +339,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)) {
@@ -362,8 +357,10 @@ function printBlockStatement(block, context) {
 	const body = block.body;
 	context.write("{");
 	if (body.length > 0) {
-		context.write("\n");
-		context.writeNodeListWithNewLineSep(body);
+		let lastRangeEnd;
+		if (block.range) lastRangeEnd = block.range[0] + 1;
+		else context.write("\n");
+		context.writeNodeListWithNewLineSep(body, lastRangeEnd);
 		context.write("\n");
 	}
 	context.write("}");
@@ -686,7 +683,7 @@ function printProperty(property, context) {
 			context.writeNode(value);
 			return;
 		}
-		if (value.type === "FunctionExpression") {
+		if (value.type === "FunctionExpression" && (property.method || property.kind !== "init")) {
 			if (property.kind !== "init") context.write(property.kind + " ");
 			if (value.async === true) context.write("async ");
 			if (value.generator === true) context.write("*");
@@ -708,7 +705,6 @@ function printProperty(property, context) {
 			context.writeNode(property.key);
 			context.write("]: ");
 		} else {
-			if (property.kind === "get" || property.kind === "set") context.write(property.kind + " ");
 			context.writeNode(property.key);
 			context.write(": ");
 		}
@@ -794,6 +790,44 @@ function printFunction(fn, context) {
 		context.writeNode(fn.body);
 	}
 }
+function canStartConciseBody(body) {
+	if (body.type === "BlockStatement" || body.type === "PrivateIdentifier") return true;
+	if (expectAssignmentExprNeedsParen(body)) return false;
+	let lhs;
+	switch (body.type) {
+		default: return true;
+		case "ObjectExpression":
+		case "FunctionExpression":
+		case "ClassExpression":
+		case "ObjectPattern": return false;
+		case "AssignmentExpression":
+		case "LogicalExpression":
+		case "BinaryExpression":
+			lhs = body.left;
+			break;
+		case "TSAsExpression":
+		case "TSSatisfiesExpression":
+		case "TSNonNullExpression":
+			lhs = body.expression;
+			break;
+		case "CallExpression":
+			lhs = body.callee;
+			break;
+		case "MemberExpression":
+			lhs = body.object;
+			if (body.computed && lhs.type === "Identifier" && lhs.name === "let") return false;
+			break;
+		case "TaggedTemplateExpression":
+			lhs = body.tag;
+			break;
+		case "ConditionalExpression":
+			lhs = body.test;
+			break;
+		case "UpdateExpression": return canStartConciseBody(body.argument);
+		case "ChainExpression": return canStartConciseBody(body.expression);
+	}
+	return operandOfBinaryExprNeedsParens(lhs, body, "left") || canStartConciseBody(lhs);
+}
 function printArrowFunctionExpression(fn, context) {
 	if (fn.async === true) context.write("async ");
 	if (fn.typeParameters) context.writeNode(fn.typeParameters);
@@ -803,7 +837,7 @@ function printArrowFunctionExpression(fn, context) {
 	writeReturnType(fn, context);
 	context.write(" => ");
 	const body = fn.body;
-	if (arrowConciseBodyNeedsWrap(body)) {
+	if (!canStartConciseBody(body)) {
 		context.write("(");
 		context.writeNode(body);
 		context.write(")");
@@ -845,8 +879,10 @@ function printClassBody(node, context) {
 	context.write("{");
 	const body = node.body;
 	if (body.length > 0) {
-		context.write("\n");
-		context.writeNodeListWithNewLineSep(body);
+		let lastRangeEnd;
+		if (node.range) lastRangeEnd = node.range[0] + 1;
+		else context.write("\n");
+		context.writeNodeListWithNewLineSep(body, lastRangeEnd);
 		context.write("\n");
 	}
 	context.write("}");
@@ -855,8 +891,10 @@ function printStaticBlock(node, context) {
 	context.write("static {");
 	const body = node.body;
 	if (body.length > 0) {
-		context.write("\n");
-		context.writeNodeListWithNewLineSep(body);
+		let lastRangeEnd;
+		if (node.range) lastRangeEnd = node.range[0] + 1;
+		else context.write("\n");
+		context.writeNodeListWithNewLineSep(body, lastRangeEnd);
 		context.write("\n");
 	}
 	context.write("}");
@@ -1400,8 +1438,11 @@ function printTSModuleDeclaration(node, context) {
 	}
 }
 function printTSModuleBlock(node, context) {
-	context.write("{\n");
-	context.writeNodeListWithNewLineSep(node.body);
+	context.write("{");
+	let lastRangeEnd;
+	if (node.range) lastRangeEnd = node.range[0] + 1;
+	else context.write("\n");
+	context.writeNodeListWithNewLineSep(node.body, lastRangeEnd);
 	context.write("\n}");
 }
 function printTSDeclareFunction(node, context) {
@@ -1614,14 +1655,12 @@ function createPrinterContext(options) {
 				needsSeparator = true;
 			}
 		},
-		writeNodeListWithNewLineSep(nodes) {
-			let lastRangeEnd;
+		writeNodeListWithNewLineSep(nodes, lastRangeEnd) {
 			let wroteNode = false;
 			for (const node of nodes) {
-				if (!node) continue;
 				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");
+				if (lastRangeEnd !== void 0 && range && range.start >= lastRangeEnd) context.writeSource(lastRangeEnd, range.start, getMappingData(null));
+				else if (wroteNode) context.write("\n");
 				context.writeNode(node);
 				wroteNode = true;
 				if (range) lastRangeEnd = range.end;

package/package.json

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

package/src/api.ts

@@ -57,8 +57,17 @@ export interface PrinterContext<Data = any> {
   writeExpressionListWithCommaSep(
     nodes: readonly (AST.Expression | AST.SpreadElement | null)[],
   ): void;
+  /**
+   * Write `nodes` with "newline" separator, but if the node is ranged and either:
+   * - it is the first node with `lastRangeEnd` provided, or
+   * - the previous adjacent node is ranged too,
+   * Then the source text ranging between the two adjacent nodes will be preserved instead of printing a newline character.
+   * @param nodes 
+   * @param lastRangeEnd 
+   */
   writeNodeListWithNewLineSep(
     nodes: readonly (AST.ProgramStatement | AST.ClassElement)[],
+    lastRangeEnd?: number,
   ): void;
   writeSource(start: number, end: number, data?: Data): void;
   writePreservedNode(node: AST.Node): void;

package/src/printer.ts

@@ -220,35 +220,21 @@ function createPrinterContext<Data>(
         needsSeparator = true;
       }
     },
-    writeNodeListWithNewLineSep(nodes) {
-      let lastRangeEnd: number | undefined;
+    writeNodeListWithNewLineSep(nodes, lastRangeEnd) {
       let wroteNode = false;
-
       for (const node of nodes) {
-        if (!node) {
-          continue;
-        }
-
         const range = getNodeRange(node);
-        if (wroteNode) {
-          if (
-            lastRangeEnd !== undefined &&
-            range &&
-            range.start >= lastRangeEnd
-          ) {
-            context.writeSource(
-              lastRangeEnd,
-              range.start,
-              getMappingData(null),
-            );
-          } else {
-            context.write("\n");
-          }
+        if (
+          lastRangeEnd !== undefined &&
+          range &&
+          range.start >= lastRangeEnd
+        ) {
+          context.writeSource(lastRangeEnd, range.start, getMappingData(null));
+        } else if (wroteNode) {
+          context.write("\n");
         }
-
         context.writeNode(node);
         wroteNode = true;
-
         if (range) {
           lastRangeEnd = range.end;
         } else {

package/src/printers.ts

@@ -1,6 +1,10 @@
 import type { PrinterContext, Printers } from "./api.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 +52,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
@@ -225,6 +231,9 @@ function operandOfBinaryExprNeedsParens(
  * which not contains a CallExpression
  */
 function validUnparenthesizedNewOperand(node: MemberLikeExpression): boolean {
+  if (node.type === "ChainExpression" || node.type === "ImportExpression") {
+    return false;
+  }
   let cur: AST.Expression = node;
   while (true) {
     if (cur.type === "CallExpression") {
@@ -235,18 +244,8 @@ function validUnparenthesizedNewOperand(node: MemberLikeExpression): boolean {
       cur = cur.object;
     } else if (cur.type === "TaggedTemplateExpression") {
       cur = cur.tag;
-    } else if (
-      cur.type === "MetaProperty" ||
-      cur.type === "NewExpression" ||
-      cur.type === "ImportExpression"
-    ) {
-      return true;
     } else {
-      // The operand is either:
-      // - an expression with higher precedence, no need to check further
-      // - an expression with lower precedence, will be inner-parenthesized later
-      // - a ChainExpression, will be inner-parenthesized later
-      return cur !== node;
+      return true;
     }
   }
 }
@@ -279,30 +278,6 @@ function commentNeedsNewline(comment: Comment): boolean {
   return comment.value.includes("\n");
 }
 
-function arrowConciseBodyNeedsWrap(
-  body: AST.BlockStatement | AST.Expression,
-): boolean {
-  if (body.type === "BlockStatement") return false;
-  switch (body.type) {
-    case "ObjectExpression":
-      return true;
-    case "AssignmentExpression":
-      return body.left.type === "ObjectPattern";
-    case "LogicalExpression":
-      return body.left.type === "ObjectExpression";
-    case "ConditionalExpression":
-      return body.test.type === "ObjectExpression";
-    case "TSAsExpression":
-    case "TSSatisfiesExpression":
-    case "TSNonNullExpression":
-      return body.expression
-        ? arrowConciseBodyNeedsWrap(body.expression)
-        : false;
-    default:
-      return false;
-  }
-}
-
 // Printers
 export const defaultPrinters = {
   Program: printProgram,
@@ -457,7 +432,7 @@ export const defaultPrinters = {
 // JS – Statements
 
 function printProgram(program: AST.Program, context: PrinterContext): void {
-  context.writeNodeListWithNewLineSep(program.body);
+  context.writeNodeListWithNewLineSep(program.body, program.range?.[0]);
 }
 
 function canStartExpressionStatement(
@@ -487,6 +462,9 @@ function canStartExpressionStatement(
       break;
     case "MemberExpression":
       lhs = node.object;
+      if (node.computed && lhs.type === "Identifier" && lhs.name === "let") {
+        return false;
+      }
       break;
     case "TaggedTemplateExpression":
       lhs = node.tag;
@@ -546,9 +524,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(" = ");
@@ -570,8 +557,13 @@ function printBlockStatement(
   const body = block.body;
   context.write("{");
   if (body.length > 0) {
-    context.write("\n");
-    context.writeNodeListWithNewLineSep(body);
+    let lastRangeEnd: number | undefined;
+    if (block.range) {
+      lastRangeEnd = block.range[0] + 1;
+    } else {
+      context.write("\n");
+    }
+    context.writeNodeListWithNewLineSep(body, lastRangeEnd);
     context.write("\n");
   }
   context.write("}");
@@ -1161,7 +1153,10 @@ function printProperty(
     }
 
     // shorthand method
-    if (value.type === "FunctionExpression") {
+    if (
+      value.type === "FunctionExpression" &&
+      (property.method || property.kind !== "init")
+    ) {
       if (property.kind !== "init") {
         context.write(property.kind + " ");
       }
@@ -1192,9 +1187,6 @@ function printProperty(
       context.writeNode(property.key);
       context.write("]: ");
     } else {
-      if (property.kind === "get" || property.kind === "set") {
-        context.write(property.kind + " ");
-      }
       context.writeNode(property.key);
       context.write(": ");
     }
@@ -1342,6 +1334,60 @@ function printFunction(
   }
 }
 
+function canStartConciseBody(
+  body: AST.BlockStatement | AST.Expression | AST.PrivateIdentifier,
+): boolean {
+  if (body.type === "BlockStatement" || body.type === "PrivateIdentifier") {
+    return true;
+  }
+  if (expectAssignmentExprNeedsParen(body)) {
+    return false;
+  }
+  let lhs: AST.Expression | AST.PrivateIdentifier;
+  switch (body.type) {
+    default:
+      return true;
+    case "ObjectExpression":
+    case "FunctionExpression":
+    case "ClassExpression":
+    case "ObjectPattern":
+      return false;
+    case "AssignmentExpression":
+    case "LogicalExpression":
+    case "BinaryExpression":
+      lhs = body.left;
+      break;
+    case "TSAsExpression":
+    case "TSSatisfiesExpression":
+    case "TSNonNullExpression":
+      lhs = body.expression;
+      break;
+    case "CallExpression":
+      lhs = body.callee;
+      break;
+    case "MemberExpression":
+      lhs = body.object;
+      if (body.computed && lhs.type === "Identifier" && lhs.name === "let") {
+        return false;
+      }
+      break;
+    case "TaggedTemplateExpression":
+      lhs = body.tag;
+      break;
+    case "ConditionalExpression":
+      lhs = body.test;
+      break;
+    case "UpdateExpression":
+      return canStartConciseBody(body.argument);
+    case "ChainExpression":
+      return canStartConciseBody(body.expression);
+  }
+  return (
+    operandOfBinaryExprNeedsParens(lhs, body, "left") ||
+    canStartConciseBody(lhs)
+  );
+}
+
 function printArrowFunctionExpression(
   fn: AST.ArrowFunctionExpression,
   context: PrinterContext,
@@ -1358,7 +1404,7 @@ function printArrowFunctionExpression(
   writeReturnType(fn, context);
   context.write(" => ");
   const body = fn.body;
-  if (arrowConciseBodyNeedsWrap(body)) {
+  if (!canStartConciseBody(body)) {
     context.write("(");
     context.writeNode(body);
     context.write(")");
@@ -1431,8 +1477,13 @@ function printClassBody(node: AST.ClassBody, context: PrinterContext): void {
   context.write("{");
   const body = node.body;
   if (body.length > 0) {
-    context.write("\n");
-    context.writeNodeListWithNewLineSep(body);
+    let lastRangeEnd: number | undefined;
+    if (node.range) {
+      lastRangeEnd = node.range[0] + 1;
+    } else {
+      context.write("\n");
+    }
+    context.writeNodeListWithNewLineSep(body, lastRangeEnd);
     context.write("\n");
   }
   context.write("}");
@@ -1445,8 +1496,13 @@ function printStaticBlock(
   context.write("static {");
   const body = node.body;
   if (body.length > 0) {
-    context.write("\n");
-    context.writeNodeListWithNewLineSep(body);
+    let lastRangeEnd: number | undefined;
+    if (node.range) {
+      lastRangeEnd = node.range[0] + 1;
+    } else {
+      context.write("\n");
+    }
+    context.writeNodeListWithNewLineSep(body, lastRangeEnd);
     context.write("\n");
   }
   context.write("}");
@@ -2486,8 +2542,14 @@ function printTSModuleBlock(
   node: AST.TSModuleBlock,
   context: PrinterContext,
 ): void {
-  context.write("{\n");
-  context.writeNodeListWithNewLineSep(node.body);
+  context.write("{");
+  let lastRangeEnd: number | undefined;
+  if (node.range) {
+    lastRangeEnd = node.range[0] + 1;
+  } else {
+    context.write("\n");
+  }
+  context.writeNodeListWithNewLineSep(node.body, lastRangeEnd);
   context.write("\n}");
 }