Packages hovers and lenses #2373

AbdulrhmnGhanem · 2021-08-15T22:54:41Z

Add hovers, and codelens for Project.toml files. It provides a compilation of the features in Version Lens, the Golang extension, and the native packge.json support in VSCode. A demo 👇

demo.mp4

Some problems I am not sure how to approach

~~How to get the stdlib modules names? Currently, a package is assumed to be an @stdlib if it's not found in any registry.~~ Resolved in 04fa3df.
How to get the status of the current packages? Pkg.status prints directly to stdout, the format is parsable though I am not sure whether it's consistent across versions or not.
Running julia --project=. -e "using Pkg; Pkg.update()" pipes the output in the `stderr whether the operation succeeded or failed, how to determine if it was an actual failure?
ArgTools.jl needs to get added to the VSCodeServer.

For every PR, please check the following:

End-user documentation check.
Changelog mention.

AbdulrhmnGhanem · 2021-08-15T23:31:35Z

I will add validation (the squiggles) in a separate PR.

scripts/packages/RegistryQuery/RegistryQuery.jl

pfitzseb · 2021-08-26T11:44:29Z

How to get the status of the current packages? Pkg.status prints directly to stdout, the format is parsable though I am not sure whether it's consistent across versions or not.

Running julia --project=. -e "using Pkg; Pkg.update()" pipes the output in the `stderr whether the operation succeeded or failed, how to determine if it was an actual failure?

So the way I'd handle this is by spawning a new (re-useable) terminal or Outputs channel (and focusing it). That way we don't need to determine the success of the commands ourselves and instead leave that to the user.

src/interactive/versionslens.ts

davidanthoff · 2021-08-26T15:37:14Z

This is a fantastic feature!

One pretty fundamental comment: should this not just be part of the language server? That consideration should probably not stop us from merging here, i.e. I could also imagine that we merge this approach here first and then later migrate it into the LS, but in general that seems to be the better place?

AbdulrhmnGhanem · 2021-08-27T08:23:32Z

should this not just be part of the language server?

I have this intention, though prototyping the feature in the frontend (TypeScript) was faster because I mostly avoided recompiling the language server

davidanthoff

Ok, I took a closer look now :)

I think my main concern is that using the REPL process for querying the registry is not how we want to do this, for many reasons. It might be blocked because it is running code, we shouldn't start a REPL to show these IntelliSense things etc. I think the proper solution here would be to have this functionality in the LS, but if that is too involved for now then I think it would even be better to just spawn a new Julia process that simply queries the registry and then immediately returns.

I guess the main question really is how difficult it would be to move this into the LS?

davidanthoff · 2021-09-04T04:12:36Z

.gitmodules

@@ -58,3 +58,6 @@
 [submodule "scripts/packages/IJuliaCore"]
 	path = scripts/packages/IJuliaCore
 	url = https://github.com/JuliaLang/IJuliaCore.jl.git
+[submodule "scripts/packages/Tar"]
+	path = scripts/packages/Tar
+	url = https://github.com/JuliaIO/Tar.jl.git


The changes in this file don't seem to match the submodules that are added in this PR? Not sure how that can happen...

davidanthoff · 2021-09-04T04:14:36Z

scripts/packages/VSCodeServer/src/verionslens.jl

@@ -0,0 +1,38 @@
+include("../../RegistryQuery/RegistryQuery.jl")


We generally have all the code that loads packages in src/VSCodeServer.jl, so maybe move it there?

davidanthoff · 2021-09-04T04:15:09Z

scripts/packages/RegistryQuery/RegistryQuery.jl

@@ -0,0 +1,471 @@
+# The content of a registry is assumed to be constant during the


Maybe put this file into a src folder, just to be more consistent?

davidanthoff · 2021-09-04T04:17:25Z

scripts/packages/VSCodeServer/src/verionslens.jl

+    return LensResponse(RegistryQuery.UnknownPkgMetadata)
+end
+
+const lens_request_type = JSONRPC.RequestType("lens/pkgVersions", LensParams, LensResponse)


So it seems to me that all of this code should definitely not live in the REPL process. The REPL might not be running when someone opens a Project.toml, but that shouldn't be a reason that this functionality doesn't work, right?

I think if incorporating this into the LS is too involved right now, then it should still live in its own process (which, though, doesn't seem less work than just moving this functionality into the LS).

@davidanthoff, please take a look at julia-vscode/LanguageServer.jl#1055.

davidanthoff · 2021-09-04T04:19:43Z

src/interactive/versionslens.ts

+     */
+    async function _executeUpdateCommand(level: UpgradeLevel) {
+        const projectRoot = vscode.workspace.workspaceFolders[0]
+        const updateCommand = `julia --project=. -e "using Pkg; Pkg.update(;level=Pkg.${level})"`


This needs to pickup the configured Julia version, not just generic julia. You can take a look at say the task runner to see how to get that value.

I couldn't find an example of what you meant.

davidanthoff · 2021-09-04T04:21:40Z

src/interactive/versionslens.ts

+     * Execute `Pkg.update` and display its output while executing in an output channel.
+     */
+    async function _executeUpdateCommand(level: UpgradeLevel) {
+        const projectRoot = vscode.workspace.workspaceFolders[0]


I would expect the update command to update the currently active project, not just what is in the root, right?

davidanthoff · 2021-09-04T04:25:50Z

Also moving this to the backlog for now, as I don't think we can get this ready for the next minor version merge window.

AbdulrhmnGhanem · 2021-09-04T16:53:08Z

So be it, I will move it to the LS.

davidanthoff · 2021-09-04T16:55:48Z

Fantastic, and sorry for the extra hoops here. Are you on the slack channel vscode-dev? I think especially at the start we'll have to figure out how exactly we integrate it into the LS, and I'd be more than happy to iterate on that on slack and help with getting you up-to-speed on the LS design. We could also schedule a zoom call if you want.

AbdulrhmnGhanem · 2021-09-04T17:26:00Z

Are you on the slack channel vscode-dev?

No

Just dummy codelenses at the moment.

- The only job of the class was to provide encapsulation a namespace can do the job. - Fix some typing holes in `dep`.

- Metadata (the latest version of the package, repo url, registry to which it belongs) will be displayed on hovering over a `deps` field.

- To make the users control whether they want to load packages information or not; query the registries lazily when the users click on the contributed menu icon.

- The hover provides had to be split into multiple ones; hovering over the fields in the [deps] section will always return, then the other hover are unreachable. - The [deps] fields will always return if the registries aren't initialized, i.e., the user hasn't clicked the versions icon. - The hover now are (aware) of the status of the registry query, the reigstry query can be one of (hasn't been queried yet|loading|return the package info).

- compat fields don't have uuids so the should get deduced from the package name.

- Remove the version field. - Display the standard library link.

- Supprot major, minor, patch, and fixed updates

- Previously, if a package isn't found in any registry, it was considered an stdlib module. - Now, we check if it's an actual stdlib module. - Also, flag unknown packages if any.

- The output channel can display the result of `update` operation while it's running; using event listener on the `stderr`. - The event listener is on `stderr` because the update `Pkg.udapte` pipe the result into `stderr` whether it's successful or not.

AbdulrhmnGhanem mentioned this pull request Aug 15, 2021

Packages language server #2096

Closed

AbdulrhmnGhanem added a commit to AbdulrhmnGhanem/julia-vscode that referenced this pull request Aug 16, 2021

Update CHANGELOG.md for julia-vscode#2373

a40d835

AbdulrhmnGhanem added a commit to AbdulrhmnGhanem/julia-vscode that referenced this pull request Aug 16, 2021

Update CHANGELOG.md for julia-vscode#2373

f80411b

AbdulrhmnGhanem force-pushed the version-lens branch from a40d835 to f80411b Compare August 16, 2021 22:02

AbdulrhmnGhanem added a commit to AbdulrhmnGhanem/julia-vscode that referenced this pull request Aug 16, 2021

Update CHANGELOG.md for julia-vscode#2373

6d10e23

AbdulrhmnGhanem force-pushed the version-lens branch from f80411b to 6d10e23 Compare August 16, 2021 22:04

davidanthoff added the enhancement label Aug 23, 2021

davidanthoff added this to the Next Minor milestone Aug 23, 2021

pfitzseb reviewed Aug 26, 2021

View reviewed changes

scripts/packages/RegistryQuery/RegistryQuery.jl Outdated Show resolved Hide resolved

scripts/packages/RegistryQuery/RegistryQuery.jl Outdated Show resolved Hide resolved

pfitzseb reviewed Aug 26, 2021

View reviewed changes

src/interactive/versionslens.ts Outdated Show resolved Hide resolved

davidanthoff requested changes Sep 4, 2021

View reviewed changes

davidanthoff modified the milestones: Next Minor, Backlog Sep 4, 2021

AbdulrhmnGhanem added 9 commits April 17, 2022 11:35

Add: skeleton for Project.toml codelenses.

94e1b89

Just dummy codelenses at the moment.

Add: codelenses for each dependency.

cb142ee

Refactor: replaced the class with a namspace and fix typing holes.

048ad8f

- The only job of the class was to provide encapsulation a namespace can do the job. - Fix some typing holes in `dep`.

Make codelenses actionable.

f16c466

Add: skeleton for squiggles.

30febbe

Add: skeleton for hovers.

2bcbded

Remove Diagnostics for now

46c48c6

Add hover for project name

b484fc2

Add hover for project uuid

7faefad

AbdulrhmnGhanem added 19 commits April 17, 2022 11:46

Pass latest verion of a pkg to the VSCode process.

cd73bcb

Document the regex used to match sections

230c5cc

Pass packages metadata to the VSCode process

2dcf407

- Metadata (the latest version of the package, repo url, registry to which it belongs) will be displayed on hovering over a `deps` field.

Contribute a title bar menu icon to query registries

5b1df7c

- To make the users control whether they want to load packages information or not; query the registries lazily when the users click on the contributed menu icon.

Support querying registries with [compat] fields

8cf80b1

- compat fields don't have uuids so the should get deduced from the package name.

Make the JSONRPC type more concrete

1ce76b5

Query all reachable registries

23302fe

Handle @stdlib hovers

3a8b629

- Remove the version field. - Display the standard library link.

Add Update all packages codelens.

42693e8

Add codelenses for different update levels

e49b6b7

- Supprot major, minor, patch, and fixed updates

Documentation for vesrsionlens frontend (VSCode side)

ea3ee9b

Add configuration option to disable versionslens

90ef545

Update CHANGELOG.md for julia-vscode#2373

66199ff

Handle stdlib modules properly

b011be5

- Previously, if a package isn't found in any registry, it was considered an stdlib module. - Now, we check if it's an actual stdlib module. - Also, flag unknown packages if any.

Use Pkg.Types directly

d3d0e11

Remove LazilyInitializedFields

7d4af3f

Show update log on action click

7b06823

AbdulrhmnGhanem force-pushed the version-lens branch from 96ea934 to 7b06823 Compare April 17, 2022 10:39

AbdulrhmnGhanem added 4 commits April 17, 2022 12:54

Remove LazilyInitializedFields cached submodule

1d9e45f

Deps: add @iarna/toml

193f95a

Refactor: move package loading to VSCodeServer.jl

9bb1ce0

squash! Refactor: move package loading to VSCodeServer.jl

bea72cd

AbdulrhmnGhanem force-pushed the version-lens branch from fcae5c2 to bea72cd Compare April 17, 2022 15:06

AbdulrhmnGhanem added 2 commits April 17, 2022 18:00

Refactor: move RegistryQuery.jl into src

5050102

Refactor: query the registries in the LS instead of the REPL

c879329

AbdulrhmnGhanem force-pushed the version-lens branch from 0e2e51e to c879329 Compare April 18, 2022 08:13

AbdulrhmnGhanem mentioned this pull request Apr 18, 2022

Port version lens from julia-vscode#2373 julia-vscode/LanguageServer.jl#1055

Open

davidanthoff removed this from the Backlog milestone Oct 15, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Packages hovers and lenses #2373

Packages hovers and lenses #2373

AbdulrhmnGhanem commented Aug 15, 2021 •

edited

AbdulrhmnGhanem commented Aug 15, 2021

pfitzseb commented Aug 26, 2021

davidanthoff commented Aug 26, 2021

AbdulrhmnGhanem commented Aug 27, 2021

davidanthoff left a comment

davidanthoff Sep 4, 2021

davidanthoff Sep 4, 2021

davidanthoff Sep 4, 2021

davidanthoff Sep 4, 2021

AbdulrhmnGhanem Apr 18, 2022

davidanthoff Sep 4, 2021

AbdulrhmnGhanem Sep 4, 2021

davidanthoff Sep 4, 2021

davidanthoff commented Sep 4, 2021

AbdulrhmnGhanem commented Sep 4, 2021

davidanthoff commented Sep 4, 2021

AbdulrhmnGhanem commented Sep 4, 2021 •

edited

		@@ -0,0 +1,38 @@
		include("../../RegistryQuery/RegistryQuery.jl")

		@@ -0,0 +1,471 @@
		# The content of a registry is assumed to be constant during the

Packages hovers and lenses #2373

Are you sure you want to change the base?

Packages hovers and lenses #2373

Conversation

AbdulrhmnGhanem commented Aug 15, 2021 • edited

Some problems I am not sure how to approach

AbdulrhmnGhanem commented Aug 15, 2021

pfitzseb commented Aug 26, 2021

davidanthoff commented Aug 26, 2021

AbdulrhmnGhanem commented Aug 27, 2021

davidanthoff left a 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

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

davidanthoff commented Sep 4, 2021

AbdulrhmnGhanem commented Sep 4, 2021

davidanthoff commented Sep 4, 2021

AbdulrhmnGhanem commented Sep 4, 2021 • edited

AbdulrhmnGhanem commented Aug 15, 2021 •

edited

AbdulrhmnGhanem commented Sep 4, 2021 •

edited