esrap 2.1.3 → 2.2.0

package/README.md

@@ -55,7 +55,12 @@ const { code, map } = print(
     quotes: 'single',
 
     // an array of `{ type: 'Line' | 'Block', value: string, loc: { start, end } }` objects
-    comments: []
+    comments: [],
+
+    // a pair of functions for inserting additional comments before or after a given node.
+    // returns `Array<{ type: 'Line' | 'Block', value: string }>` or `undefined`
+    getLeadingComments: (node) => [{ type: 'Line', value: ' a comment before the node' }],
+    getTrailingComments: (node) => [{ type: 'Block', value: ' a comment after the node' }]
   })
 );
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "esrap",
-  "version": "2.1.3",
+  "version": "2.2.0",
   "description": "Parse in reverse",
   "repository": {
     "type": "git",

package/src/languages/ts/index.js

@@ -1,6 +1,6 @@
 /** @import { TSESTree } from '@typescript-eslint/types' */
 /** @import { Visitors } from '../../types.js' */
-/** @import { TSOptions, Comment } from '../types.js' */
+/** @import { TSOptions, BaseComment } from '../types.js' */
 import { Context } from 'esrap';
 
 /** @typedef {TSESTree.Node} Node */
@@ -74,7 +74,7 @@ const OPERATOR_PRECEDENCE = {
 };
 
 /**
- * @param {Comment} comment
+ * @param {BaseComment} comment
  * @param {Context} context
  */
 function write_comment(comment, context) {
@@ -90,6 +90,7 @@ function write_comment(comment, context) {
 		}
 
 		context.write('*/');
+		if (lines.length > 1) context.newline();
 	}
 }
 
@@ -104,6 +105,36 @@ export default (options = {}) => {
 
 	let comment_index = 0;
 
+	/**
+	 * Write additional comments for a node
+	 * @param {Context} context
+	 * @param {BaseComment[] | undefined} comments
+	 * @param {('leading' | 'trailing')} position
+	 */
+	function write_additional_comments(context, comments, position) {
+		if (!comments) {
+			return;
+		}
+
+		for (let i = 0; i < comments.length; i += 1) {
+			const comment = comments[i];
+
+			if (position === 'trailing' && i === 0) {
+				context.write(' ');
+			}
+
+			write_comment(comment, context);
+
+			if (position === 'leading') {
+				if (comment.type === 'Line') {
+					context.newline();
+				} else if (comment.type === 'Block' && !comment.value.includes('\n')) {
+					context.write(' ');
+				}
+			}
+		}
+	}
+
 	/**
 	 * Set `comment_index` to be the first comment after `start`.
 	 * Most of the time this is already correct, but if nodes
@@ -775,11 +806,15 @@ export default (options = {}) => {
 
 	return {
 		_(node, context, visit) {
+			write_additional_comments(context, options.getLeadingComments?.(node), 'leading');
+
 			if (node.loc) {
 				flush_comments_until(context, null, node.loc.start, true);
 			}
 
 			visit(node);
+
+			write_additional_comments(context, options.getTrailingComments?.(node), 'trailing');
 		},
 
 		AccessorProperty:

package/src/languages/ts/public.d.ts

@@ -1,2 +1,2 @@
 export * from './index';
-export { Comment } from '../types';
+export { BaseComment, Comment } from '../types';

package/src/languages/tsx/public.d.ts

@@ -1,2 +1,2 @@
 export * from './index';
-export { Comment } from '../types';
+export { BaseComment, Comment } from '../types';

package/src/languages/types.d.ts

@@ -1,6 +1,10 @@
+import { TSESTree } from '@typescript-eslint/types';
+
 export type TSOptions = {
 	quotes?: 'double' | 'single';
 	comments?: Comment[];
+	getLeadingComments?: (node: TSESTree.Node) => BaseComment[] | undefined;
+	getTrailingComments?: (node: TSESTree.Node) => BaseComment[] | undefined;
 };
 
 interface Position {
@@ -10,11 +14,14 @@ interface Position {
 
 // this exists in TSESTree but because of the inanity around enums
 // it's easier to do this ourselves
-export interface Comment {
+export interface BaseComment {
 	type: 'Line' | 'Block';
 	value: string;
 	start?: number;
 	end?: number;
+}
+
+export interface Comment extends BaseComment {
 	loc: {
 		start: Position;
 		end: Position;

package/types/index.d.ts

@@ -77,6 +77,8 @@ declare module 'esrap/languages/ts' {
 	type TSOptions = {
 		quotes?: 'double' | 'single';
 		comments?: Comment[];
+		getLeadingComments?: (node: TSESTree.Node) => BaseComment[] | undefined;
+		getTrailingComments?: (node: TSESTree.Node) => BaseComment[] | undefined;
 	};
 
 	interface Position {
@@ -86,11 +88,14 @@ declare module 'esrap/languages/ts' {
 
 	// this exists in TSESTree but because of the inanity around enums
 	// it's easier to do this ourselves
-	export interface Comment {
+	export interface BaseComment {
 		type: 'Line' | 'Block';
 		value: string;
 		start?: number;
 		end?: number;
+	}
+
+	export interface Comment extends BaseComment {
 		loc: {
 			start: Position;
 			end: Position;
@@ -127,6 +132,8 @@ declare module 'esrap/languages/tsx' {
 	type TSOptions = {
 		quotes?: 'double' | 'single';
 		comments?: Comment[];
+		getLeadingComments?: (node: TSESTree.Node) => BaseComment[] | undefined;
+		getTrailingComments?: (node: TSESTree.Node) => BaseComment[] | undefined;
 	};
 
 	interface Position {
@@ -136,11 +143,14 @@ declare module 'esrap/languages/tsx' {
 
 	// this exists in TSESTree but because of the inanity around enums
 	// it's easier to do this ourselves
-	export interface Comment {
+	export interface BaseComment {
 		type: 'Line' | 'Block';
 		value: string;
 		start?: number;
 		end?: number;
+	}
+
+	export interface Comment extends BaseComment {
 		loc: {
 			start: Position;
 			end: Position;

package/types/index.d.ts.map

@@ -16,6 +16,7 @@
 		"Node",
 		"TSOptions",
 		"Position",
+		"BaseComment",
 		"Comment"
 	],
 	"sources": [
@@ -34,6 +35,6 @@
 		null,
 		null
 	],
-	"mappings": ";MAGYA,QAAQA;;;;;;;;MAQfC,MAAMA;;MAENC,mBAAmBA;;;;MAIZC,OAAOA;;aAEPC,QAAQA;;;;WAwBHC,QAAQA;;;;;;MAWbC,OAAOA;;kBAEFC,YAAYA;;;;;;;;;iBCHbC,KAAKA;;;;cC5CRC,OAAOA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cCDPC,sBAAsBA;;aAHZC,IAAIA;MCLfC,SAASA;;;;;WAKXC,QAAQA;;;;;;;kBAODC,OAAOA;;;;;;;;;;MJTZd,QAAQA;;;;;;;;MAQfC,MAAMA;;MAENC,mBAAmBA;;;;MAIZC,OAAOA;;MAEPC,QAAQA;;;;;;;;;;;aKdGO,IAAIA;MDLfC,SAASA;;;;;WAKXC,QAAQA;;;;;;;kBAODC,OAAOA;;;;;;;;;;MJTZd,QAAQA;;;;;;;;MAQfC,MAAMA;;MAENC,mBAAmBA;;;;MAIZC,OAAOA;;MAEPC,QAAQA",
+	"mappings": ";MAGYA,QAAQA;;;;;;;;MAQfC,MAAMA;;MAENC,mBAAmBA;;;;MAIZC,OAAOA;;aAEPC,QAAQA;;;;WAwBHC,QAAQA;;;;;;MAWbC,OAAOA;;kBAEFC,YAAYA;;;;;;;;;iBCHbC,KAAKA;;;;cC5CRC,OAAOA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cCDPC,sBAAsBA;;aAHZC,IAAIA;MCHfC,SAASA;;;;;;;WAOXC,QAAQA;;;;;;;kBAODC,WAAWA;;;;;;;kBAOXC,OAAOA;;;;;;MJpBZf,QAAQA;;;;;;;;MAQfC,MAAMA;;MAENC,mBAAmBA;;;;MAIZC,OAAOA;;MAEPC,QAAQA;;;;;;;;;;;aKdGO,IAAIA;MDHfC,SAASA;;;;;;;WAOXC,QAAQA;;;;;;;kBAODC,WAAWA;;;;;;;kBAOXC,OAAOA;;;;;;MJpBZf,QAAQA;;;;;;;;MAQfC,MAAMA;;MAENC,mBAAmBA;;;;MAIZC,OAAOA;;MAEPC,QAAQA",
 	"ignoreList": []
 }