[typespec-vscode] expose linter rule documentation url in codefixes #5131
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
1、Add a URL to the rule file to point to the relevant document.(for testing)
compiler：
1、A new codefix file has been added to handle the Linter Rule doc URL.
2、Added OPEN_RULE_DOC command type.
3、If the diagnostic URL is not empty, add a codefix and process the send request in the server file.
typespec-vscode:
1、Define the request and open the received URL document.
samples:
1、Add lint-related configurations to the yaml configuration file to define a lowercase model type in the tsp file for functional testing.
Such as "model foo {}".
mzhongl524
requested review from
RodgeFu,
bterlson,
markcowl,
allenjzhang and
timotheeguerin
as code owners
|
All changed packages have been documented.
|
|
You can try these changes here
|
RodgeFu
reviewed
Nov 16, 2024
packages/compiler/src/core/compiler-code-fixes/show-linter-rule-doc-url.codefix.ts
Outdated
Show resolved
Hide resolved
timotheeguerin
requested changes
Nov 16, 2024
packages/compiler/src/core/compiler-code-fixes/show-linter-rule-doc-url.codefix.ts
Outdated
Show resolved
Hide resolved
.chronus/changes/show-linter-rule-url-in-codefix-2024-10-15-8-25-38.md
Outdated
Show resolved
Hide resolved
RodgeFu
reviewed
Nov 16, 2024
RodgeFu
reviewed
Nov 16, 2024
RodgeFu
reviewed
Nov 16, 2024
…efix file, and restore the other codes to the original state.
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
RodgeFu
reviewed
Nov 18, 2024
RodgeFu
reviewed
Nov 18, 2024
RodgeFu
reviewed
Nov 18, 2024
…fix, and then define the command to open the URL
RodgeFu
reviewed
Nov 20, 2024
RodgeFu
reviewed
Nov 20, 2024
RodgeFu
reviewed
Nov 20, 2024
RodgeFu
reviewed
Nov 20, 2024
RodgeFu
reviewed
Nov 20, 2024
RodgeFu
reviewed
Nov 20, 2024
RodgeFu
reviewed
Nov 20, 2024
RodgeFu
reviewed
Nov 21, 2024
RodgeFu
reviewed
Nov 21, 2024
RodgeFu
reviewed
Nov 21, 2024
mzhongl524
changed the title
RodgeFu
changed the title
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.
Modifications
best-practices:
1、Add a URL to the rule file to point to the relevant document.(for testing)
compiler：
1、A new codefix file has been added to handle the Linter Rule doc URL. 2、Added OPEN_RULE_DOC command type.
3、If the diagnostic URL is not empty, add a codefix and process the send request in the server file.
typespec-vscode:
1、Define the request and open the received URL document.
samples:
1、Add lint-related configurations to the yaml configuration file to define a lowercase model type in the tsp file for functional testing. Such as "model foo {}".
Related issues：#3043