[Not Ready] [typespec-vscode] Improvements for the intellisense of tspconfig.yaml #5186

mzhongl524 · 2024-11-25T09:17:10Z

Add a intellisense for the extends path in tspconfig.yaml

Fixes：#4855

update

azure-sdk · 2024-11-25T09:19:08Z

All changed packages have been documented.

✅ @typespec/compiler

Show changes

`@typespec/compiler` - fix ✏️

Improvements for the intellisense of tspconfig.yaml,> - Support the auto completion for extends, imports, rule, rule sets and variables in tspconfig.yaml,> - Show required/optional information in the details of emitter's options completion item in tspconfig.yaml

`@typespec/compiler` - fix ✏️

Fix bug in tspconfig.yaml,> - Fix the issue that extra " will be added when auto completing emitter options inside ""

packages/typespec-vscode/src/completion-provider.ts

azure-sdk · 2024-11-25T09:29:27Z

You can try these changes here

🛝 Playground	🌐 Website	📚 Next docs

mzhongl524 · 2024-11-27T09:36:36Z

@microsoft-github-policy-service agree company="Microsoft"

…

________________________________ 发件人: microsoft-github-policy-service[bot] ***@***.***> 发送时间: 2024年11月27日 02:26 收件人: microsoft/typespec ***@***.***> 抄送: Zhonglei Ma (WICRESOFT NORTH AMERICA LTD) ***@***.***>; Mention ***@***.***> 主题: Re: [microsoft/typespec] [typespec-vscode] Improvements for the intellisense of tspconfig.yaml (PR #5186) @mzhongl524<https://github.com/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. 1. 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<http://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. 2. 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. 3. 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. 4. 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. 5. 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. 1. 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. 2. 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. 3. 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. 4. 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. 5. 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. ― Reply to this email directly, view it on GitHub<#5186 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/ADEA3M743LA6VTXI7NQWGO32CS4MZAVCNFSM6AAAAABSNPOLKGVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDKMBRGY2DSMBUHA>. You are receiving this because you were mentioned.Message ID: ***@***.***>

…er's options

packages/compiler/src/server/lib-provider.ts

packages/compiler/src/server/serverlib.ts

packages/compiler/src/server/tspconfig/completion.ts

packages/compiler/src/server/yaml-resolver.ts

packages/compiler/src/server/tspconfig/completion.ts

…-2-35-2.md

RodgeFu · 2024-12-22T01:42:04Z

.chronus/changes/improvements-for-the-intellisense-of-tspconfig.yaml-2024-11-19-2-35-2.md

+- The rule or ruleSets of the linter can be auto-completed
+- Emitter optoins autocomplete intelligently handles quotation mark display
+- Autocomplete of variable interpolation
+- The parameters of emitter's options distinguish whether they are required or optional


Please create two changelog items, one as new feature for:
Support the auto completion for extends, imports, rule, rule sets and variables in tspconfig.yaml
Show required/optional information in the details of emitter's options completion item in tspconfig.yaml
the other as bug fix for:
Fix the issue that emitter option auto completion would extra " while inside "..."

RodgeFu · 2024-12-22T01:53:38Z

packages/compiler/src/server/tspconfig/completion.ts

+  const variableInterpolationItems = resolveVariableInterpolationCompleteItems(
+    target.yamlDoc,
+    target.path,
+    tspConfigDoc.getText().slice(target.sourceRange?.pos, target.cursorPosition),


what would happen if target.sourceRange is undefined?

RodgeFu · 2024-12-22T01:56:23Z

packages/compiler/src/server/tspconfig/completion.ts

+            }
+          }
+
+          // If there is no corresponding ruleSet in the library, add the library name directly.


the comment seems no longer valid.

RodgeFu · 2024-12-22T02:09:04Z

packages/compiler/src/server/tspconfig/completion.ts

+          const exports = await pkg.getModuleExports();
+          if (exports?.$linter?.ruleSets !== undefined) {
+            // Below ruleSets are objects rather than arrays
+            for (const [ruleSet] of Object.entries(exports?.$linter?.ruleSets)) {


I remember Object.entries will throw if undefined is given. please help to confirm. same comment for other places using Object.entries.

Yes, Object.entries will throw, but judgment has ben made before use

then please remove the ? so that compiler can help you to catch it in case the pre-check is removed for some reason in the future.

RodgeFu · 2024-12-22T02:11:40Z

packages/compiler/src/server/tspconfig/completion.ts

+ * @param target The target object of the current configuration file, see {@link YamlScalarTarget}
+ * @returns CompletionItem object
+ */
+function createContainingQuatedValCompetionItem(


how about createCompletionItemWithQuote?

RodgeFu · 2024-12-22T02:12:15Z

packages/compiler/src/server/tspconfig/completion.ts

+    target.cursorPosition <= target.sourceRange.end
+  ) {
+    // If it is a quoted string, the relative position needs to be reduced by 1
+    const relativePos =


this is not a pos but a length

RodgeFu · 2024-12-23T09:22:28Z

.chronus/changes/improvements-for-the-intellisense-of-tspconfig.yaml-2024-11-19-2-35-2.md

+---
+
+Fix bug in tspconfig.yaml
+- Fix the issue that emitter option auto complete while inside "" will add extra ""`


Fix the issue that extra " will be added when auto completing emitter options inside ""

…-2-35-2.md

RodgeFu · 2024-12-24T02:46:19Z

packages/compiler/src/server/tspconfig/completion.ts

+            tspConfigPosition,
+            target,
+          );
+          if (item) {


if we can't create an item with quote, we should fall back to the original way instead of not adding the item

RodgeFu · 2024-12-24T02:48:33Z

packages/compiler/src/server/tspconfig/completion.ts

+                );
+                if (item) {
+                  items.push(item);
+                }


create in original way if can't create item withQuote. or you can put that logic in the method as a fallback solution

…ttps://github.com/mzhongl524/typespec into improvements-for-the-intellisense-of-tspconfig.yaml

mzhongl524 added 3 commits November 22, 2024 14:35

Merge pull request #1 from microsoft/main

b0ac596

update

Merge branch 'microsoft:main' into main

3fcbe52

Add a intellisense for the extends path in tspconfig.yaml

881e4b6

mzhongl524 requested review from RodgeFu, bterlson, markcowl, allenjzhang and timotheeguerin as code owners November 25, 2024 09:17

microsoft-github-policy-service bot added the ide Issues for VS, VSCode, Monaco, etc. label Nov 25, 2024

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

View reviewed changes

packages/typespec-vscode/src/completion-provider.ts Fixed Show fixed Hide fixed

mzhongl524 added 2 commits November 25, 2024 17:38

fix warning

dd4314b

Some autocompletes in linters, extends autocomplete updates

a43f7e9

markcowl assigned chrisradek and RodgeFu and unassigned chrisradek Nov 26, 2024

fix emitter option auto complete while inside "" will add extra ""

47e65f8

fix emitter option auto complete debug; revert vscode side code

18025cc

RodgeFu changed the title ~~[typespec-vscode] Improvements for the intellisense of tspconfig.yaml~~ [Not Ready] [typespec-vscode] Improvements for the intellisense of tspconfig.yaml Nov 28, 2024

mzhongl524 added 4 commits December 2, 2024 13:21

linter complete rule

51084bc

extends autocomplete

7344ef2

imports autocomplete

82f2ac7

add more info to distinguish required or optional parameter for emitt…

81df10c

…er's options

RodgeFu reviewed Dec 3, 2024

View reviewed changes

packages/compiler/src/server/lib-provider.ts Outdated Show resolved Hide resolved

RodgeFu reviewed Dec 3, 2024

View reviewed changes

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

RodgeFu reviewed Dec 3, 2024

View reviewed changes

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

RodgeFu reviewed Dec 3, 2024

View reviewed changes

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

RodgeFu reviewed Dec 3, 2024

View reviewed changes

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