All files / src/compiler/phases/3-transform utils.js

99.33% Statements 301/303
96.92% Branches 126/130
100% Functions 9/9
99.33% Lines 298/300

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 3012x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 575x 575x 575x 503x 575x 72x 72x 503x 503x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 14913x 14913x 14913x 14913x 14913x 14913x 14913x 14913x 14913x 14913x 14913x 14913x 14913x 14913x 35662x 71x 71x 35591x 35591x 35639x 35662x 35662x 35662x 35662x 35662x 35662x 35213x 35662x 448x 448x 35662x 35143x 35143x 35662x 14913x 14913x 112x 112x 14801x 14801x 14801x 14913x 7839x 7839x 14801x 14913x 3137x 3137x 3137x 14801x 14913x 3762x 3762x 14801x 14913x 2270x 2270x 2270x 14801x 14801x 14913x 14913x 14913x 14547x 6991x 6991x 6991x 6991x 6991x 6991x 6991x 6991x 14913x 14913x 14913x 14913x 14913x 14913x 14913x 14913x 14913x 14913x 23429x 23429x 23429x 23429x 23429x 7686x 6488x 6488x 6488x 6488x 6488x 6488x 6488x 6488x 6488x 6488x 6488x 7686x 5689x 5689x 5689x 7686x 7559x 7559x 23429x 15743x 15743x 23429x 14801x 14801x 14801x 2x 2x 2x 2x 2x 2x 2x 2x 7668x 7667x     7667x 7667x 130x 12x 12x 130x 130x 7537x 7537x 7537x 7667x 7667x 7667x 7667x 7667x 7667x 2265x 7667x 5360x 5360x 3796x 3796x 5360x 7667x 3742x 3742x 3742x 2x 2x 2x 2x 2x 2x 2x 2x 5360x 5360x 5360x 5360x 5360x 5360x 3814x 3708x 3708x 3814x 92x 92x 5360x 5360x 5360x 11480x 11480x 11480x 11480x 11480x 16270x 16270x 16270x 16270x 16270x 16270x 16270x 16270x 10446x 16270x 12782x 12782x 11480x 11480x 11480x 11480x 6958x 330x 330x 6958x 11480x 11480x 11480x 11480x 11480x 1652x 1652x 1652x 2x 2x 2x 2x 2x 2x 2x 2x 7375x 1x 1x 7374x 7374x 10x 10x 7364x 7374x 178x 178x 7186x 7375x 7375x 2x 2x 2x 2x 2x 2x 2x 22x 22x 22x 22x 22x 22x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 22x 18x 18x 18x 18x 18x 22x  
import {
	regex_ends_with_whitespaces,
	regex_not_whitespace,
	regex_starts_with_whitespaces
} from '../patterns.js';
import * as b from '../../utils/builders.js';
import { walk } from 'zimmerframe';
 
/**
 * @param {import('estree').Node} node
 * @returns {boolean}
 */
export function is_hoistable_function(node) {
	if (
		node.type === 'ArrowFunctionExpression' ||
		node.type === 'FunctionExpression' ||
		node.type === 'FunctionDeclaration'
	) {
		return node.metadata?.hoistable === true;
	}
	return false;
}
 
/**
 * Extract nodes that are hoisted and trim whitespace according to the following rules:
 * - trim leading and trailing whitespace, regardless of surroundings
 * - keep leading / trailing whitespace of inbetween text nodes,
 *   unless it's whitespace-only, in which case collapse to a single whitespace for all cases
 *   except when it's children of certain elements where we know ignore whitespace (like td/option/head),
 *   in which case we remove it entirely
 * @param {import('#compiler').SvelteNode} parent
 * @param {import('#compiler').SvelteNode[]} nodes
 * @param {import('#compiler').SvelteNode[]} path
 * @param {import('#compiler').Namespace} namespace
 * @param {boolean} preserve_whitespace
 * @param {boolean} preserve_comments
 */
export function clean_nodes(
	parent,
	nodes,
	path,
	namespace = 'html',
	preserve_whitespace,
	preserve_comments
) {
	/** @type {import('#compiler').SvelteNode[]} */
	const hoisted = [];
 
	/** @type {import('#compiler').SvelteNode[]} */
	const regular = [];
 
	for (const node of nodes) {
		if (node.type === 'Comment' && !preserve_comments) {
			continue;
		}
 
		if (
			node.type === 'ConstTag' ||
			node.type === 'DebugTag' ||
			node.type === 'SvelteBody' ||
			node.type === 'SvelteWindow' ||
			node.type === 'SvelteDocument' ||
			node.type === 'SvelteHead' ||
			node.type === 'TitleElement' ||
			node.type === 'SnippetBlock'
		) {
			// TODO others?
			hoisted.push(node);
		} else {
			regular.push(node);
		}
	}
 
	if (preserve_whitespace) {
		return { hoisted, trimmed: regular };
	}
 
	let first, last;
 
	while ((first = regular[0]) && first.type === 'Text' && !regex_not_whitespace.test(first.data)) {
		regular.shift();
	}
 
	if (first?.type === 'Text') {
		first.raw = first.raw.replace(regex_starts_with_whitespaces, '');
		first.data = first.data.replace(regex_starts_with_whitespaces, '');
	}
 
	while ((last = regular.at(-1)) && last.type === 'Text' && !regex_not_whitespace.test(last.data)) {
		regular.pop();
	}
 
	if (last?.type === 'Text') {
		last.raw = last.raw.replace(regex_ends_with_whitespaces, '');
		last.data = last.data.replace(regex_ends_with_whitespaces, '');
	}
 
	const can_remove_entirely =
		(namespace === 'svg' &&
			(parent.type !== 'RegularElement' || parent.name !== 'text') &&
			!path.some((n) => n.type === 'RegularElement' && n.name === 'text')) ||
		(parent.type === 'RegularElement' &&
			// TODO others?
			(parent.name === 'select' ||
				parent.name === 'tr' ||
				parent.name === 'table' ||
				parent.name === 'tbody' ||
				parent.name === 'thead' ||
				parent.name === 'tfoot' ||
				parent.name === 'colgroup' ||
				parent.name === 'datalist'));
 
	/** @type {import('#compiler').SvelteNode[]} */
	const trimmed = [];
 
	// Replace any whitespace between a text and non-text node with a single spaceand keep whitespace
	// as-is within text nodes, or between text nodes and expression tags (because in the end they count
	// as one text). This way whitespace is mostly preserved when using CSS with `white-space: pre-line`
	// and default slot content going into a pre tag (which we can't see).
	for (let i = 0; i < regular.length; i++) {
		const prev = regular[i - 1];
		const node = regular[i];
		const next = regular[i + 1];
 
		if (node.type === 'Text') {
			if (prev?.type !== 'ExpressionTag') {
				const prev_is_text_ending_with_whitespace =
					prev?.type === 'Text' && regex_ends_with_whitespaces.test(prev.data);
				node.data = node.data.replace(
					regex_starts_with_whitespaces,
					prev_is_text_ending_with_whitespace ? '' : ' '
				);
				node.raw = node.raw.replace(
					regex_starts_with_whitespaces,
					prev_is_text_ending_with_whitespace ? '' : ' '
				);
			}
			if (next?.type !== 'ExpressionTag') {
				node.data = node.data.replace(regex_ends_with_whitespaces, ' ');
				node.raw = node.raw.replace(regex_ends_with_whitespaces, ' ');
			}
			if (node.data && (node.data !== ' ' || !can_remove_entirely)) {
				trimmed.push(node);
			}
		} else {
			trimmed.push(node);
		}
	}
 
	return { hoisted, trimmed };
}
 
/**
 * Infers the namespace for the children of a node that should be used when creating the `$.template(...)`.
 * @param {import('#compiler').Namespace} namespace
 * @param {import('#compiler').SvelteNode} parent
 * @param {import('#compiler').SvelteNode[]} nodes
 */
export function infer_namespace(namespace, parent, nodes) {
	if (namespace !== 'foreign') {
		if (parent.type === 'RegularElement' && parent.name === 'foreignObject') {
			return 'html';
		}
 
		if (parent.type === 'RegularElement' || parent.type === 'SvelteElement') {
			if (parent.metadata.svg) {
				return 'svg';
			}
			return parent.metadata.mathml ? 'mathml' : 'html';
		}
 
		// Re-evaluate the namespace inside slot nodes that reset the namespace
		if (
			parent.type === 'Fragment' ||
			parent.type === 'Root' ||
			parent.type === 'Component' ||
			parent.type === 'SvelteComponent' ||
			parent.type === 'SvelteFragment' ||
			parent.type === 'SnippetBlock' ||
			parent.type === 'SlotElement'
		) {
			const new_namespace = check_nodes_for_namespace(nodes, 'keep');
			if (new_namespace !== 'keep' && new_namespace !== 'maybe_html') {
				return new_namespace;
			}
		}
	}
 
	return namespace;
}
 
/**
 * Heuristic: Keep current namespace, unless we find a regular element,
 * in which case we always want html, or we only find svg nodes,
 * in which case we assume svg.
 * @param {import('#compiler').SvelteNode[]} nodes
 * @param {import('#compiler').Namespace | 'keep' | 'maybe_html'} namespace
 */
function check_nodes_for_namespace(nodes, namespace) {
	/**
	 * @param {import('#compiler').SvelteElement | import('#compiler').RegularElement} node}
	 * @param {{stop: () => void}} context
	 */
	const RegularElement = (node, { stop }) => {
		if (!node.metadata.svg && !node.metadata.mathml) {
			namespace = 'html';
			stop();
		} else if (namespace === 'keep') {
			namespace = node.metadata.svg ? 'svg' : 'mathml';
		}
	};
 
	for (const node of nodes) {
		walk(
			node,
			{},
			{
				_(node, { next }) {
					if (
						node.type === 'EachBlock' ||
						node.type === 'IfBlock' ||
						node.type === 'AwaitBlock' ||
						node.type === 'Fragment' ||
						node.type === 'KeyBlock' ||
						node.type === 'RegularElement' ||
						node.type === 'SvelteElement' ||
						node.type === 'Text'
					) {
						next();
					}
				},
				SvelteElement: RegularElement,
				RegularElement,
				Text(node) {
					if (node.data.trim() !== '') {
						namespace = 'maybe_html';
					}
				}
			}
		);
 
		if (namespace === 'html') return namespace;
	}
 
	return namespace;
}
 
/**
 * Determines the namespace the children of this node are in.
 * @param {import('#compiler').RegularElement | import('#compiler').SvelteElement} node
 * @param {import('#compiler').Namespace} namespace
 * @returns {import('#compiler').Namespace}
 */
export function determine_namespace_for_children(node, namespace) {
	if (namespace === 'foreign') {
		return namespace;
	}
 
	if (node.name === 'foreignObject') {
		return 'html';
	}
 
	if (node.metadata.svg) {
		return 'svg';
	}
 
	return node.metadata.mathml ? 'mathml' : 'html';
}
 
/**
 * @template {import('./types.js').TransformState} T
 * @param {import('estree').CallExpression} node
 * @param {import('zimmerframe').Context<any, T>} context
 */
export function transform_inspect_rune(node, context) {
	const { state, visit } = context;
	const as_fn = state.options.generate === 'client';
 
	if (!state.options.dev) return b.unary('void', b.literal(0));
 
	if (node.callee.type === 'MemberExpression') {
		const raw_inspect_args = /** @type {import('estree').CallExpression} */ (node.callee.object)
			.arguments;
		const inspect_args =
			/** @type {Array<import('estree').Expression>} */
			(raw_inspect_args.map((arg) => visit(arg)));
		const with_arg = /** @type {import('estree').Expression} */ (visit(node.arguments[0]));
 
		return b.call(
			'$.inspect',
			as_fn ? b.thunk(b.array(inspect_args)) : b.array(inspect_args),
			with_arg
		);
	} else {
		const arg = node.arguments.map(
			(arg) => /** @type {import('estree').Expression} */ (visit(arg))
		);
		return b.call('$.inspect', as_fn ? b.thunk(b.array(arg)) : b.array(arg));
	}
}