Adding Sdk integration, and formatting support + code action for syntax updates to the language server #1207

bettinaheim · 2021-10-21T07:57:37Z

This PR does three things:

It includes the published version of the formatter in the Microsoft.Quantum.Sdk, and adds a build target for updating the syntax in the project (no formatting).
It adds support for formatting files in the language server. This currently as written includes both formatting and updating syntax.
It adds a code action for the things that can be fixed by the syntax updater. If that action is selected, the deprecated syntax in the whole file is updates. No formatting is performed.

There is a test for the language server functionality, which tests two scenarios:

The first part checks formatting works when using the formatter packaged in the Sdk, and relies on a fixed version of the Sdk that has the formatter included.
The second part tests formatting works when using the (published) source code version of the formatter, and should catch any breaking changes to the formatter.

Additionally, we will set up a sanity test in the qdk repo to ensure that the formatter is correctly packaged in all future versions of the Sdk and the defined build target works as well.
Telemetry will follow in a separate PR.

src/QsCompiler/CompilationManager/EditorSupport/EditorCommands.cs

src/QsCompiler/CompilationManager/CompilationUnitManager.cs

… the issue

This reverts commit 4b96fe0.

ScottCarda-MS

The work in the formatter looks great, as well as the changes around the ProjectProperties type. Thanks!

An updated version of the formatter documentation is merged into main. Please pull that in and update that with anything relevant to the changes in this PR. Off the top of my head, it could be very informative to add a new section about the three new ways this PR exposes the formatter for use to people through the SDK. I also believe you had mentioned something before about updating the 'Limitations' section.

src/QsCompiler/LanguageServer/LanguageServer.cs

ricardo-espinoza · 2021-11-04T00:10:18Z

Thanks @bettinaheim for the detailed walk through this pull request. It took me a while to go over it, and catch up with the meeting last week, but looks good to me.

bettinaheim · 2021-11-04T04:05:25Z

@ScottCarda-MS I updated the readme of the formatter. Please take a look.

ScottCarda-MS

Thanks @bettinaheim. The README changes look good to me.

* added MSBuild_Logs to gitignore (#1171) * Command Line Support for Project File Input (#1192) * Change --inputs to --input (#1210) * Deprecate new array expression (#956) * Removing temporary project (#1225) * Formatter Updates Deprecated Boolean Operator Syntax (#1214) * Update the documentation found in the Q# Formatter Project (#1203) * Formatter Updates Deprecated Specialization Declaration Parameters (#1226) * Adding Sdk integration, and formatting support + code action for syntax updates to the language server (#1207) Co-authored-by: Filip W <[email protected]> Co-authored-by: Scott Carda <[email protected]> Co-authored-by: Sarah Marshall <[email protected]> Co-authored-by: bettinaheim <[email protected]> Co-authored-by: Jintao YU <[email protected]>

* added MSBuild_Logs to gitignore (#1171) * Command Line Support for Project File Input (#1192) * Change --inputs to --input (#1210) * Deprecate new array expression (#956) * Removing temporary project (#1225) * Formatter Updates Deprecated Boolean Operator Syntax (#1214) * Update the documentation found in the Q# Formatter Project (#1203) * Formatter Updates Deprecated Specialization Declaration Parameters (#1226) * Adding Sdk integration, and formatting support + code action for syntax updates to the language server (#1207) * QAT v. 0.1 (#1230) * Sdk changes to support Qir targets (#1238) * Quantum Development Kit Telemetry Library (#1199) Co-authored-by: Sarah Marshall <[email protected]> Co-authored-by: Scott Carda <[email protected]> * Allowing to use the LLVM intrinsic readcyclecounter from Q# (#1248) * Do case-insensitive comparisons for targets names (#1241) During the build stage of a Q# job submission via the CLI or the stand-alone executable, there is a case sensitive enforcement of target names. Since this limitation does not exist in the service or in other clients, we're aligning by making the corresponding comparison case insensitive. * Refactor language server code for extracting symbols from Q# fragments (#1220) * Start adding SymbolOccurrence module * Replace SymbolInformation implementation * Add C# interop for SymbolOccurrence * Rename SymbolInformation.cs to match class name * Mark SymbolInformation as obsolete * Add SymbolOccurrence.fsi * Add doc comments * Fix nullable errors with .NET Core 3.1 * Use as instead of is * Take in fragment instead of file in SymbolOccurrence * Update todo comments * Return NS in open directive as UsedVariable * Use TryGet for SymbolOccurrence C# API * Statement Kinds Support (#1212) * Addressing last comments - QAT v0.1 (#1240) * Type renaming * Removing redudant setModulePassManager * Fixing recursion * Refactoring filenames * Renaming directory * Updating names and files * Formatting * Fixing include * Updates for QIR validation (#1250) * Type renaming * Removing redudant setModulePassManager * Fixing recursion * Refactoring filenames * Renaming directory * Updating names and files * Formatting * Changing default to interop friendly * Updating base profile * Styling * Updating logger * Fixing style * Removing comment * Moving testing to run before linting * Updating CMake * Attempting to solve tests issue * Updating according to PR comments * Complete NamespaceItem in qsfmt (#1239) Co-authored-by: Filip W <[email protected]> Co-authored-by: Scott Carda <[email protected]> Co-authored-by: Sarah Marshall <[email protected]> Co-authored-by: bettinaheim <[email protected]> Co-authored-by: Jintao YU <[email protected]> Co-authored-by: Troels F. Rønnow <[email protected]> Co-authored-by: XField <[email protected]> Co-authored-by: Ricardo Espinoza <[email protected]>

Bettina Heim and others added 8 commits October 18, 2021 19:14

changes to add the formatter to the Sdk

1a2bd02

exclude pdbs from sdk

53a155c

just moving the target

01351c5

Version parsing ignores suffix

ad4d1aa

fixing the formatter file paths

2cdb049

adding formatting with a todo for the implementation

3188d82

formatting is enabled and works

35e466a

... and the corresponding code action.

d5fbb2e

bettinaheim requested a review from ScottCarda-MS October 21, 2021 07:57

bettinaheim changed the title ~~Adding formatting support and a code action for update to the language server~~ Adding formatting support and a code action for updating syntax to the language server Oct 21, 2021

ScottCarda-MS added the area: formatter Q# source code formatter label Oct 21, 2021

ScottCarda-MS reviewed Oct 21, 2021

View reviewed changes

src/QsCompiler/CompilationManager/EditorSupport/EditorCommands.cs Show resolved Hide resolved

ScottCarda-MS reviewed Oct 21, 2021

View reviewed changes

src/QsCompiler/CompilationManager/CompilationUnitManager.cs Outdated Show resolved Hide resolved

Bettina Heim added 3 commits October 21, 2021 17:28

additional formatting

a31adc9

added a test

1598f2f

some clean up

c4f4b00

bettinaheim changed the base branch from beheim/sdkIntegration to main October 22, 2021 06:08

bettinaheim changed the title ~~Adding formatting support and a code action for updating syntax to the language server~~ Adding Sdk integration, and formatting support + code action for syntax updates to the language server Oct 22, 2021

Bettina Heim added 6 commits October 21, 2021 23:12

getting updates from main

0f04849

adjusting the command

ee47cdf

fixing style

869e3f3

need to disable test until I have a set of packages

98bc206

adding an update-and-format verb

2dd8675

fixing formatting

2156f07

bettinaheim added this to the November 2021 milestone Oct 23, 2021

reenabling the test now that I have the package

aaf534e

bettinaheim requested a review from bamarsha October 23, 2021 04:44

Bettina Heim and others added 3 commits October 25, 2021 19:42

introducing a proper ProjectProperties class

c83b406

adding a test that uses the source code version of the formatter

411d5c3

Merge branch 'main' into beheim/formatting

4d078aa

Bettina Heim added 9 commits October 26, 2021 11:57

checking for time out

8ea3c21

printing exit code

efa02cc

printing output and error stream

f15e9ea

Updating the Microsoft.NET.Test.Sdk since it looks like that might be…

95a95ae

… the issue

need to publish the formatter for testing

e6c4c8a

cleaning up

0e7721c

removing temporary project

4b96fe0

fixing incorrect detection of nullable

20f2c33

Revert "removing temporary project"

0fe7cc2

This reverts commit 4b96fe0.

bettinaheim requested a review from ricardo-espinoza October 27, 2021 03:37

Bettina Heim added 3 commits October 26, 2021 21:18

minor tweak

8badee9

getting updates from main

b847c09

resolving merge conflict

31b5e3e

bettinaheim mentioned this pull request Oct 29, 2021

Update the documentation found in the Q# Formatter Project #1203

Merged

ScottCarda-MS mentioned this pull request Oct 29, 2021

Integrate formatter with language server #865

Closed

ScottCarda-MS reviewed Oct 29, 2021

View reviewed changes

Merge branch 'main' into beheim/formatting

4522416

ScottCarda-MS approved these changes Nov 3, 2021

View reviewed changes

ScottCarda-MS self-requested a review November 3, 2021 17:15

ricardo-espinoza reviewed Nov 4, 2021

View reviewed changes

src/QsCompiler/LanguageServer/LanguageServer.cs Show resolved Hide resolved

ricardo-espinoza approved these changes Nov 4, 2021

View reviewed changes

bettinaheim and others added 2 commits November 3, 2021 20:40

Merge branch 'main' into beheim/formatting

efdd0e4

updating formatter readme

6e1a3f7

ScottCarda-MS approved these changes Nov 4, 2021

View reviewed changes

bettinaheim merged commit 790813e into main Nov 5, 2021

bettinaheim deleted the beheim/formatting branch November 5, 2021 01:20

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Adding Sdk integration, and formatting support + code action for syntax updates to the language server #1207

Adding Sdk integration, and formatting support + code action for syntax updates to the language server #1207

Uh oh!

bettinaheim commented Oct 21, 2021 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

ScottCarda-MS left a comment •

edited

Loading

Uh oh!

Uh oh!

ricardo-espinoza commented Nov 4, 2021

Uh oh!

bettinaheim commented Nov 4, 2021

Uh oh!

ScottCarda-MS left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Adding Sdk integration, and formatting support + code action for syntax updates to the language server #1207

Adding Sdk integration, and formatting support + code action for syntax updates to the language server #1207

Uh oh!

Conversation

bettinaheim commented Oct 21, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ScottCarda-MS left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ricardo-espinoza commented Nov 4, 2021

Uh oh!

bettinaheim commented Nov 4, 2021

Uh oh!

ScottCarda-MS left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

bettinaheim commented Oct 21, 2021 •

edited

Loading

ScottCarda-MS left a comment •

edited

Loading