inclusive-dev-tools / woke

✊ Detect non-inclusive language in your source code.
https://medium.com/@caitlinelfring/woke-437880c3de64
MIT License
0 stars 0 forks source link

Investigate improvements to the binary woke update cycle within vs-code extension #19

Open mkcomer opened 3 years ago

mkcomer commented 3 years ago

Description Currently the vs-code woke extension doesn't manage the installation of woke. Rather, you need to install it yourself and it will use whatever it can find in your $PATH, or what you define in the extension setting woke.executablePath.

There is a disableVersionCheck on the vs-code woke extension that checks that your woke is up to date with the latest version. However, when I ran the VS Code extension on woke 0.9.0 and woke's latest is on version 0.16.0- nothing prompted me to update my woke binary.

Is the disableVersionCheck checking the vs-code woke extension version and not the woke binary version? Do we need a version check on the woke binary as well?

This could create compatibility issues, as well as confusion for why certain feature enhancements are not functional in the extension (if you are running your extension off an old binary woke).

Links/Additional Suggestions:

Acceptance Criteria:

Investigate improvements and enhance the woke update cycle:

mkcomer commented 3 years ago

After investigating the disableVersionCheck, it appears that the vs-code-extension is checking the underlying woke binary. There is logic to compare the local binary vs. the BEST_TOOL_VERSION (the latest version of woke binary you should be on). If local binary version < BEST_TOOL_VERSION --> prompt user to update woke binary.

The BEST_TOOL_VERSION is hardcoded to 0.2.0. This explains why when I was running the extension on 0.9.0 and woke's latest is on version 0.16.0, I was not prompted to update my woke binary.

Is this desired functionality? Or a bug? Do we want to update the hardcoded version or automate this update cycle?

mkcomer commented 3 years ago

Opened issue with the maintainer to get early feedback re: if this is desired functionality, if we want to update the "BEST_TOOL_VERSION" or look into better ways to automate woke update cycle from woke releases to vs-code extension.

https://github.com/get-woke/vscode-woke/issues/10

Will wait for feedback & continue updating this issue.