All files / src/compiler/utils ast.js

93.85% Statements 351/374
92.55% Branches 87/94
95% Functions 19/20
93.81% Lines 349/372

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 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 3732x 2x 2x 2x 2x 2x 2x 2x 2x 3065x 813x 813x 813x 813x 3065x 3065x 24x 24x 3041x 3041x 3041x 2x 2x 2x 2x 2x 2x 2x 12513x 12513x 12513x 12513x 2x 2x 2x 2x 2x 2x 2x 15105x 15105x 15105x 14331x 15105x 15105x 2x 2x 2x 2x 2x 2x 2x 11172x 11172x 2x 2x 2x 2x 2x 2x 2x 2x 27550x 27550x 25638x 25638x 27550x 27550x 1031x 1876x 64x 1876x 1812x 1812x 1876x 1031x 1031x 27550x 27550x 391x 1040x 1040x 391x 391x 27550x 27550x 117x 117x 27550x 27550x 311x 311x 27550x 27550x 27550x 27550x 2x 2x 2x 2x 2x 2x 2x 162x 162x 162x 162x 162x 162x 162x 162x 162x 162x 214x 214x 174x 174x 214x 214x 10x 214x 204x 204x 162x 162x 2x 2x 2x 2x 2x     162x 162x       162x 162x 162x 162x 162x 2x 2x 2x 2x 2x 2x 2x 2x 79x 79x 79x 63x 63x 79x 79x 12x 20x 20x 20x     20x 12x 12x 79x 79x 4x 8x 8x 4x 4x 79x 79x 79x 79x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 1034x 1034x 1034x 1034x 1034x 1034x 1034x 2x 2x 2x 2x 2x 2x 2x 2x 1725x 1725x 1725x 1725x 1196x 1196x 1196x 1196x 1196x 1196x 1196x 1725x 1725x 296x 516x 19x 19x 6x 6x 6x 26x 20x 14x 20x 6x 6x 20x 26x 6x 19x 19x 19x 19x 19x 19x 19x 19x 19x 19x     516x 497x 497x 497x 497x 497x 516x 296x 296x 1725x 1725x 92x 199x 199x 192x 16x 16x 16x 16x             16x 16x 16x 192x 176x 176x 176x 176x 192x 199x 199x 199x 1725x 1725x 141x 141x 141x 141x 139x 139x 139x 139x 139x 139x 141x 2x 2x 141x 141x 141x 1725x 1725x 1725x 1725x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 1166x 1166x 1166x     1166x 1166x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 1020x 1020x 1020x 1020x 240x 1020x 780x 780x 240x 1009x             240x 1020x 7x 7x 233x 233x 233x 2x 2x 2x 2x 2x 2x 2x 322x 322x  
import { walk } from 'zimmerframe';
import * as b from '../utils/builders.js';
 
/**
 * Gets the left-most identifier of a member expression or identifier.
 * @param {import('estree').MemberExpression | import('estree').Identifier} expression
 * @returns {import('estree').Identifier | null}
 */
export function object(expression) {
	while (expression.type === 'MemberExpression') {
		expression = /** @type {import('estree').MemberExpression | import('estree').Identifier} */ (
			expression.object
		);
	}
 
	if (expression.type !== 'Identifier') {
		return null;
	}
 
	return expression;
}
 
/**
 * Returns true if the attribute contains a single static text node.
 * @param {import('#compiler').Attribute} attribute
 * @returns {attribute is import('#compiler').Attribute & { value: [import('#compiler').Text] }}
 */
export function is_text_attribute(attribute) {
	return (
		attribute.value !== true && attribute.value.length === 1 && attribute.value[0].type === 'Text'
	);
}
 
/**
 * Returns true if the attribute contains a single expression node.
 * @param {import('#compiler').Attribute} attribute
 * @returns {attribute is import('#compiler').Attribute & { value: [import('#compiler').ExpressionTag] }}
 */
export function is_expression_attribute(attribute) {
	return (
		attribute.value !== true &&
		attribute.value.length === 1 &&
		attribute.value[0].type === 'ExpressionTag'
	);
}
 
/**
 * Returns true if the attribute starts with `on` and contains a single expression node.
 * @param {import('#compiler').Attribute} attribute
 * @returns {attribute is import('#compiler').Attribute & { value: [import('#compiler').ExpressionTag] }}
 */
export function is_event_attribute(attribute) {
	return is_expression_attribute(attribute) && attribute.name.startsWith('on');
}
 
/**
 * Extracts all identifiers from a pattern.
 * @param {import('estree').Pattern} param
 * @param {import('estree').Identifier[]} [nodes]
 * @returns {import('estree').Identifier[]}
 */
export function extract_identifiers(param, nodes = []) {
	switch (param.type) {
		case 'Identifier':
			nodes.push(param);
			break;
 
		case 'ObjectPattern':
			for (const prop of param.properties) {
				if (prop.type === 'RestElement') {
					extract_identifiers(prop.argument, nodes);
				} else {
					extract_identifiers(prop.value, nodes);
				}
			}
 
			break;
 
		case 'ArrayPattern':
			for (const element of param.elements) {
				if (element) extract_identifiers(element, nodes);
			}
 
			break;
 
		case 'RestElement':
			extract_identifiers(param.argument, nodes);
			break;
 
		case 'AssignmentPattern':
			extract_identifiers(param.left, nodes);
			break;
	}
 
	return nodes;
}
 
/**
 * Extracts all identifiers and a stringified keypath from an expression.
 * @param {import('estree').Expression} expr
 * @returns {[keypath: string, ids: import('estree').Identifier[]]}
 */
export function extract_all_identifiers_from_expression(expr) {
	/** @type {import('estree').Identifier[]} */
	let nodes = [];
	/** @type {string[]} */
	let keypath = [];
 
	walk(
		expr,
		{},
		{
			Identifier(node, { path }) {
				const parent = path.at(-1);
				if (parent?.type !== 'MemberExpression' || parent.property !== node || parent.computed) {
					nodes.push(node);
				}
 
				if (parent?.type === 'MemberExpression' && parent.computed && parent.property === node) {
					keypath.push(`[${node.name}]`);
				} else {
					keypath.push(node.name);
				}
			},
			Literal(node, { path }) {
				const value = typeof node.value === 'string' ? `"${node.value}"` : String(node.value);
				const parent = path.at(-1);
				if (parent?.type === 'MemberExpression' && parent.computed && parent.property === node) {
					keypath.push(`[${value}]`);
				} else {
					keypath.push(value);
				}
			},
			ThisExpression(_, { next }) {
				keypath.push('this');
				next();
			}
		}
	);
 
	return [keypath.join('.'), nodes];
}
 
/**
 * Extracts all leaf identifiers from a destructuring expression.
 * @param {import('estree').Identifier | import('estree').ObjectExpression | import('estree').ArrayExpression} node
 * @param {import('estree').Identifier[]} [nodes]
 * @returns
 */
export function extract_identifiers_from_destructuring(node, nodes = []) {
	// TODO This isn't complete, but it should be enough for our purposes
	switch (node.type) {
		case 'Identifier':
			nodes.push(node);
			break;
 
		case 'ObjectExpression':
			for (const prop of node.properties) {
				if (prop.type === 'Property') {
					extract_identifiers_from_destructuring(/** @type {any} */ (prop.value), nodes);
				} else {
					extract_identifiers_from_destructuring(/** @type {any} */ (prop.argument), nodes);
				}
			}
 
			break;
 
		case 'ArrayExpression':
			for (const element of node.elements) {
				if (element) extract_identifiers_from_destructuring(/** @type {any} */ (element), nodes);
			}
 
			break;
	}
 
	return nodes;
}
 
/**
 * Represents the path of a destructured assignment from either a declaration
 * or assignment expression. For example, given `const { foo: { bar: baz } } = quux`,
 * the path of `baz` is `foo.bar`
 * @typedef {Object} DestructuredAssignment
 * @property {import('estree').Identifier | import('estree').MemberExpression} node The node the destructuring path end in. Can be a member expression only for assignment expressions
 * @property {boolean} is_rest `true` if this is a `...rest` destructuring
 * @property {(expression: import('estree').Expression) => import('estree').Identifier | import('estree').MemberExpression | import('estree').CallExpression} expression Returns an expression which walks the path starting at the given expression.
 * This will be a call expression if a rest element or default is involved —
 * e.g. `const { foo: { bar: baz = 42 }, ...rest } = quux` —
 * since we can't represent `baz` or `rest` purely as a path
 * @property {(expression: import('estree').Expression) => import('estree').Identifier | import('estree').MemberExpression | import('estree').CallExpression} update_expression Like `expression` but without default values.
 */
 
/**
 * Extracts all destructured assignments from a pattern.
 * @param {import('estree').Node} param
 * @returns {DestructuredAssignment[]}
 */
export function extract_paths(param) {
	return _extract_paths(
		[],
		param,
		(node) => /** @type {import('estree').Identifier | import('estree').MemberExpression} */ (node),
		(node) => /** @type {import('estree').Identifier | import('estree').MemberExpression} */ (node)
	);
}
 
/**
 * @param {DestructuredAssignment[]} assignments
 * @param {import('estree').Node} param
 * @param {DestructuredAssignment['expression']} expression
 * @param {DestructuredAssignment['update_expression']} update_expression
 * @returns {DestructuredAssignment[]}
 */
function _extract_paths(assignments = [], param, expression, update_expression) {
	switch (param.type) {
		case 'Identifier':
		case 'MemberExpression':
			assignments.push({
				node: param,
				is_rest: false,
				expression,
				update_expression
			});
			break;
 
		case 'ObjectPattern':
			for (const prop of param.properties) {
				if (prop.type === 'RestElement') {
					/** @type {DestructuredAssignment['expression']} */
					const rest_expression = (object) => {
						/** @type {import('estree').Expression[]} */
						const props = [];
						for (const p of param.properties) {
							if (p.type === 'Property' && p.key.type !== 'PrivateIdentifier') {
								if (p.key.type === 'Identifier' && !p.computed) {
									props.push(b.literal(p.key.name));
								} else {
									props.push(p.key);
								}
							}
						}
						return b.call('$.exclude_from_object', expression(object), b.array(props));
					};
 
					if (prop.argument.type === 'Identifier') {
						assignments.push({
							node: prop.argument,
							is_rest: true,
							expression: rest_expression,
							update_expression: rest_expression
						});
					} else {
						_extract_paths(assignments, prop.argument, rest_expression, rest_expression);
					}
				} else {
					/** @type {DestructuredAssignment['expression']} */
					const object_expression = (object) =>
						b.member(expression(object), prop.key, prop.computed || prop.key.type !== 'Identifier');
					_extract_paths(assignments, prop.value, object_expression, object_expression);
				}
			}
 
			break;
 
		case 'ArrayPattern':
			for (let i = 0; i < param.elements.length; i += 1) {
				const element = param.elements[i];
				if (element) {
					if (element.type === 'RestElement') {
						/** @type {DestructuredAssignment['expression']} */
						const rest_expression = (object) =>
							b.call(b.member(expression(object), b.id('slice')), b.literal(i));
						if (element.argument.type === 'Identifier') {
							assignments.push({
								node: element.argument,
								is_rest: true,
								expression: rest_expression,
								update_expression: rest_expression
							});
						} else {
							_extract_paths(assignments, element.argument, rest_expression, rest_expression);
						}
					} else {
						/** @type {DestructuredAssignment['expression']} */
						const array_expression = (object) => b.member(expression(object), b.literal(i), true);
						_extract_paths(assignments, element, array_expression, array_expression);
					}
				}
			}
 
			break;
 
		case 'AssignmentPattern': {
			/** @type {DestructuredAssignment['expression']} */
			const fallback_expression = (object) =>
				b.call('$.value_or_fallback', expression(object), param.right);
			if (param.left.type === 'Identifier') {
				assignments.push({
					node: param.left,
					is_rest: false,
					expression: fallback_expression,
					update_expression
				});
			} else {
				_extract_paths(assignments, param.left, fallback_expression, update_expression);
			}
 
			break;
		}
	}
 
	return assignments;
}
 
/**
 * Like `path.at(x)`, but skips over `TSNonNullExpression` and `TSAsExpression` nodes and eases assertions a bit
 * by removing the `| undefined` from the resulting type.
 *
 * @template {import('#compiler').SvelteNode} T
 * @param {T[]} path
 * @param {number} at
 */
export function get_parent(path, at) {
	let node = path.at(at);
	// @ts-expect-error
	if (node.type === 'TSNonNullExpression' || node.type === 'TSAsExpression') {
		return /** @type {T} */ (path.at(at < 0 ? at - 1 : at + 1));
	}
	return /** @type {T} */ (node);
}
 
/**
 * Returns `true` if the expression is an identifier, a literal, a function expression,
 * or a logical expression that only contains simple expressions. Used to determine whether
 * something needs to be treated as though accessing it could have side-effects (i.e.
 * reading signals prematurely)
 * @param {import('estree').Expression} node
 * @returns {boolean}
 */
export function is_simple_expression(node) {
	if (
		node.type === 'Literal' ||
		node.type === 'Identifier' ||
		node.type === 'ArrowFunctionExpression' ||
		node.type === 'FunctionExpression'
	) {
		return true;
	}
 
	if (node.type === 'ConditionalExpression') {
		return (
			is_simple_expression(node.test) &&
			is_simple_expression(node.consequent) &&
			is_simple_expression(node.alternate)
		);
	}
 
	if (node.type === 'BinaryExpression' || node.type === 'LogicalExpression') {
		return is_simple_expression(node.left) && is_simple_expression(node.right);
	}
 
	return false;
}
 
/**
 * @template {import('estree').SimpleCallExpression | import('estree').MemberExpression} T
 * @param {import('estree').ChainExpression & { expression : T } | T} node
 * @returns {T}
 */
export function unwrap_optional(node) {
	return node.type === 'ChainExpression' ? node.expression : node;
}