Is your enhancement related to a problem? Please describe. I maint

Show enum values on hover about yaml-language-server HOT 1 CLOSED

twelvelabs commented on June 16, 2024

Show enum values on hover

from yaml-language-server.

Comments (1)

twelvelabs commented on June 16, 2024

Digging through the code, it looks like there is some logic to show enums

yaml-language-server/src/languageservice/services/yamlHover.ts

Lines 124 to 137 in ed03cbf

 if (s.schema.enum) { 

 const idx = s.schema.enum.indexOf(getNodeValue(node)); 

 if (s.schema.markdownEnumDescriptions) { 

 markdownEnumValueDescription = s.schema.markdownEnumDescriptions[idx]; 

 } else if (s.schema.enumDescriptions) { 

 markdownEnumValueDescription = toMarkdown(s.schema.enumDescriptions[idx]); 

 } 

 if (markdownEnumValueDescription) { 

 enumValue = s.schema.enum[idx]; 

 if (typeof enumValue !== 'string') { 

 enumValue = JSON.stringify(enumValue); 

 } 

 } 

 }

But:

It requires the use of some non-standard properties (at least according to the JSON Schema spec): markdownEnumDescription, enumDescriptions.
It only shows info for the currently selected enum - not the full list of available options.

What do y'all think about changing the behavior so that:

It displays all enum options (maybe truncated to some upper bound w/ a "... plus N more" note).
Keep the *Descriptions logic, but fall back to just showing the enum sans-description if no descriptions are present.

from yaml-language-server.

Show enum values on hover about yaml-language-server HOT 1 CLOSED

Comments (1)

Related Issues (20)

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent

	if (s.schema.enum) {
	const idx = s.schema.enum.indexOf(getNodeValue(node));
	if (s.schema.markdownEnumDescriptions) {
	markdownEnumValueDescription = s.schema.markdownEnumDescriptions[idx];
	} else if (s.schema.enumDescriptions) {
	markdownEnumValueDescription = toMarkdown(s.schema.enumDescriptions[idx]);
	}
	if (markdownEnumValueDescription) {
	enumValue = s.schema.enum[idx];
	if (typeof enumValue !== 'string') {
	enumValue = JSON.stringify(enumValue);
	}
	}
	}