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

✨ add support for VScode WSL + SSH remote #420

Merged
merged 2 commits into from
Oct 1, 2021

Conversation

tyler36
Copy link
Contributor

@tyler36 tyler36 commented Oct 1, 2021

This PR adds support for:

  • VSCode Remote:WSL
  • VSCode Remote:SSH
  • VSCode-insiders Remote:WSL
  • VSCode-insiders Remote:SSH

How to use

  • Add the following to your project .env
IGNITION_EDITOR=vscode-remote
  • If you prefer to use VSCode-insiders, use IGNITION_EDITOR=vscode-insiders-remote instead.

  • Next, you need to update your IGNITION_LOCAL_SITES_PATH to the following format:

{remote-type}+{remote-target}/{remote-path}

  • Pro tip: Run pwd from a VSCode terminal when using the remote extension to get the {remote-path}

Remote-WSL

  • It is assumed you use VSCode with Remote-WSL extension to manage your project.
  • Update your IGNITION_LOCAL_SITES_PATH variable to WSL format:
    • wsl+{distro}/{remote-path}

EG. You use a Ubuntu WSL2 distro and your project is located at /home/user13/code/awesome-site

IGNITION_LOCAL_SITES_PATH=wsl+Ubuntu/home/user13/code/awesome-site

Remote-SSH

  • It is assumed you use VSCode with Remote-SSH extension to access your project.
  • Update your IGNITION_LOCAL_SITES_PATH variable to SSH format:
    • ssh-remote+{host}/{remote-path}

EG. Your SSH file has a Host entry called devserver and your project is located at /home/user13/code/awesome-site

IGNITION_LOCAL_SITES_PATH=ssh-remote+devserver/home/user13/code/awesome-site

@tyler36
Copy link
Contributor Author

tyler36 commented Oct 1, 2021

sorry ... the first commit was the compiled file instead of the src.

Not sure if you want both or part of your build process.

@tyler36
Copy link
Contributor Author

tyler36 commented Oct 1, 2021

@freekmurze
Copy link
Collaborator

Could you also PR this to https://github.com/spatie/ignition?

@freekmurze freekmurze merged commit 3ed529a into facade:main Oct 1, 2021
@freekmurze
Copy link
Collaborator

Thanks!

@tyler36
Copy link
Contributor Author

tyler36 commented Oct 22, 2021

Sorry, just noticed your request to update https://github.com/spatie/ignition.

I've submitted a PR for your approval.

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