Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: remove useWSL option #121

Merged
merged 2 commits into from
Feb 4, 2021
Merged

feat: remove useWSL option #121

merged 2 commits into from
Feb 4, 2021

Conversation

felipecrs
Copy link
Collaborator

@felipecrs felipecrs commented Oct 2, 2020

This option only seems to cause misleading when using the extension on Windows. Now that the extension is shipped with the shellcheck binaries bundled, it will work on Windows for the majority of the users, thus no need for proxying its use through WSL.

This option and its approach are now totally removed from the documentation to prevent users from mistakenly believe that they need to use it in Windows.

To simplify:

  • If you want to use this extension in Windows, simply install it in your VS Code
  • If you want to use this extension inside WSL, simply open the VS Code connected to WSL (with Remote - WSL) and install it

If you really know how it works and wants to keep using it in a similar way, you can do something like:


Using the extension on Windows and loading the shellcheck binary from WSL

To make this work, you also need to use a shim. Here is an example of a shellcheck.cmd:

@echo off
wsl -- shellcheck %*

Closes #117, closes #9 and closes #87.

@felipecrs felipecrs force-pushed the felipecrs/deprecate-wsl branch 4 times, most recently from b862e06 to 48b1df7 Compare February 4, 2021 13:46
@felipecrs felipecrs marked this pull request as ready for review February 4, 2021 13:50
@felipecrs felipecrs changed the title feat!: drop useWSL option feat: remove useWSL option Feb 4, 2021
@felipecrs felipecrs merged commit 9967218 into master Feb 4, 2021
@felipecrs felipecrs deleted the felipecrs/deprecate-wsl branch February 4, 2021 15:43
timonwong pushed a commit that referenced this pull request Feb 4, 2021
## [0.13.0](v0.12.3...v0.13.0) (2021-02-04)

### Features

* remove `useWSL` option ([#121](#121)) ([9967218](9967218))
@github-actions
Copy link

github-actions bot commented Feb 4, 2021

🎉 This PR is included in version 0.13.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@theAkito
Copy link

theAkito commented Feb 4, 2021

Thank you, good job.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
2 participants