Function logToUser

src/debug/dart_debug_impl.ts:1874–1921

(message: string, category?: string, colorText = (s: string) => s)

	// Logs a message back to the editor. Does not add its own newlines, you must
	// provide them!
	protected logToUser(message: string, category?: string, colorText = (s: string) => s) {

		// If we get a multi-line message that contains an error/stack trace, process each
		// line individually, so we can attach location metadata to individual lines.
		const isMultiLine = message.trimRight().includes("\n");
		if (isMultiLine && mayContainStackFrame(message)) {
			message.split("\n").forEach((line) => this.logToUser(`${line}\n`, category));
			return;
		}

		// Extract stack frames from the message so we can do nicer formatting of them.
		const frame = parseStackFrame(message);

		const output = new OutputEvent(`${applyColor(message, colorText)}`, category) as OutputEvent & DebugProtocol.OutputEvent;
		const mayBeAsyncMarker = (output.body.output.trim().startsWith("<async") && output.body.output.trim().endsWith(">"))
			|| (output.body.output.trim().startsWith("===== asynchronous gap ==="));

		// If the output line looks like a stack frame with users code, attempt to link it up to make
		// it clickable.
		if (frame) {
			let sourcePath: string | undefined = this.convertVMUriToSourcePath(frame.sourceUri);
			if (sourcePath && !path.isAbsolute(sourcePath) && this.cwd)
				sourcePath = path.join(this.cwd, sourcePath);
			const canShowSource = sourcePath && sourcePath !== frame.sourceUri && fs.existsSync(sourcePath);
			const shortName = this.formatUriForShortDisplay(frame.sourceUri);
			const source = canShowSource ? new Source(shortName, sourcePath, undefined, undefined, undefined) : undefined;

			let text = message.trim();
			if (source) {
				output.body.source = source;
				output.body.line = frame.line || 1;
				output.body.column = frame.col || 1;
				// Replace the output to only the text part to avoid the duplicated uri.
				text = frame.text;
			}

			// Colour based on whether it's framework code or not.
			const isExternalCode = this.isSdkLibrary(frame.sourceUri) || this.isExternalLibrary(frame.sourceUri);

			// Fade out any stack frames for external code.
			const colouredText = frame.isStackFrame && isExternalCode ? applyColor(text, faint) : text;
			output.body.output = `${colouredText}\n`;
		} else if (mayBeAsyncMarker) {
			output.body.output = `${applyColor(output.body.output.trimRight(), faint)}\n`;
		}

		this.sendEvent(output);
	}
}

export interface InstanceWithEvaluateName extends VMInstanceRef {