Marking IMarkdownString.value and isTrusted as readonly

mjbvz · mjbvz · commit 20654cccf104 · 2019-10-08T16:38:31.000-07:00
diff --git a/src/vs/base/common/htmlContent.ts b/src/vs/base/common/htmlContent.ts
@@ -7,40 +7,44 @@ import { equals } from 'vs/base/common/arrays';
 import { UriComponents } from 'vs/base/common/uri';
 
 export interface IMarkdownString {
-	value: string;
-	isTrusted?: boolean;
+	readonly value: string;
+	readonly isTrusted?: boolean;
 	uris?: { [href: string]: UriComponents };
 }
 
 export class MarkdownString implements IMarkdownString {
 
-	value: string;
-	isTrusted?: boolean;
+	private _value: string;
+	private _isTrusted: boolean;
 
-	constructor(value: string = '') {
-		this.value = value;
+	constructor(value: string = '', isTrusted = false) {
+		this._value = value;
+		this._isTrusted = isTrusted;
 	}
 
+	get value() { return this._value; }
+	get isTrusted() { return this._isTrusted; }
+
 	appendText(value: string): MarkdownString {
 		// escape markdown syntax tokens: http://daringfireball.net/projects/markdown/syntax#backslash
-		this.value += value
+		this._value += value
 			.replace(/[\\`*_{}[\]()#+\-.!]/g, '\\$&')
 			.replace('\n', '\n\n');
 
 		return this;
 	}
 
 	appendMarkdown(value: string): MarkdownString {
-		this.value += value;
+		this._value += value;
 		return this;
 	}
 
 	appendCodeblock(langId: string, code: string): MarkdownString {
-		this.value += '\n```';
-		this.value += langId;
-		this.value += '\n';
-		this.value += code;
-		this.value += '\n```\n';
+		this._value += '\n```';
+		this._value += langId;
+		this._value += '\n';
+		this._value += code;
+		this._value += '\n```\n';
 		return this;
 	}
 }
diff --git a/src/vs/editor/contrib/links/links.ts b/src/vs/editor/contrib/links/links.ts
@@ -44,8 +44,7 @@ function getHoverMessage(link: Link, useMetaKey: boolean): MarkdownString {
 			: nls.localize('links.navigate.kb.alt', "alt + click");
 
 	if (link.url) {
-		const hoverMessage = new MarkdownString().appendMarkdown(`[${label}](${link.url.toString()}) (${kb})`);
-		hoverMessage.isTrusted = true;
+		const hoverMessage = new MarkdownString('', true).appendMarkdown(`[${label}](${link.url.toString()}) (${kb})`);
 		return hoverMessage;
 	} else {
 		return new MarkdownString().appendText(`${label} (${kb})`);
diff --git a/src/vs/monaco.d.ts b/src/vs/monaco.d.ts
@@ -379,8 +379,8 @@ declare namespace monaco {
 	}
 
 	export interface IMarkdownString {
-		value: string;
-		isTrusted?: boolean;
+		readonly value: string;
+		readonly isTrusted?: boolean;
 		uris?: {
 			[href: string]: UriComponents;
 		};
diff --git a/src/vs/workbench/api/common/extHostTypeConverters.ts b/src/vs/workbench/api/common/extHostTypeConverters.ts
@@ -303,9 +303,7 @@ export namespace MarkdownString {
 	}
 
 	export function to(value: htmlContent.IMarkdownString): vscode.MarkdownString {
-		const ret = new htmlContent.MarkdownString(value.value);
-		ret.isTrusted = value.isTrusted;
-		return ret;
+		return new htmlContent.MarkdownString(value.value, value.isTrusted);
 	}
 
 	export function fromStrict(value: string | types.MarkdownString): undefined | string | htmlContent.IMarkdownString {

Original file line number	Diff line number	Diff line change
`@@ -303,9 +303,7 @@ export namespace MarkdownString {`
`303`	`303`	`}`
`304`	`304`
`305`	`305`	`export function to(value: htmlContent.IMarkdownString): vscode.MarkdownString {`
`306`		`- const ret = new htmlContent.MarkdownString(value.value);`
`307`		`- ret.isTrusted = value.isTrusted;`
`308`		`- return ret;`
	`306`	`+ return new htmlContent.MarkdownString(value.value, value.isTrusted);`
`309`	`307`	`}`
`310`	`308`
`311`	`309`	`export function fromStrict(value: string \| types.MarkdownString): undefined \| string \| htmlContent.IMarkdownString {`