[typespec] expose linter rule documentation url in codefixes #5131

mzhongl524 · 2024-11-15T08:23:46Z

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

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 {}".

azure-sdk · 2024-11-15T08:25:39Z

❌ There is undocummented changes. Run chronus add to add a changeset or click here.

The following packages have changes but are not documented.

❌typespec-vscode

Show changes

azure-sdk · 2024-11-15T08:36:55Z

You can try these changes here

🛝 Playground	🌐 Website	📚 Next docs

packages/compiler/src/core/compiler-code-fixes/show-linter-rule-doc-url.codefix.ts

timotheeguerin · 2024-11-16T02:51:15Z

packages/compiler/src/core/compiler-code-fixes/show-linter-rule-doc-url.codefix.ts

@@ -0,0 +1,10 @@
+import { defineCodeFix } from "../diagnostics.js";
+
+export function createShowLinterRuleDocUrlCodeFix(docUrl: string) {


This shouldn't be a code fix. It doesn't actually fix anything. It would break a --fix-all flag. This is only relevant to ide and so just need to be injected when creating the Vscode actions.
We are already including the doc url in many other place this is just another(including already in the reported diagnostic to the ide - clickable link)

timotheeguerin · 2024-11-16T02:52:22Z

.chronus/changes/show-linter-rule-url-in-codefix-2024-10-15-8-25-38.md

+  - typespec-vscode
+---
+
+[typespec] expose linter rule documentation url in codefixes


Remove the bracket scope. Those changelog are already scoped to the packages above.
And update accordingly with my other comment

packages/compiler/src/core/program.ts

packages/compiler/src/core/types.ts

packages/compiler/src/server/server.ts

…efix file, and restore the other codes to the original state.

packages/compiler/src/server/serverlib.ts

RodgeFu · 2024-11-18T10:03:08Z

packages/compiler/src/server/serverlib.ts

+      ) {
+        mutate(tspDiag.codefixes).push(
+          defineCodeFix({
+            id: "show-linter-rule-doc-url",


please extract the common string

As comment above this still shouldn't even be a code fix and would simplify the logic later

RodgeFu · 2024-11-18T10:08:21Z

packages/compiler/src/server/serverlib.ts

      for (const fix of tspDiag.codefixes ?? []) {
+        const currentCmd =
+          fix.id === "show-linter-rule-doc-url" ? Commands.OPEN_RULE_DOC : Commands.APPLY_CODE_FIX;


it's better to if-else the fix.id with their own logic to make the code more readable and also makes it easier to extend in the future

RodgeFu · 2024-11-18T10:10:54Z

packages/compiler/src/server/serverlib.ts

+      const docUrl = params.arguments?.[0] as string;
+      if (process.platform === "win32") {
+        // in windows
+        exec(`start ${docUrl}`);


please fix the security warning. And make sure these command are tested.

This will also only work on windows. Vscode is spice an open command that abstract that anyway

https://github.com/microsoft/vscode-eslint/blob/main/client/src/client.ts#L304-L305

timotheeguerin · 2024-11-18T16:30:46Z

packages/compiler/src/server/serverlib.ts

+        vsDiag.codeDescription?.href &&
+        tspDiag.codefixes?.findIndex((x) => x.id === "show-linter-rule-doc-url") === -1
+      ) {
+        mutate(tspDiag.codefixes).push(


This will still mutate the program . This most likely needs to be done later right when creating the vs code actions

timotheeguerin · 2024-11-18T16:31:17Z

packages/compiler/src/server/serverlib.ts

+      ) {
+        mutate(tspDiag.codefixes).push(
+          defineCodeFix({
+            id: "show-linter-rule-doc-url",


As comment above this still shouldn't even be a code fix and would simplify the logic later

timotheeguerin · 2024-11-18T16:55:17Z

packages/samples/tspconfig.yaml

@@ -1,2 +1,9 @@
 emit:
  - "@typespec/openapi3"
+
+linter:


Would revert that for now, best practice is not a published package and this would give the wrong impression looking at samples

…fix, and then define the command to open the URL

RodgeFu · 2024-11-20T10:03:56Z

packages/typespec-vscode/src/code-action-provider.ts

@@ -0,0 +1,54 @@
+import vscode from "vscode";
+
+const COMMAND = "CodeActionProvider.Custom.OpenUrl";


it's better to use a more specific name: COMMAND -> OPEN_URL_COMMAND, "CodeActionProvider.Custom.OpenUrl" -> "typespec.openUrl"

RodgeFu · 2024-11-20T10:07:58Z

packages/typespec-vscode/src/code-action-provider.ts

+  );
+}
+
+export function createCommandOpenUrl() {


the command is not necessary coupling with CodeAction. please create a vscode-command file and move this there

RodgeFu · 2024-11-20T10:08:26Z

packages/typespec-vscode/src/code-action-provider.ts

+/**
+ * Provides code actions corresponding to diagnostic problems.
+ */
+export class ExtensionCodeActionProvider implements vscode.CodeActionProvider {


TypeSpecCodeActionProvider

RodgeFu · 2024-11-20T10:12:56Z

packages/typespec-vscode/src/code-action-provider.ts

+  ): vscode.CodeAction[] {
+    // for each diagnostic entry that has the matching `code`, create a code action command
+    return context.diagnostics
+      .filter((diagnostic) => typeof diagnostic.code === "object" && "target" in diagnostic.code)


Shouldn't we check whether the diagnostic is for typespec and has url defined here?

RodgeFu · 2024-11-20T10:14:33Z

packages/typespec-vscode/src/code-action-provider.ts

+      .map((diagnostic) => this.createCommandCodeAction(diagnostic));
+  }
+
+  private createCommandCodeAction(diagnostic: vscode.Diagnostic): vscode.CodeAction {


the name is too general. better to be sth like "createOpenUrlCodeAction"

RodgeFu · 2024-11-20T10:17:43Z

packages/typespec-vscode/src/code-action-provider.ts

+      arguments: [
+        typeof diagnostic.code === "object" && "target" in diagnostic.code
+          ? diagnostic.code.target.toString()
+          : "",


are we storing url in code.target? And we shouldn't add the codeAction if url is "".

RodgeFu · 2024-11-20T10:18:31Z

packages/typespec-vscode/src/code-action-provider.ts

+      ],
+    };
+    action.diagnostics = [diagnostic];
+    action.isPreferred = true;


I dont think this is a preferred codeaction

RodgeFu · 2024-11-21T07:12:30Z

packages/typespec-vscode/src/const.ts

@@ -1,3 +1,5 @@
 export const enum SettingName {
  TspServerPath = "typespec.tsp-server.path",
 }
+
+export const OPEN_URL_COMMAND = "typespec.openUrl";


please move it to be with its command

RodgeFu · 2024-11-21T07:32:18Z

packages/typespec-vscode/src/code-action-provider.ts

+          diagnostic.source === "TypeSpec" &&
+          typeof diagnostic.code === "object" &&
+          "target" in diagnostic.code,
+      )


please add comment and check target is not empty

RodgeFu · 2024-11-21T07:36:32Z

packages/typespec-vscode/src/code-action-provider.ts

+  private createOpenUrlCodeAction(diagnostic: vscode.Diagnostic): vscode.CodeAction {
+    // The target will only exist if the compiler's diagnosis contains the url, so no data will be stored.
+    if (typeof diagnostic.code === "object" && "target" in diagnostic.code) {
+      const action = new vscode.CodeAction("Open Document", vscode.CodeActionKind.QuickFix);


please use Empty kind.

microsoft-github-policy-service · 2024-11-21T19:14:29Z

@mzhongl524 please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

(default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
(when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"

Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

Definitions.
“Code” means the computer software code, whether in human-readable or machine-executable form,
that is delivered by You to Microsoft under this Agreement.
“Project” means any of the projects owned or managed by Microsoft and offered under a license
approved by the Open Source Initiative (www.opensource.org).
“Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
Project, including but not limited to communication on electronic mailing lists, source code control
systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
discussing and improving that Project, but excluding communication that is conspicuously marked or
otherwise designated in writing by You as “Not a Submission.”
“Submission” means the Code and any other copyrightable material Submitted by You, including any
associated comments and documentation.
Your Submission. You must agree to the terms of this Agreement before making a Submission to any
Project. This Agreement covers any and all Submissions that You, now or in the future (except as
described in Section 4 below), Submit to any Project.
Originality of Work. You represent that each of Your Submissions is entirely Your original work.
Should You wish to Submit materials that are not Your original work, You may Submit them separately
to the Project if You (a) retain all copyright and license information that was in the materials as You
received them, (b) in the description accompanying Your Submission, include the phrase “Submission
containing materials of a third party:” followed by the names of the third party and any licenses or other
restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
guidelines concerning Submissions.
Your Employer. References to “employer” in this Agreement include Your employer or anyone else
for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
Submission is made in the course of Your work for an employer or Your employer has intellectual
property rights in Your Submission by contract or applicable law, You must secure permission from Your
employer to make the Submission before signing this Agreement. In that case, the term “You” in this
Agreement will refer to You and the employer collectively. If You change employers in the future and
desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
and secure permission from the new employer before Submitting those Submissions.
Licenses.

Copyright License. You grant Microsoft, and those who receive the Submission directly or
indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
parties.
Patent License. You grant Microsoft, and those who receive the Submission directly or
indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
Your patent claims that are necessarily infringed by the Submission or the combination of the
Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
import or otherwise dispose of the Submission alone or with the Project.
Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
granted by implication, exhaustion, estoppel or otherwise.

Representations and Warranties. You represent that You are legally entitled to grant the above
licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
have disclosed under Section 3). You represent that You have secured permission from Your employer to
make the Submission in cases where Your Submission is made in the course of Your work for Your
employer or Your employer has intellectual property rights in Your Submission by contract or applicable
law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
You later become aware that would make Your representations in this Agreement inaccurate in any
respect.
Information about Submissions. You agree that contributions to Projects and information about
contributions may be maintained indefinitely and disclosed publicly, including Your name and other
information that You submit with Your Submission.
Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
defenses of lack of personal jurisdiction and forum non-conveniens.
Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
supersedes any and all prior agreements, understandings or communications, written or oral, between
the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

mzhongl524 requested review from RodgeFu, bterlson, markcowl, allenjzhang and timotheeguerin as code owners November 15, 2024 08:23

Create show-linter-rule-url-in-codefix-2024-10-15-8-25-38.md

de6271a

RodgeFu added the ide Issues for VS, VSCode, Monaco, etc. label Nov 16, 2024

RodgeFu reviewed Nov 16, 2024

View reviewed changes

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

View reviewed changes

RodgeFu reviewed Nov 16, 2024

View reviewed changes

packages/compiler/src/core/program.ts Outdated Show resolved Hide resolved

RodgeFu reviewed Nov 16, 2024

View reviewed changes

packages/compiler/src/core/types.ts Outdated Show resolved Hide resolved

RodgeFu reviewed Nov 16, 2024

View reviewed changes

packages/compiler/src/server/server.ts Outdated Show resolved Hide resolved

Only add the modified logic code to the serverlib, delete the new cod…

a50b147

…efix file, and restore the other codes to the original state.

github-advanced-security bot found potential problems Nov 18, 2024

View reviewed changes

packages/compiler/src/server/serverlib.ts Fixed Show fixed Hide fixed

packages/compiler/src/server/serverlib.ts Fixed Show fixed Hide fixed

packages/compiler/src/server/serverlib.ts Fixed Show fixed Hide fixed

RodgeFu reviewed Nov 18, 2024

View reviewed changes

timotheeguerin reviewed Nov 18, 2024

View reviewed changes

Customize the CodeActionProvider in typespec-vscode to create a quick…

bdaf76a

…fix, and then define the command to open the URL

RodgeFu reviewed Nov 20, 2024

View reviewed changes

Adjustments based on amendments

ba76c14

RodgeFu reviewed Nov 21, 2024

View reviewed changes

Readjust the code

38497cb

markcowl assigned chrisradek Nov 21, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[typespec] expose linter rule documentation url in codefixes #5131

[typespec] expose linter rule documentation url in codefixes #5131

mzhongl524 commented Nov 15, 2024

azure-sdk commented Nov 15, 2024 •

edited

Loading

azure-sdk commented Nov 15, 2024

timotheeguerin Nov 16, 2024 •

edited

Loading

timotheeguerin Nov 16, 2024

RodgeFu Nov 18, 2024

timotheeguerin Nov 18, 2024 •

edited

Loading

RodgeFu Nov 18, 2024

RodgeFu Nov 18, 2024

timotheeguerin Nov 18, 2024

timotheeguerin Nov 18, 2024

timotheeguerin Nov 18, 2024 •

edited

Loading

timotheeguerin Nov 18, 2024

RodgeFu Nov 20, 2024 •

edited

Loading

RodgeFu Nov 20, 2024

RodgeFu Nov 20, 2024

RodgeFu Nov 20, 2024 •

edited

Loading

RodgeFu Nov 20, 2024

RodgeFu Nov 20, 2024

RodgeFu Nov 20, 2024 •

edited

Loading

RodgeFu Nov 21, 2024

RodgeFu Nov 21, 2024

RodgeFu Nov 21, 2024

microsoft-github-policy-service bot commented Nov 21, 2024

Contribution License Agreement

		@@ -0,0 +1,10 @@
		import { defineCodeFix } from "../diagnostics.js";

		export function createShowLinterRuleDocUrlCodeFix(docUrl: string) {

		@@ -0,0 +1,54 @@
		import vscode from "vscode";

		const COMMAND = "CodeActionProvider.Custom.OpenUrl";

[typespec] expose linter rule documentation url in codefixes #5131

Are you sure you want to change the base?

[typespec] expose linter rule documentation url in codefixes #5131

Conversation

mzhongl524 commented Nov 15, 2024

azure-sdk commented Nov 15, 2024 • edited Loading

azure-sdk commented Nov 15, 2024

timotheeguerin Nov 16, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

timotheeguerin Nov 18, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

timotheeguerin Nov 18, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

RodgeFu Nov 20, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

RodgeFu Nov 20, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

RodgeFu Nov 20, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

microsoft-github-policy-service bot commented Nov 21, 2024

Contribution License Agreement

azure-sdk commented Nov 15, 2024 •

edited

Loading

timotheeguerin Nov 16, 2024 •

edited

Loading

timotheeguerin Nov 18, 2024 •

edited

Loading

timotheeguerin Nov 18, 2024 •

edited

Loading

RodgeFu Nov 20, 2024 •

edited

Loading

RodgeFu Nov 20, 2024 •

edited

Loading

RodgeFu Nov 20, 2024 •

edited

Loading