doNotSuggest for values

[liquidaty]

In the following JSON Schema type:

{
  type: "string",
  enum: ["a","b"],
  doNotSuggest: true
}

the doNotSuggest property is ignored (but should not be-- right?)

To fix this, addSchemaValueCompletions(), addEnumValueCompletions() and/or other functions in src/services/jsonCompletion.ts should be modified e.g. change if (typeof schema === "object") to if (typeof schema === "object" && !schema.doNotSuggest)

For context, the reason I came across this is that I wanted to display a list of labels that is different from my list of enum values, while still retaining enum-value-based validation. I was not able to find a straightforward way to do this so changed my original enum schema to an allOf schema that contained my original enum schema with doNotSuggest added, together with a { type: string, defaultSnippets: [...]} schema, the goal being for validation to use solely the enum schema and auto-complete to use solely the defaultSnippets schema.

It would be much easier if there was support for something like enumLabels which could sit alongside enum... using the currently-supported features, any suggestions for a better solution would be appreciated

[aeschli]

The doNotSuggest is currently only used to hide property names.

E.g.

{
	type: 'object',
	properties: {
		name: {
			type: 'string',
		},
		codename: {
        		enum: ['john', 'jack'],
        		doNotSuggest: true
		}
}

That means for this object you only get 'name', but not 'codename' suggested. However, codename is a valid property, and for it you will get 'john' and 'jack' suggested.

So doNotSuggest is for keys, not values.
We can't change the behavior now to also affect values as it would be ambiguous.

[liquidaty]

Hm ok. In that case if I wanted to display a list of labels that is different from my list of enum values, is there any solution currently supported?

[aeschli]

You can add details (added this milesstone) and documentation text. But the label is what's inserted, so we want to show that.

[liquidaty]

the label is what's inserted, so we want to show that

Where does that principle come from? If that was true it defeats the purpose of having a separate insertText vs label property. Clearly the monaco development team has (rightfully!) contemplated the need at times to show something that is not necessarily the same as what is inserted. This happens all the time in UIs.

The problem with details and documentation is that they do not show up in the drop-down list unless the user knows to do some other action like click some arrow (separately for every single suggestion! ugh) or hover over the value after the choice was already made.

Is there any way then, without changing the label, that at the time that the list of enumeration suggestions is displayed, the user can also see additional information to inform the choice before it is made, without requiring the user to take additional action?

[aeschli]

Sorry, I'm not aware of a way different than details and documentation to do that.