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

Add support to avoid showing F1 help for TS diagnostics #64242

Merged
merged 1 commit into from
Sep 23, 2022

Conversation

mavasani
Copy link
Contributor

Fixes #64145

TS diagnostics do not help corresponding help links, so the default help navigation invokes F1 help for the diagnostic ID. F1 help returns 404 error code for all TS diagnostics, so they wish to avoid showing F1 help. This PR adds a special well-known custom tag to allow diagnostics to skip F1 help navigation.

Fixes dotnet#64145

TS diagnostics do not help corresponding help links, so the default help navigation invokes F1 help for the diagnostic ID. F1 help returns 404 error code for all TS diagnostics, so they wish to avoid showing F1 help. This PR adds a special well-known custom tag to allow diagnostics to skip F1 help navigation.
@mavasani mavasani requested a review from a team as a code owner September 23, 2022 12:03
@mavasani
Copy link
Contributor Author

@MariaSolOs

@mavasani mavasani merged commit 4cb208c into dotnet:main Sep 23, 2022
@mavasani mavasani deleted the SkipF1Help branch September 23, 2022 18:01
@ghost ghost added this to the Next milestone Sep 23, 2022
@MariaSolOs
Copy link
Contributor

@mavasani thanks a lot! Once this gets inserted we will add the tag to our TypeScript diagnostics.


namespace Microsoft.CodeAnalysis.ExternalAccess.VSTypeScript
{
internal static class VSTypeScriptWellKnownDiagnosticCustomTags
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I never remember the rules correctly, but introducing this new class means that we (TypeScript VS) will also need to bump our Roslyn version to access this tag? @mavasani

@Cosifne Cosifne modified the milestones: Next, 17.4 P3 Sep 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Invalid hyperlink in JavaScript diagnostics
4 participants