MODiX icon indicating copy to clipboard operation
MODiX copied to clipboard

Command to fetch descriptions of errors, warnings, and suggestions

Open just-ero opened this issue 2 years ago • 1 comments

Description

It would be great if we had a command to fetch the descriptions of given error or warning messages such that when a user only provides the code, a description can still easily be retrieved.

Problems

As far as I can tell, there is absolutely no rhyme or reason to the API for these codes. It is possible to fetch their description from the Roslyn source code however (https://github.com/thomaslevesque/GenerateCSharpErrors/blob/master/CSharpErrorsAndWarnings.md), so perhaps a file could be kept, which frequently syncs with the Roslyn source code to generate human-readable messages to retrieve.


Here are some resources on Microsoft Learn pages which feature most of the relevant codes:

  • https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/compiler-messages
  • https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/style-rules

just-ero avatar Aug 01 '23 23:08 just-ero

We have discussed this. This seems like a worthwhile feature to implement and maintain going forward.

Thank you for the linked repository.

The proposed implementation:

  • Fork thomaslevesque/GenerateCSharpErrors
  • Generate a error code definition file with said fork, which may take the form of a dictionary
  • Include generated file as part of this MODiX repository
  • Add a command lookup {CODE} and look up relevant codes in full or partially
  • Return the relevant error messages, level, description in an embed to the invoker

patrickklaeren avatar Mar 30 '24 10:03 patrickklaeren