Microsoft/vscode
1
0
Fork 0
mirror of https://github.com/microsoft/vscode.git synced 2026-04-02 08:15:56 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #297570 from microsoft/copilot/fix-tooltip-markdown-syntax

Browse Source 
Fix: Strip markdown syntax from deprecated setting diagnostic messages
This commit is contained in:
Matt Bierner
2026-03-10 11:34:27 -07:00
committed by GitHub
parent 01eb53f0f9 34cee220ca
commit d42b123a3c
2 changed files with 21 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
src/vs/workbench/services/configuration/browser/configurationService.ts
View File

@@ -47,6 +47,8 @@ import { IBrowserWorkbenchEnvironmentService } from '../../environment/browser/e
import { workbenchConfigurationNodeBase } from '../../../common/configuration.js';
import { mainWindow } from '../../../../base/browser/window.js';
import { runWhenWindowIdle } from '../../../../base/browser/dom.js';
import { renderAsPlaintext } from '../../../../base/browser/markdownRenderer.js';
import { fixSettingLinks } from '../../preferences/common/preferencesModels.js';
function getLocalUserConfigurationScopes(userDataProfile: IUserDataProfile, hasRemote: boolean): ConfigurationScope[] | undefined {
const isDefaultProfile = userDataProfile.isDefault || userDataProfile.useDefaultFlags?.settings;
@@ -1176,6 +1178,15 @@ class RegisterConfigurationSchemasContribution extends Disposable implements IWo
}
private registerConfigurationSchemas(): void {
// Ensure deprecationMessage is plain text for properties where it was derived from
// markdownDeprecationMessage, since the JSON editor diagnostics don't support markdown.
for (const key of Object.keys(allSettings.properties)) {
const prop = allSettings.properties[key];
if (prop.markdownDeprecationMessage && prop.deprecationMessage === prop.markdownDeprecationMessage) {
prop.deprecationMessage = renderAsPlaintext({ value: fixSettingLinks(prop.markdownDeprecationMessage) });
}
}
const allSettingsSchema: IJSONSchema = {
properties: allSettings.properties,
patternProperties: allSettings.patternProperties,

14
src/vs/workbench/services/preferences/common/preferencesModels.ts
View File

@@ -28,6 +28,14 @@ import { isString } from '../../../../base/common/types.js';
export const nullRange: IRange = { startLineNumber: -1, startColumn: -1, endLineNumber: -1, endColumn: -1 };
function isNullRange(range: IRange): boolean { return range.startLineNumber === -1 && range.startColumn === -1 && range.endLineNumber === -1 && range.endColumn === -1; }
/**
* Strips VS Code's custom `#settingId#` link syntax from a markdown string so the setting key
* remains as inline code (e.g. `` `settingId` ``). Useful for contexts that don't render markdown links.
*/
export function fixSettingLinks(text: string): string {
return text.replace(/`#([^#`]*)#`/g, (_, settingName) => `\`${settingName}\``);
}
abstract class AbstractSettingsModel extends EditorModel {
protected _currentResultGroups = new Map<string, ISearchResultGroup>();
@@ -1072,13 +1080,11 @@ class SettingsContentBuilder {
}
private pushSettingDescription(setting: ISetting, indent: string): void {
const fixSettingLink = (line: string) => line.replace(/`#(.*)#`/g, (match, settingName) => `\`${settingName}\``);
setting.descriptionRanges = [];
const descriptionPreValue = indent + '// ';
const deprecationMessageLines = setting.deprecationMessage?.split(/\n/g) ?? [];
for (let line of [...deprecationMessageLines, ...setting.description]) {
line = fixSettingLink(line);
line = fixSettingLinks(line);
this._contentByLines.push(descriptionPreValue + line);
setting.descriptionRanges.push({ startLineNumber: this.lineCountWithOffset, startColumn: this.lastLine.indexOf(line) + 1, endLineNumber: this.lineCountWithOffset, endColumn: this.lastLine.length });
@@ -1088,7 +1094,7 @@ class SettingsContentBuilder {
setting.enumDescriptions.forEach((desc, i) => {
const displayEnum = escapeInvisibleChars(String(setting.enum![i]));
const line = desc ?
`${displayEnum}: ${fixSettingLink(desc)}` :
`${displayEnum}: ${fixSettingLinks(desc)}` :
displayEnum;
const lines = line.split(/\n/g);