Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Warn when enum-related fields set without enum #195838

Merged
merged 2 commits into from
Oct 17, 2023
Merged

Warn when enum-related fields set without enum #195838

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8917bfc
Warn when enum-related fields set without enum
rzhao271 Oct 17, 2023
f89b87f
polish
rzhao271 Oct 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 6 additions & 2 deletions src/vs/workbench/services/preferences/common/preferencesModels.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -687,6 +687,10 @@ export class DefaultSettings extends Disposable {
}
}

if (!enumToUse && (prop.enumItemLabels || enumDescriptions || enumDescriptionsAreMarkdown)) {
console.error(`The setting ${key} has enum-related fields, but doesn't have an enum field. This setting may render improperly in the Settings editor.`);
}

result.push({
key,
value,
Expand All @@ -706,6 +710,7 @@ export class DefaultSettings extends Disposable {
enum: enumToUse,
enumDescriptions: enumDescriptions,
enumDescriptionsAreMarkdown: enumDescriptionsAreMarkdown,
enumItemLabels: prop.enumItemLabels,
uniqueItems: prop.uniqueItems,
tags: prop.tags,
disallowSyncIgnore: prop.disallowSyncIgnore,
Expand All @@ -714,7 +719,6 @@ export class DefaultSettings extends Disposable {
deprecationMessage: prop.markdownDeprecationMessage || prop.deprecationMessage,
deprecationMessageIsMarkdown: !!prop.markdownDeprecationMessage,
validator: createValidator(prop),
enumItemLabels: prop.enumItemLabels,
allKeysAreBoolean,
editPresentation: prop.editPresentation,
order: prop.order,
Expand Down Expand Up @@ -1058,7 +1062,7 @@ class SettingsContentBuilder {
setting.descriptionRanges.push({ startLineNumber: this.lineCountWithOffset, startColumn: this.lastLine.indexOf(line) + 1, endLineNumber: this.lineCountWithOffset, endColumn: this.lastLine.length });
}

if (setting.enumDescriptions && setting.enumDescriptions.some(desc => !!desc)) {
if (setting.enum && setting.enumDescriptions?.some(desc => !!desc)) {
setting.enumDescriptions.forEach((desc, i) => {
const displayEnum = escapeInvisibleChars(String(setting.enum![i]));
const line = desc ?
Expand Down