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.

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

Use diagnostic IDs for Language Server Packages #117

Closed
mkevenaar opened this issue Feb 25, 2019 · 4 comments
Closed

Use diagnostic IDs for Language Server Packages #117

mkevenaar opened this issue Feb 25, 2019 · 4 comments
Assignees
Milestone

Comments

@mkevenaar
Copy link
Member

mkevenaar commented Feb 25, 2019

Relates to #70

I have found that the Diagnostic object can contain a DiagnosticCode object. Containing an integer or string value.

Looking at different other vscode packages they use something like [APPLICATION CODE][NUMBER] In our case that would be CHOCO####, so I think we could go down that road.

If we would go with the numbered version I think we should group them a bit.

I would suggest:
CHOCO0### for all Requirements
CHOCO1### for all Guidelines
CHOCO2### for all Suggestions
CHOCO3### for all Notes

Last three digits would be first come, first serve.

This way we can match these numbers client side and perhaps even use the "lightbulb" to have the user go to the package-validator wiki URL.

/cc: @gep13 @AdmiringWorm @steviecoaster

@AdmiringWorm
Copy link
Member

Not a bad idea IMO.

@gep13
Copy link
Member

gep13 commented Feb 26, 2019

@mkevenaar this makes sense to me!

My only "concern" is regarding potential for growth. Do we think that 100 is "enough" for each type? Should we make it CHOCO1###?

@mkevenaar
Copy link
Member Author

@gep13 fine by me, let's go with 3 digits. 1000 potential issues per type, ought to be enough for anybody!

@gep13
Copy link
Member

gep13 commented Feb 28, 2019

This is now being implemented. I have been updating the issue here:

https://github.com/gep13/chocolatey-vscode/issues/70

When the diagnostic code has been assigned to a rule.

@gep13 gep13 closed this as completed Feb 28, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants