vscode-zig icon indicating copy to clipboard operation
vscode-zig copied to clipboard

introduce a fully featured version manager

Open Techatrix opened this issue 1 year ago • 3 comments

Installing Zig or ZLS with the extension doesn't properly handle switching between different Zig project. You have to manually figure out which version to get and install it every time your switch to a project that requires a different Zig version. Same goes for ZLS. The vscode configuration for Zig also can't handle switching between devices (see #111) Let's stop giving developer the ability to misconfigure their editor.

  1. No initial setup for Zig
  2. initial setup for ZLS is only 'yes' or 'no'
  3. Done!

Version Manager

This is how the extension selects which version of Zig to install:

  • set the zig.version config option (can be global or per-workspace)
  • manually set the version through the 'Select and Install' popup (per-workspace)
  • set minimum_zig_version in the build.zig of your workspace
  • add a .zigversion to your workspace which stores the desired Zig version

If none of the above apply, the latest tagged release of Zig is installed. Installs are automatically uninstalled to not fill up disk storage too much. Installs are verified with minisign The version of ZLS is inferred from the Zig version.

Status Bar

Hovering over the "Editor Language Status" will show whether Zig and ZLS are installed + their versions. The Status Bar Item for Zig will turn red if is not installed. Clicking on it will open the 'Select and Install' popup.

Screenshot from 2024-09-07 21-23-59

Updated 'Select and Install' popup

  • added an option to manually specify the path to Zig
  • added an option to select Zig from PATH (if available)
  • display the exact version of nightly
  • display which versions are already installed on the host machine
  • if no network connection is available, only versions that are already installed are displayed

Screenshot from 2024-10-12 22-06-40

Remaining issues

  • [ ] The version lookup for nightly builds that are specified through the build.zig.zon is not working properly. see this TODO.
    • This is the main blocker for this PR. I still need to figure out how to solve it.
  • [ ] The zig.checkForUpdate config option and update command have been removed. It should be added back but with some adjustments.
  • [ ] add some documentation around these new features so that users know how to use them

I wanted to keep these changes as small as possible but I couldn't stop myself. :disappointed: Any feedback would be greatly appreciated.

Techatrix avatar Sep 07 '24 21:09 Techatrix

@Vexu Any thoughts on these changes?

Techatrix avatar Sep 15 '24 00:09 Techatrix

I allowed myself to mention your PR here ! #232

I can remove it from the list if you desire

Lygaen avatar Sep 24 '24 15:09 Lygaen

I'm guessing there is precedence for extensions downloading additional binaries unprompted when installed so I guess that is fine especially since it is from the official source. As long as overriding the path to the Zig binary still works these all seem like good changes. And sorry for taking so long to get to this.

Vexu avatar Sep 29 '24 22:09 Vexu

Ready for Review :rocket: I tried to keep the individual commits as readable as possible. Please let me know if there is anything I can do to make it easier to review.

Also, I think that publishing a pre-release can make sense here. I can ask in some of the Zig communities to see if there are people who would like to try this out before it gets published to everyone.

Techatrix avatar Nov 22 '24 09:11 Techatrix

{} zig Zig 0.13.0 seems a little redundant.

How about the following changes:

  • Capitalize the first zig
  • Remove the second Zig

The result would be {} Zig 0.13.0.

aaronjheng avatar Nov 23 '24 08:11 aaronjheng

{} zig Zig 0.13.0 seems a little redundant.

You are referring to the status bar items, right?

The reason why I had it this way was because they were made up of two independent items, the {} zig specifies the language of the current document and Zig 0.13.0 specifies the version of compiler. It is possible to hide one of them and keep the other. But I have to agree that having "Zig" appear twice is redundant, I updated it like you suggested.

Techatrix avatar Nov 23 '24 09:11 Techatrix

I did find some minor issues that have been resolved. Otherwise, this is ready to go. I can open some new issues about the follow-up tasks.

Techatrix avatar Dec 07 '24 18:12 Techatrix