All files / src/compiler/phases/1-parse acorn.js

100% Statements 192/192
98.14% Branches 53/54
100% Functions 8/8
100% Lines 188/188

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 1892x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 4450x 4450x 4450x 4450x 4450x 4450x 4450x 4450x 4450x 4450x 4450x 4450x 4450x 4450x 4450x 2x 2x 2x 2x 2x 2x 2x 2x 12552x 12552x 12552x 12552x 12552x 12552x 12552x 12552x 12552x 12552x 12552x 12547x 12547x 12547x 12547x 2x 2x 2x 2x 2x 2x 2x 17002x 17002x 17002x 17002x 17002x 17002x 17002x 17002x 17002x 17002x 17002x 17002x 17002x 17002x 17002x 17002x 17002x 17002x 17002x 277x 4x 4x 4x 4x 4x 4x 4x 4x 4x 277x 277x 17002x 17002x 17002x 17002x 16997x 144x 144x 144x 4805x 4805x 4805x 210x 210x 210x 4805x 4805x 4805x 4805x 2811x 2811x 2811x 2020x 2020x 2020x 2020x 1925x 2020x 1914x 2020x 2020x 2020x 141x 141x 141x 141x 141x 150x 150x 28x 28x 28x 28x 28x 2020x 35x 35x 2020x 2811x 4805x 144x 144x 144x 144x 16997x 4x 4x 16997x 17002x 17002x 2x 2x 2x 2x 2x 2x 291x 291x 291x 2094x 2094x 2094x 2094x 2094x 2094x 24x 24x 24x 24x 24x 24x 24x 24x 2094x 2094x 2094x 165x 2094x 40x 40x 40x 40x 40x 40x 2094x 2094x 2094x 291x 291x  
/** @import { Comment, Program } from 'estree' */
/** @import { Node } from 'acorn' */
import * as acorn from 'acorn';
import { walk } from 'zimmerframe';
import { tsPlugin } from 'acorn-typescript';
import { locator } from '../../state.js';
 
const ParserWithTS = acorn.Parser.extend(tsPlugin({ allowSatisfies: true }));
 
/**
 * @param {string} source
 * @param {boolean} typescript
 */
export function parse(source, typescript) {
	const parser = typescript ? ParserWithTS : acorn.Parser;
	const { onComment, add_comments } = get_comment_handlers(source);
 
	const ast = parser.parse(source, {
		onComment,
		sourceType: 'module',
		ecmaVersion: 13,
		locations: true
	});
 
	if (typescript) amend(source, ast);
	add_comments(ast);
 
	return /** @type {Program} */ (ast);
}
 
/**
 * @param {string} source
 * @param {boolean} typescript
 * @param {number} index
 * @returns {acorn.Expression & { leadingComments?: CommentWithLocation[]; trailingComments?: CommentWithLocation[]; }}
 */
export function parse_expression_at(source, typescript, index) {
	const parser = typescript ? ParserWithTS : acorn.Parser;
	const { onComment, add_comments } = get_comment_handlers(source);
 
	const ast = parser.parseExpressionAt(source, index, {
		onComment,
		sourceType: 'module',
		ecmaVersion: 13,
		locations: true
	});
 
	if (typescript) amend(source, ast);
	add_comments(ast);
 
	return ast;
}
 
/**
 * Acorn doesn't add comments to the AST by itself. This factory returns the capabilities
 * to add them after the fact. They are needed in order to support `svelte-ignore` comments
 * in JS code and so that `prettier-plugin-svelte` doesn't remove all comments when formatting.
 * @param {string} source
 */
function get_comment_handlers(source) {
	/**
	 * @typedef {Comment & {
	 *   start: number;
	 *   end: number;
	 * }} CommentWithLocation
	 */
 
	/** @type {CommentWithLocation[]} */
	const comments = [];
 
	return {
		/**
		 * @param {boolean} block
		 * @param {string} value
		 * @param {number} start
		 * @param {number} end
		 */
		onComment: (block, value, start, end) => {
			if (block && /\n/.test(value)) {
				let a = start;
				while (a > 0 && source[a - 1] !== '\n') a -= 1;
 
				let b = a;
				while (/[ \t]/.test(source[b])) b += 1;
 
				const indentation = source.slice(a, b);
				value = value.replace(new RegExp(`^${indentation}`, 'gm'), '');
			}
 
			comments.push({ type: block ? 'Block' : 'Line', value, start, end });
		},
 
		/** @param {acorn.Node & { leadingComments?: CommentWithLocation[]; trailingComments?: CommentWithLocation[]; }} ast */
		add_comments(ast) {
			if (comments.length === 0) return;
 
			walk(ast, null, {
				_(node, { next, path }) {
					let comment;
 
					while (comments[0] && comments[0].start < node.start) {
						comment = /** @type {CommentWithLocation} */ (comments.shift());
						(node.leadingComments ||= []).push(comment);
					}
 
					next();
 
					if (comments[0]) {
						const parent = /** @type {any} */ (path.at(-1));
 
						if (parent === undefined || node.end !== parent.end) {
							const slice = source.slice(node.end, comments[0].start);
							const is_last_in_body =
								((parent?.type === 'BlockStatement' || parent?.type === 'Program') &&
									parent.body.indexOf(node) === parent.body.length - 1) ||
								(parent?.type === 'ArrayExpression' &&
									parent.elements.indexOf(node) === parent.elements.length - 1) ||
								(parent?.type === 'ObjectExpression' &&
									parent.properties.indexOf(node) === parent.properties.length - 1);
 
							if (is_last_in_body) {
								// Special case: There can be multiple trailing comments after the last node in a block,
								// and they can be separated by newlines
								let end = node.end;
 
								while (comments.length) {
									const comment = comments[0];
									if (parent && comment.start >= parent.end) break;
 
									(node.trailingComments ||= []).push(comment);
									comments.shift();
									end = comment.end;
								}
							} else if (node.end <= comments[0].start && /^[,) \t]*$/.test(slice)) {
								node.trailingComments = [/** @type {CommentWithLocation} */ (comments.shift())];
							}
						}
					}
				}
			});
 
			// Special case: Trailing comments after the root node (which can only happen for expression tags or for Program nodes).
			// Adding them ensures that we can later detect the end of the expression tag correctly.
			if (comments.length > 0 && (comments[0].start >= ast.end || ast.type === 'Program')) {
				(ast.trailingComments ||= []).push(...comments.splice(0));
			}
		}
	};
}
 
/**
 * Tidy up some stuff left behind by acorn-typescript
 * @param {string} source
 * @param {Node} node
 */
function amend(source, node) {
	return walk(node, null, {
		_(node, context) {
			// @ts-expect-error
			delete node.loc.start.index;
			// @ts-expect-error
			delete node.loc.end.index;
 
			if (typeof node.loc?.end === 'number') {
				const loc = locator(node.loc.end);
				if (loc) {
					node.loc.end = {
						line: loc.line,
						column: loc.column
					};
				}
			}
 
			if (
				/** @type {any} */ (node).typeAnnotation &&
				(node.end === undefined || node.end < node.start)
			) {
				// i think there might be a bug in acorn-typescript that prevents
				// `end` from being assigned when there's a type annotation
				let end = /** @type {any} */ (node).typeAnnotation.start;
				while (/\s/.test(source[end - 1])) end -= 1;
				node.end = end;
			}
 
			context.next();
		}
	});
}