introduce a fully featured version manager #230

Techatrix · 2024-09-07T21:00:52Z

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.

No initial setup for Zig
initial setup for ZLS is only 'yes' or 'no'
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 downloaded from mirrors just like setup-zig (fixes #238) and verified with minisign
The version of ZLS is inferred from the Zig version.

One unfortunate limitation is that the Zig installation will fail if the exact Zig version in the build.zig.zon is not provided as a prebuilt binary. There is no mechanism in place that will try to find the next available 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.

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)
added an option to install Mach's Nominated Zig versions
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

Zig version update

The zig.update command has been removed. The 'Select and Install' popup can be used instead.
The zig.checkForUpdate has been removed. I can open a follow-up issue about it. I can foresee this needing some extra discussion to evaluate whether this feature is worth bringing back and how exactly it should behave.

follow-up tasks

select a Zig version should suggest to add or modify .zigversion or build.zig.zon
make it clear that the currently use Zig version does not match the .zigversion or build.zig.zon
make it possible to explicitly uninstall Zig builds (I believe that the quickpick popup can have buttons)
emit a warning if the installed Zig version does not satisfy the minimum_zig_version
make it clear that the 'Select and Install' popup is in "offline mode"
bring back checkForUpdate if possible

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

Techatrix · 2024-09-15T00:59:42Z

@Vexu Any thoughts on these changes?

Lygaen · 2024-09-24T15:53:49Z

I allowed myself to mention your PR here !
#232

I can remove it from the list if you desire

Vexu · 2024-09-29T22:54:37Z

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.

These changes make ZLS an "invisible" component of the extension after the initial setup. This also removes the `zig.zls.checkForUpdate` command. I am not sure if it even needs to be brought back. I've made sure that no error is reported if no internet connection is available. The last installed ZLS version should be reused. closes #136 because `zig.zls.startRestart` will just enable ZLS instead of complaining

fixes #111

The manual update command is already covered by the 'Select and Install' popup.

This commit replaces the initial setup with the following mechanism: 1. Check if the "Install Zig" has been previously executed in the active workspace. If so, install that version. 2. If the workspace contains a `.zigversion`, install the given Zig version. 3. If the workspace contains a `build.zig.zon` with a `minimum_zig_version`, install the next available Zig version. 4. Otherwise fallback to the latest tagged release of Zig. Some parts of this are not fully implemented. fixes #111

- add the ability to remove the workspace zig-version - add an option to manually specify the path to Zig - add 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 - make the popup usable without an internet connection

This unfortunately has a large impact on the bundle size: 600kb -> 1.3mb

For now, the list of mirrors has been manually copied over from mlugg/setup-zig. Adding mirrors for ZLS is also possible even though none exist. fixes #238

It is expected to be removed in ZLS 0.14.0

Techatrix · 2024-11-22T09:31:43Z

Ready for Review 🚀
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.

Vexu

Looks good! I published this as 0.5.10 (pre-release) so you can get people to try it after which I'll release it as 0.6.0.

aaronjheng · 2024-11-23T08:15:58Z

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

- removed redundant "Zig" from text - changed the Name (that appears in the context menu) from "Zig" to "Zig Version"

Techatrix · 2024-11-23T09:15:58Z

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

A similar test is already done in versionManager.ts

This should help when going back to the extension version. Otherwise it wont show the initial setup popup again.

This also fixes some cases where the status item would incorrectly state that ZLS is running

Techatrix · 2024-12-07T18:22:27Z

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.

Lygaen mentioned this pull request Sep 24, 2024

DevEx and QoL Improvements for Everyone ! #232

Closed

8 tasks

Techatrix force-pushed the techatrix/version-manager branch 2 times, most recently from 7c6cb52 to 1475806 Compare September 29, 2024 22:46

Techatrix force-pushed the techatrix/version-manager branch from 1475806 to 528a402 Compare October 12, 2024 20:04

Vexu mentioned this pull request Oct 14, 2024

Specifying the path to Zig leads to error "cant find Zig in PATH" and does not set the path to Zig #237

Closed

Techatrix mentioned this pull request Oct 14, 2024

Use mirrors for downloading Zig (and ZLS?) tarballs #238

Closed

Techatrix force-pushed the techatrix/version-manager branch from 528a402 to 64753bd Compare October 25, 2024 15:46

Vexu mentioned this pull request Oct 30, 2024

Could not find zls in PATH #241

Closed

Techatrix force-pushed the techatrix/version-manager branch 2 times, most recently from e0e9efb to a59bc53 Compare November 21, 2024 10:43

Techatrix added 17 commits November 22, 2024 03:56

add a VersionManager that installs Zig and ZLS

4ce7ae2

fixes #111

refactor: rename ZigCompilerProvider to ZigDiagnosticsProvider

8a5edb6

refactor: move version index download into zigUtil.ts

a7f963f

remove the Zig update feature

f1a2e83

The manual update command is already covered by the 'Select and Install' popup.

add zigProvider.ts

955eb40

add status item for ZLS

ac7f8eb

add status items for Zig

41159be

add zig.version config option.

27ba4db

watch for changes to build.zig.zon and .zigversion

89ca2eb

handle version resolution for tagged releases without network connection

6b09de7

implement automatic version removal

df027d1

verify Zig and ZLS installations with minisign

13493a2

This unfortunately has a large impact on the bundle size: 600kb -> 1.3mb

Use mirrors for downloading Zig tarballs

43834ee

For now, the list of mirrors has been manually copied over from mlugg/setup-zig. Adding mirrors for ZLS is also possible even though none exist. fixes #238

remove outdated zig_install and zls_install directory

60635f4

Techatrix added 2 commits November 22, 2024 07:50

update .vscodeignore

b877fda

ZLS has deprecated --enable-debug-log in favor of --log-level

5e37e61

It is expected to be removed in ZLS 0.14.0

Techatrix force-pushed the techatrix/version-manager branch from a59bc53 to b6adadc Compare November 22, 2024 08:33

add support for Mach's Nominated Zig versions

d5430e3

Techatrix force-pushed the techatrix/version-manager branch from b6adadc to d5430e3 Compare November 22, 2024 08:55

Techatrix marked this pull request as ready for review November 22, 2024 09:30

Vexu approved these changes Nov 22, 2024

View reviewed changes

Techatrix added 2 commits November 23, 2024 10:14

add an alias name for the "Zig" language so that it is capitalized

6694773

update Zig Version status bar item

e70b884

- removed redundant "Zig" from text - changed the Name (that appears in the context menu) from "Zig" to "Zig Version"

Techatrix added 3 commits November 23, 2024 11:39

remove unnecessary ZLS version check

fd95aa6

A similar test is already done in versionManager.ts

remove the outdated initialSetupDone config option from settings

d8d73e0

This should help when going back to the extension version. Otherwise it wont show the initial setup popup again.

stop ZLS when setting zig.zls.enabled to "off" while ZLS is running

11eb5db

This also fixes some cases where the status item would incorrectly state that ZLS is running

Vexu merged commit 681e0a9 into master Dec 7, 2024
2 checks passed

Techatrix deleted the techatrix/version-manager branch December 7, 2024 22:00

This was referenced Dec 7, 2024

emit a warning if the installed Zig version does not satisfy the minimum_zig_version #245

Closed

VSCode extension overrides config.json options #229

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

introduce a fully featured version manager #230

introduce a fully featured version manager #230

Techatrix commented Sep 7, 2024 •

edited

Loading

Techatrix commented Sep 15, 2024

Lygaen commented Sep 24, 2024

Vexu commented Sep 29, 2024

Techatrix commented Nov 22, 2024

Vexu left a comment

aaronjheng commented Nov 23, 2024

Techatrix commented Nov 23, 2024

Techatrix commented Dec 7, 2024

introduce a fully featured version manager #230

introduce a fully featured version manager #230

Conversation

Techatrix commented Sep 7, 2024 • edited Loading

Version Manager

Status Bar

Updated 'Select and Install' popup

Zig version update

follow-up tasks

Techatrix commented Sep 15, 2024

Lygaen commented Sep 24, 2024

Vexu commented Sep 29, 2024

Techatrix commented Nov 22, 2024

Vexu left a comment

Choose a reason for hiding this comment

aaronjheng commented Nov 23, 2024

Techatrix commented Nov 23, 2024

Techatrix commented Dec 7, 2024

Techatrix commented Sep 7, 2024 •

edited

Loading