All files / src/compiler/phases scope.js

99.47% Statements 760/764
98.39% Branches 184/187
100% Functions 41/41
99.47% Lines 751/755

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 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 7612x 2x 2x 2x 2x 2x 2x 2x           2x 2x 2x 2x 2x 2x 50323x 50323x 50323x 50323x 50323x 50323x 50323x 50323x 50323x 50323x 50323x 50323x 50323x 50323x 50323x 50323x 50323x 50323x 50323x 50323x 50323x 50323x 50323x 50323x 50323x 50323x 50323x 50323x 50323x 50323x 50323x 50323x 50323x 50323x 50323x 50323x 50323x 50323x 50323x 50323x 50323x 50323x 50323x 50323x 50323x 50323x 50323x 50323x 50323x 50323x 50323x 50323x 50323x 50323x 50323x 50323x 50323x 50323x 50323x 50323x 50323x 50323x 26292x 24150x     24150x 24150x 1923x 1923x 24150x 24369x 26292x 2x 2x 2x 24367x 24367x 24367x 24367x 24367x 24367x 24367x 24367x 24367x 24367x 24367x 24367x 24367x 24367x 24367x 24367x 24367x 24367x 24367x 24367x 24367x 24367x 24367x 24367x 50323x 50323x 34282x 34282x 50323x 50323x 50323x 50323x 50323x 50323x 16643x 2097x 2097x 14546x 14546x 14546x 14546x 14546x 14546x 16635x 16643x 16643x 14546x 16643x 10817x 10817x 14546x 14546x 14546x 14546x 14546x 50323x 50323x 50323x 50323x 50323x 50323x 438215x 438215x 50323x 50323x 50323x 50323x 50323x 50323x 5757x 5757x     5757x 5757x 50323x 50323x 50323x 50323x 50323x 50323x 2412x 2412x 50323x 50323x 50323x 50323x 50323x 50323x 99143x 99143x 99143x 99143x 99143x 99143x 99143x 99143x 99143x 34833x 99143x 60432x 64310x 3878x 3878x 3878x 3878x 99143x 50323x 2x 2x 5377x 5377x 5377x 5377x 5377x 5377x 5377x 5811x 5811x 5811x 5811x 5811x 4269x 4269x 5811x 5811x 5811x 5811x 5811x 5377x 2x 2x 2x 2x 2x 2x 2x 2x 16041x 16041x 16041x 16041x 16041x 16041x 16041x 16041x 16041x 16041x 16041x 16041x 16041x 16041x 16041x 16041x 16041x 16041x 16041x 16041x 16041x 16041x 16041x 16041x 16041x 16041x 16041x 16041x 16041x 16041x 3950x 1561x 1567x 1567x 1561x 3950x 16041x 16041x 16041x 16041x 16041x 230x 230x 230x 230x 16041x 16041x 16041x 16041x 16041x 16041x 9937x 9937x 9937x 16041x 16041x 16041x 16041x 16041x 16041x 1459x 1459x 1459x 1459x 1459x 96x 96x 1459x 1459x 1459x 1459x 1459x 1459x 1552x 147x 1552x 1405x 1405x 1552x 1459x 1459x 1889x 1889x 1889x 1889x 1889x 187x 187x 187x 187x 187x 187x 1889x 1889x 1889x 16041x 16041x 16041x 16041x 16041x 16041x 427x 427x 427x 93x 93x 16041x 16041x 16041x 16041x 16041x 46340x 46340x 46340x 46340x 36941x 36941x 36941x 36941x 46340x 36938x 36938x 16041x 16041x 335x 335x 327x 327x 327x 327x 327x 327x 335x 251x 335x 211x 201x 195x 195x 201x 211x 327x 327x 16041x 16041x 16041x 16041x 16041x 16041x 16041x 16041x 222x 222x 222x 222x 222x 222x 222x 51x 63x 63x 63x 222x 171x 171x 171x 171x 171x 171x 171x 171x 171x 171x 16041x 16041x 16041x 1342x 1342x 16041x 16041x 16041x 16041x 16041x 16041x 2409x 2409x 16041x 16041x 16041x 399x 399x 16041x 16041x 16041x 1842x 1936x 1936x 16041x 16041x 16041x 366x 366x 366x 366x 366x 366x 366x 16041x 16041x 16041x 1132x 1132x 1132x 1132x 1132x 1132x 1132x 16041x 16041x 16041x 2452x 2452x 2452x 2452x 2452x 16041x 16041x 16041x 16041x 16041x 16041x 16041x 2829x 2829x 2829x 2829x 1331x 2829x 2613x 2613x 2825x 216x 216x 16041x 16041x 16041x 104x 104x 16041x 16041x 16041x 7485x 7485x 8167x 8167x 8167x 8167x 8167x 8167x 8679x 8679x 8679x 8679x 8679x 8679x 8679x 8679x 8162x 7480x 7480x 16041x 16041x 16041x 9x 7x 7x 7x 7x 7x 7x 7x 7x 7x 2x 2x 16041x 16041x 16041x 991x 991x 991x 991x 991x 991x 991x 991x 1104x 1104x 1104x 1104x 1104x 1104x 2046x 15x 15x 1104x 1104x 58x 58x 58x 58x 58x 1104x 1104x 1104x 1104x 991x 991x 991x 991x 991x 113x 113x 113x 113x 113x 991x 991x 991x 991x 3433x 3433x 991x 989x 989x 989x 989x 989x 991x 1340x 75x 75x 1340x 989x 989x 989x 989x 989x 991x 991x 991x 991x 991x 16041x 16041x 16041x 185x 185x 185x 102x 102x 185x 185x 157x 157x 145x 145x 145x 145x 145x 197x 197x 197x 145x 157x 185x 185x 103x 103x 95x 95x 95x 95x 95x 151x 151x 151x 95x 103x 16041x 16041x 16041x 108x 108x 108x 108x 108x 82x 82x 108x 108x 108x 108x 108x 108x 70x 70x 70x 70x 108x 108x 16041x 16041x 16041x 16846x 16846x 16846x 16041x 16041x 16041x 1026x 1026x 1026x 1026x 1026x 16041x 16041x 16041x 16041x 16041x 16041x 16041x 16041x 16041x 16041x 16041x 83x 15x 15x 83x 83x 16041x 16041x 16041x 16041x 16041x 195x 195x 151x 151x 151x 16035x 16035x 16035x 16041x 36927x 36927x 16035x 16041x 3834x 3936x 3936x 3936x 3936x 3457x 3457x 3457x 2563x 3455x 894x 894x 3457x 3936x 3834x 16035x 16035x 16035x 16035x 16035x 16035x 2x 2x 2x 2x 2x 2x 2x 63949x 63949x 63949x 2x 2x 2x 2x 2x 2x 2x 15301x 15301x 13582x 13582x 13582x 13582x 13582x 15301x 4901x 4901x 4864x 4864x 4864x 13545x 15301x 36x 36x 36x 13545x 15301x 13235x 13235x 13235x 15299x 5298x 5298x 15256x 5258x 5258x 5258x  
/** @import { ClassDeclaration, Expression, FunctionDeclaration, Identifier, ImportDeclaration, MemberExpression, Node, Pattern, VariableDeclarator } from 'estree' */
/** @import { Context, Visitor } from 'zimmerframe' */
/** @import { AST, Binding, DeclarationKind, ElementLike, SvelteNode } from '#compiler' */
import is_reference from 'is-reference';
import { walk } from 'zimmerframe';
import { create_expression_metadata } from './nodes.js';
import * as b from '../utils/builders.js';
import * as e from '../errors.js';
import {
	extract_identifiers,
	extract_identifiers_from_destructuring,
	object,
	unwrap_pattern
} from '../utils/ast.js';
import { is_reserved, is_rune } from '../../utils.js';
import { determine_slot } from '../utils/slot.js';
import { validate_identifier_name } from './2-analyze/visitors/shared/utils.js';
 
export class Scope {
	/** @type {ScopeRoot} */
	root;
 
	/**
	 * The immediate parent scope
	 * @type {Scope | null}
	 */
	parent;
 
	/**
	 * Whether or not `var` declarations are contained by this scope
	 * @type {boolean}
	 */
	#porous;
 
	/**
	 * A map of every identifier declared by this scope, and all the
	 * identifiers that reference it
	 * @type {Map<string, Binding>}
	 */
	declarations = new Map();
 
	/**
	 * A map of declarators to the bindings they declare
	 * @type {Map<VariableDeclarator | AST.LetDirective, Binding[]>}
	 */
	declarators = new Map();
 
	/**
	 * A set of all the names referenced with this scope
	 * — useful for generating unique names
	 * @type {Map<string, { node: Identifier; path: SvelteNode[] }[]>}
	 */
	references = new Map();
 
	/**
	 * The scope depth allows us to determine if a state variable is referenced in its own scope,
	 * which is usually an error. Block statements do not increase this value
	 */
	function_depth = 0;
 
	/**
	 *
	 * @param {ScopeRoot} root
	 * @param {Scope | null} parent
	 * @param {boolean} porous
	 */
	constructor(root, parent, porous) {
		this.root = root;
		this.parent = parent;
		this.#porous = porous;
		this.function_depth = parent ? parent.function_depth + (porous ? 0 : 1) : 0;
	}
 
	/**
	 * @param {Identifier} node
	 * @param {Binding['kind']} kind
	 * @param {DeclarationKind} declaration_kind
	 * @param {null | Expression | FunctionDeclaration | ClassDeclaration | ImportDeclaration | AST.EachBlock} initial
	 * @returns {Binding}
	 */
	declare(node, kind, declaration_kind, initial = null) {
		if (this.parent) {
			if (declaration_kind === 'var' && this.#porous) {
				return this.parent.declare(node, kind, declaration_kind);
			}
 
			if (declaration_kind === 'import') {
				return this.parent.declare(node, kind, declaration_kind, initial);
			}
		}
 
		if (this.declarations.has(node.name)) {
			// This also errors on var/function types, but that's arguably a good thing
			e.declaration_duplicate(node, node.name);
		}
 
		/** @type {Binding} */
		const binding = {
			node,
			references: [],
			legacy_dependencies: [],
			initial,
			reassigned: false,
			mutated: false,
			updated: false,
			scope: this,
			kind,
			declaration_kind,
			is_called: false,
			prop_alias: null,
			metadata: null
		};
 
		validate_identifier_name(binding, this.function_depth);
 
		this.declarations.set(node.name, binding);
		this.root.conflicts.add(node.name);
		return binding;
	}
 
	child(porous = false) {
		return new Scope(this.root, this, porous);
	}
 
	/**
	 * @param {string} preferred_name
	 * @returns {string}
	 */
	generate(preferred_name) {
		if (this.#porous) {
			return /** @type {Scope} */ (this.parent).generate(preferred_name);
		}
 
		preferred_name = preferred_name.replace(/[^a-zA-Z0-9_$]/g, '_').replace(/^[0-9]/, '_');
		let name = preferred_name;
		let n = 1;
 
		while (
			this.references.has(name) ||
			this.declarations.has(name) ||
			this.root.conflicts.has(name) ||
			is_reserved(name)
		) {
			name = `${preferred_name}_${n++}`;
		}
 
		this.references.set(name, []);
		this.root.conflicts.add(name);
		return name;
	}
 
	/**
	 * @param {string} name
	 * @returns {Binding | null}
	 */
	get(name) {
		return this.declarations.get(name) ?? this.parent?.get(name) ?? null;
	}
 
	/**
	 * @param {VariableDeclarator | AST.LetDirective} node
	 * @returns {Binding[]}
	 */
	get_bindings(node) {
		const bindings = this.declarators.get(node);
		if (!bindings) {
			throw new Error('No binding found for declarator');
		}
		return bindings;
	}
 
	/**
	 * @param {string} name
	 * @returns {Scope | null}
	 */
	owner(name) {
		return this.declarations.has(name) ? this : this.parent && this.parent.owner(name);
	}
 
	/**
	 * @param {Identifier} node
	 * @param {SvelteNode[]} path
	 */
	reference(node, path) {
		path = [...path]; // ensure that mutations to path afterwards don't affect this reference
		let references = this.references.get(node.name);
 
		if (!references) this.references.set(node.name, (references = []));
 
		references.push({ node, path });
 
		const binding = this.declarations.get(node.name);
		if (binding) {
			binding.references.push({ node, path });
		} else if (this.parent) {
			this.parent.reference(node, path);
		} else {
			// no binding was found, and this is the top level scope,
			// which means this is a global
			this.root.conflicts.add(node.name);
		}
	}
}
 
export class ScopeRoot {
	/** @type {Set<string>} */
	conflicts = new Set();
 
	/**
	 * @param {string} preferred_name
	 */
	unique(preferred_name) {
		preferred_name = preferred_name.replace(/[^a-zA-Z0-9_$]/g, '_');
		let final_name = preferred_name;
		let n = 1;
 
		while (this.conflicts.has(final_name)) {
			final_name = `${preferred_name}_${n++}`;
		}
 
		this.conflicts.add(final_name);
		const id = b.id(final_name);
		return id;
	}
}
 
/**
 * @param {SvelteNode} ast
 * @param {ScopeRoot} root
 * @param {boolean} allow_reactive_declarations
 * @param {Scope | null} parent
 */
export function create_scopes(ast, root, allow_reactive_declarations, parent) {
	/** @typedef {{ scope: Scope }} State */
 
	/**
	 * A map of node->associated scope. A node appearing in this map does not necessarily mean that it created a scope
	 * @type {Map<SvelteNode, Scope>}
	 */
	const scopes = new Map();
	const scope = new Scope(root, parent, false);
	scopes.set(ast, scope);
 
	/** @type {State} */
	const state = { scope };
 
	/** @type {[Scope, { node: Identifier; path: SvelteNode[] }][]} */
	const references = [];
 
	/** @type {[Scope, Pattern | MemberExpression][]} */
	const updates = [];
 
	/**
	 * An array of reactive declarations, i.e. the `a` in `$: a = b * 2`
	 * @type {Identifier[]}
	 */
	const possible_implicit_declarations = [];
 
	/**
	 * @param {Scope} scope
	 * @param {Pattern[]} params
	 */
	function add_params(scope, params) {
		for (const param of params) {
			for (const node of extract_identifiers(param)) {
				scope.declare(node, 'normal', param.type === 'RestElement' ? 'rest_param' : 'param');
			}
		}
	}
 
	/**
	 * @type {Visitor<Node, State, SvelteNode>}
	 */
	const create_block_scope = (node, { state, next }) => {
		const scope = state.scope.child(true);
		scopes.set(node, scope);
 
		next({ scope });
	};
 
	/**
	 * @type {Visitor<ElementLike, State, SvelteNode>}
	 */
	const SvelteFragment = (node, { state, next }) => {
		const scope = state.scope.child();
		scopes.set(node, scope);
		next({ scope });
	};
 
	/**
	 * @type {Visitor<AST.Component | AST.SvelteComponent | AST.SvelteSelf, State, SvelteNode>}
	 */
	const Component = (node, context) => {
		node.metadata.scopes = {
			default: context.state.scope.child()
		};
 
		if (node.type === 'SvelteComponent') {
			context.visit(node.expression);
		}
 
		const default_state = determine_slot(node)
			? context.state
			: { scope: node.metadata.scopes.default };
 
		for (const attribute of node.attributes) {
			if (attribute.type === 'LetDirective') {
				context.visit(attribute, default_state);
			} else {
				context.visit(attribute);
			}
		}
 
		for (const child of node.fragment.nodes) {
			let state = default_state;
 
			const slot_name = determine_slot(child);
 
			if (slot_name !== null) {
				node.metadata.scopes[slot_name] = context.state.scope.child();
 
				state = {
					scope: node.metadata.scopes[slot_name]
				};
			}
 
			context.visit(child, state);
		}
	};
 
	/**
	 * @type {Visitor<AST.AnimateDirective | AST.TransitionDirective | AST.UseDirective, State, SvelteNode>}
	 */
	const SvelteDirective = (node, { state, path, visit }) => {
		state.scope.reference(b.id(node.name.split('.')[0]), path);
 
		if (node.expression) {
			visit(node.expression);
		}
	};
 
	walk(ast, state, {
		// references
		Identifier(node, { path, state }) {
			const parent = path.at(-1);
			if (
				parent &&
				is_reference(node, /** @type {Node} */ (parent)) &&
				// TSTypeAnnotation, TSInterfaceDeclaration etc - these are normally already filtered out,
				// but for the migration they aren't, so we need to filter them out here
				// -> once migration script is gone we can remove this check
				!parent.type.startsWith('TS')
			) {
				references.push([state.scope, { node, path: path.slice() }]);
			}
		},
		LabeledStatement(node, { path, next }) {
			if (path.length > 1 || !allow_reactive_declarations) return next();
			if (node.label.name !== '$') return next();
 
			// create a scope for the $: block
			const scope = state.scope.child();
			scopes.set(node, scope);
 
			if (
				node.body.type === 'ExpressionStatement' &&
				node.body.expression.type === 'AssignmentExpression'
			) {
				for (const id of extract_identifiers(node.body.expression.left)) {
					if (!id.name.startsWith('$')) {
						possible_implicit_declarations.push(id);
					}
				}
			}
 
			next({ scope });
		},
 
		SvelteFragment,
		SlotElement: SvelteFragment,
		SvelteElement: SvelteFragment,
		RegularElement: SvelteFragment,
 
		LetDirective(node, context) {
			const scope = context.state.scope;
 
			/** @type {Binding[]} */
			const bindings = [];
			scope.declarators.set(node, bindings);
 
			if (node.expression) {
				for (const id of extract_identifiers_from_destructuring(node.expression)) {
					const binding = scope.declare(id, 'template', 'const');
					bindings.push(binding);
				}
			} else {
				/** @type {Identifier} */
				const id = {
					name: node.name,
					type: 'Identifier',
					start: node.start,
					end: node.end
				};
				const binding = scope.declare(id, 'template', 'const');
				bindings.push(binding);
			}
		},
 
		Component: (node, context) => {
			context.state.scope.reference(b.id(node.name), context.path);
			Component(node, context);
		},
		SvelteSelf: Component,
		SvelteComponent: Component,
 
		// updates
		AssignmentExpression(node, { state, next }) {
			updates.push([state.scope, node.left]);
			next();
		},
 
		UpdateExpression(node, { state, next }) {
			updates.push([state.scope, /** @type {Identifier | MemberExpression} */ (node.argument)]);
			next();
		},
 
		ImportDeclaration(node, { state }) {
			for (const specifier of node.specifiers) {
				state.scope.declare(specifier.local, 'normal', 'import', node);
			}
		},
 
		FunctionExpression(node, { state, next }) {
			const scope = state.scope.child();
			scopes.set(node, scope);
 
			if (node.id) scope.declare(node.id, 'normal', 'function');
 
			add_params(scope, node.params);
			next({ scope });
		},
 
		FunctionDeclaration(node, { state, next }) {
			if (node.id) state.scope.declare(node.id, 'normal', 'function', node);
 
			const scope = state.scope.child();
			scopes.set(node, scope);
 
			add_params(scope, node.params);
			next({ scope });
		},
 
		ArrowFunctionExpression(node, { state, next }) {
			const scope = state.scope.child();
			scopes.set(node, scope);
 
			add_params(scope, node.params);
			next({ scope });
		},
 
		ForStatement: create_block_scope,
		ForInStatement: create_block_scope,
		ForOfStatement: create_block_scope,
		SwitchStatement: create_block_scope,
		BlockStatement(node, context) {
			const parent = context.path.at(-1);
			if (
				parent?.type === 'FunctionDeclaration' ||
				parent?.type === 'FunctionExpression' ||
				parent?.type === 'ArrowFunctionExpression'
			) {
				// We already created a new scope for the function
				context.next();
			} else {
				create_block_scope(node, context);
			}
		},
 
		ClassDeclaration(node, { state, next }) {
			if (node.id) state.scope.declare(node.id, 'normal', 'let', node);
			next();
		},
 
		VariableDeclaration(node, { state, path, next }) {
			const is_parent_const_tag = path.at(-1)?.type === 'ConstTag';
			for (const declarator of node.declarations) {
				/** @type {Binding[]} */
				const bindings = [];
 
				state.scope.declarators.set(declarator, bindings);
 
				for (const id of extract_identifiers(declarator.id)) {
					const binding = state.scope.declare(
						id,
						is_parent_const_tag ? 'template' : 'normal',
						node.kind,
						declarator.init
					);
					bindings.push(binding);
				}
			}
 
			next();
		},
 
		CatchClause(node, { state, next }) {
			if (node.param) {
				const scope = state.scope.child(true);
				scopes.set(node, scope);
 
				for (const id of extract_identifiers(node.param)) {
					scope.declare(id, 'normal', 'let');
				}
 
				next({ scope });
			} else {
				next();
			}
		},
 
		EachBlock(node, { state, visit }) {
			visit(node.expression);
 
			// context and children are a new scope
			const scope = state.scope.child();
			scopes.set(node, scope);
 
			// declarations
			for (const id of extract_identifiers(node.context)) {
				const binding = scope.declare(id, 'each', 'const');
 
				let inside_rest = false;
				let is_rest_id = false;
				walk(node.context, null, {
					Identifier(node) {
						if (inside_rest && node === id) {
							is_rest_id = true;
						}
					},
					RestElement(_, { next }) {
						const prev = inside_rest;
						inside_rest = true;
						next();
						inside_rest = prev;
					}
				});
 
				binding.metadata = { inside_rest: is_rest_id };
			}
 
			// Visit to pick up references from default initializers
			visit(node.context, { scope });
 
			if (node.index) {
				const is_keyed =
					node.key &&
					(node.key.type !== 'Identifier' || !node.index || node.key.name !== node.index);
				scope.declare(b.id(node.index), is_keyed ? 'template' : 'normal', 'const', node);
			}
			if (node.key) visit(node.key, { scope });
 
			// children
			for (const child of node.body.nodes) {
				visit(child, { scope });
			}
			if (node.fallback) visit(node.fallback, { scope });
 
			// Check if inner scope shadows something from outer scope.
			// This is necessary because we need access to the array expression of the each block
			// in the inner scope if bindings are used, in order to invalidate the array.
			let needs_array_deduplication = false;
			for (const [name] of scope.declarations) {
				if (state.scope.get(name) !== null) {
					needs_array_deduplication = true;
				}
			}
 
			node.metadata = {
				expression: create_expression_metadata(),
				keyed: false,
				contains_group_binding: false,
				array_name: needs_array_deduplication ? state.scope.root.unique('$$array') : null,
				index: scope.root.unique('$$index'),
				declarations: scope.declarations,
				is_controlled: false
			};
		},
 
		AwaitBlock(node, context) {
			context.visit(node.expression);
 
			if (node.pending) {
				context.visit(node.pending);
			}
 
			if (node.then) {
				context.visit(node.then);
				if (node.value) {
					const then_scope = /** @type {Scope} */ (scopes.get(node.then));
					const value_scope = context.state.scope.child();
					scopes.set(node.value, value_scope);
					context.visit(node.value, { scope: value_scope });
					for (const id of extract_identifiers(node.value)) {
						then_scope.declare(id, 'template', 'const');
						value_scope.declare(id, 'normal', 'const');
					}
				}
			}
 
			if (node.catch) {
				context.visit(node.catch);
				if (node.error) {
					const catch_scope = /** @type {Scope} */ (scopes.get(node.catch));
					const error_scope = context.state.scope.child();
					scopes.set(node.error, error_scope);
					context.visit(node.error, { scope: error_scope });
					for (const id of extract_identifiers(node.error)) {
						catch_scope.declare(id, 'template', 'const');
						error_scope.declare(id, 'normal', 'const');
					}
				}
			}
		},
 
		SnippetBlock(node, context) {
			const state = context.state;
			// Special-case for root-level snippets: they become part of the instance scope
			const is_top_level = !context.path.at(-2);
			let scope = state.scope;
			if (is_top_level) {
				scope = /** @type {Scope} */ (parent);
			}
			scope.declare(node.expression, 'normal', 'function', node.expression);
 
			const child_scope = state.scope.child();
			scopes.set(node, child_scope);
 
			for (const param of node.parameters) {
				for (const id of extract_identifiers(param)) {
					child_scope.declare(id, 'snippet', 'let');
				}
			}
 
			context.next({ scope: child_scope });
		},
 
		Fragment: (node, context) => {
			const scope = context.state.scope.child(node.metadata.transparent);
			scopes.set(node, scope);
			context.next({ scope });
		},
 
		BindDirective(node, context) {
			updates.push([
				context.state.scope,
				/** @type {Identifier | MemberExpression} */ (node.expression)
			]);
			context.next();
		},
 
		TransitionDirective: SvelteDirective,
		AnimateDirective: SvelteDirective,
		UseDirective: SvelteDirective,
		// using it's own function instead of `SvelteDirective` because
		// StyleDirective doesn't have expressions and are generally already
		// handled by `Identifier`. This is the special case for the shorthand
		// eg <button style:height /> where the variable has the same name of
		// the css property
		StyleDirective(node, { path, state, next }) {
			if (node.value === true) {
				state.scope.reference(b.id(node.name), path.concat(node));
			}
			next();
		}
 
		// TODO others
	});
 
	for (const id of possible_implicit_declarations) {
		const binding = scope.get(id.name);
		if (binding) continue; // TODO can also be legacy_reactive if declared outside of reactive statement
 
		scope.declare(id, 'legacy_reactive', 'let');
	}
 
	// we do this after the fact, so that we don't need to worry
	// about encountering references before their declarations
	for (const [scope, { node, path }] of references) {
		scope.reference(node, path);
	}
 
	for (const [scope, node] of updates) {
		for (const expression of unwrap_pattern(node)) {
			const left = object(expression);
			const binding = left && scope.get(left.name);
 
			if (binding !== null && left !== binding.node) {
				binding.updated = true;
 
				if (left === expression) {
					binding.reassigned = true;
				} else {
					binding.mutated = true;
				}
			}
		}
	}
 
	return {
		scope,
		scopes
	};
}
 
/**
 * @template {{ scope: Scope, scopes: Map<SvelteNode, Scope> }} State
 * @param {SvelteNode} node
 * @param {Context<SvelteNode, State>} context
 */
export function set_scope(node, { next, state }) {
	const scope = state.scopes.get(node);
	next(scope !== undefined && scope !== state.scope ? { ...state, scope } : state);
}
 
/**
 * Returns the name of the rune if the given expression is a `CallExpression` using a rune.
 * @param {Node | AST.EachBlock | null | undefined} node
 * @param {Scope} scope
 */
export function get_rune(node, scope) {
	if (!node) return null;
	if (node.type !== 'CallExpression') return null;
 
	let n = node.callee;
 
	let joined = '';
 
	while (n.type === 'MemberExpression') {
		if (n.computed) return null;
		if (n.property.type !== 'Identifier') return null;
		joined = '.' + n.property.name + joined;
		n = n.object;
	}
 
	if (n.type === 'CallExpression' && n.callee.type === 'Identifier') {
		joined = '()' + joined;
		n = n.callee;
	}
 
	if (n.type !== 'Identifier') return null;
 
	joined = n.name + joined;
 
	if (!is_rune(joined)) return null;
 
	const binding = scope.get(n.name);
	if (binding !== null) return null; // rune name, but references a variable or store
 
	return joined;
}