feat(doctor): add in explanations to the json doctor output #3494
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This is a follow-up to the work done in scalameta#3426. This extracts out the explanation logic into `DoctorExplanation` ADT to so that we can re-use it both for html and for json. The old output of the json doctor was: ```json { "title": "Metals Doctor", "headerText": "Build server currently being used is Bloop v1.4.11.\n\nThese are the installed build targets for this workspace. One build target corresponds to one classpath. For example, normally one sbt project maps to two build targets: main and test.", "version": 1, "targets": [ { "buildTarget": "Sanity", "targetType": "Scala 2.12.15", "diagnostics": "✅ ", "interactive": "✅ ", "semanticdb": "✅ ", "debugging": "✅ ", "java": "✅ ", "recommendation": "" }, { "buildTarget": "Sanity.test", "targetType": "Scala 2.12.15", "diagnostics": "✅ ", "interactive": "✅ ", "semanticdb": "✅ ", "debugging": "✅ ", "java": "✅ ", "recommendation": "" } ] } ```` Where now the new format for the same build would be: ```json { "title": "Metals Doctor", "headerText": "Build server currently being used is Bloop v1.4.11.\n\nThese are the installed build targets for this workspace. One build target corresponds to one classpath. For example, normally one sbt project maps to two build targets: main and test.", "version": 1, "targets": [ { "buildTarget": "Sanity", "targetType": "Scala 2.12.15", "diagnostics": "✅ ", "interactive": "✅ ", "semanticdb": "✅ ", "debugging": "✅ ", "java": "✅ ", "recommendation": "" }, { "buildTarget": "Sanity.test", "targetType": "Scala 2.12.15", "diagnostics": "✅ ", "interactive": "✅ ", "semanticdb": "✅ ", "debugging": "✅ ", "java": "✅ ", "recommendation": "" } ], "explanations": [ { "title": "Diagnostics:", "explanations": [ "✅ - diagnostics correctly being reported by the build server" ] }, { "title": "Interactive features (completions, hover):", "explanations": [ "✅ - supported Scala version" ] }, { "title": "Semanticdb features (references, renames, go to implementation):", "explanations": [ "✅ - build tool automatically creating needed semanticdb files" ] }, { "title": "Debugging (run/test, breakpoints, evaluation):", "explanations": [ "✅ - users can run or test their code with debugging capabilities" ] }, { "title": "Java Support:", "explanations": [ "✅ - working non-interactive features (references, rename etc.)" ] } ] } ```
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a follow-up to the work done in
#3426.
This extracts out the explanation logic into the
DoctorExplanationADTso that we can re-use it both for html and for json.
The old output of the json doctor was:
{ "title": "Metals Doctor", "headerText": "Build server currently being used is Bloop v1.4.11.\n\nThese are the installed build targets for this workspace. One build target corresponds to one classpath. For example, normally one sbt project maps to two build targets: main and test.", "version": 1, "targets": [ { "buildTarget": "Sanity", "targetType": "Scala 2.12.15", "diagnostics": "✅ ", "interactive": "✅ ", "semanticdb": "✅ ", "debugging": "✅ ", "java": "✅ ", "recommendation": "" }, { "buildTarget": "Sanity.test", "targetType": "Scala 2.12.15", "diagnostics": "✅ ", "interactive": "✅ ", "semanticdb": "✅ ", "debugging": "✅ ", "java": "✅ ", "recommendation": "" } ] }Where now the new format for the same build would be:
{ "title": "Metals Doctor", "headerText": "Build server currently being used is Bloop v1.4.11.\n\nThese are the installed build targets for this workspace. One build target corresponds to one classpath. For example, normally one sbt project maps to two build targets: main and test.", "version": 1, "targets": [ { "buildTarget": "Sanity", "targetType": "Scala 2.12.15", "diagnostics": "✅ ", "interactive": "✅ ", "semanticdb": "✅ ", "debugging": "✅ ", "java": "✅ ", "recommendation": "" }, { "buildTarget": "Sanity.test", "targetType": "Scala 2.12.15", "diagnostics": "✅ ", "interactive": "✅ ", "semanticdb": "✅ ", "debugging": "✅ ", "java": "✅ ", "recommendation": "" } ], "explanations": [ { "title": "Diagnostics:", "explanations": [ "✅ - diagnostics correctly being reported by the build server" ] }, { "title": "Interactive features (completions, hover):", "explanations": [ "✅ - supported Scala version" ] }, { "title": "Semanticdb features (references, renames, go to implementation):", "explanations": [ "✅ - build tool automatically creating needed semanticdb files" ] }, { "title": "Debugging (run/test, breakpoints, evaluation):", "explanations": [ "✅ - users can run or test their code with debugging capabilities" ] }, { "title": "Java Support:", "explanations": [ "✅ - working non-interactive features (references, rename etc.)" ] } ] }