Merge branch 'release/v0.3.0' into main

Author: chvolkmann

CHANGELOG.md

@@ -6,10 +6,33 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+
 Maybe your next idea?
+
+## [0.3.0] - 2021-02-18
+
+### Added
+
+- bash uninstaller
+
+### Changed
+
+- `code-connect` is now not just one alias anymore, but two aliases.
+
+  - The `code-connect` alias is added functionality of this repo, it points to `code_connect.py`
+  - The `code` alias checks whether `code` is in the PATH and omits using `code-connect` in this case. This is useful for the integrated terminal as a `code` executable is injected by VS Code into the PATH. Thus, `code` should just run that existing executable, not `code-connect` instead.
+
+    See [#8](https://github.com/chvolkmann/code-connect/issues/8)
+
+- bash installer is now fancy
+- All bash-related files are now in the `bash/` folder
+- All `code_connect.py` is now in the `bin/` folder
+- Fisher installation logic ([#10](https://github.com/chvolkmann/code-connect/pull/10))
+
 ## [0.2.2] - 2021-02-16
 
 ### Added
+
 - Code styling with black, isort and flake8
 - Poetry for managing code style dev dependencies
 - CI with Github Actions
@@ -54,7 +77,8 @@ Maybe your next idea?
 
 - Initial release of `code-connect` and the corresponding fish plugin
 
-[unreleased]: https://github.com/chvolkmann/code-connect/compare/v0.2.2...HEAD
+[unreleased]: https://github.com/chvolkmann/code-connect/compare/v0.3.0...HEAD
+[0.3.0]: https://github.com/chvolkmann/code-connect/compare/v0.2.2...v0.3.0
 [0.2.2]: https://github.com/chvolkmann/code-connect/compare/v0.2.1...v0.2.2
 [0.2.1]: https://github.com/chvolkmann/code-connect/compare/v0.2.0...v0.2.1
 [0.2.0]: https://github.com/chvolkmann/code-connect/compare/v0.1.1...v0.2.0

README.md

@@ -8,53 +8,84 @@ Open a file in your locally running Visual Studio Code instance from arbitrary t
 
 VS Code supports opening files with the terminal using `code /path/to/file`. While this is possible in [WSL sessions](https://code.visualstudio.com/docs/remote/wsl) and [remote SSH sessions](https://code.visualstudio.com/docs/remote/ssh) if the integrated terminal is used, it is currently not possible for arbitrary terminal sessions.
 
-Say, you have just SSH'd into a remote server using your favorite terminal and would like to open a webserver config file in your local VS Code instance. So you type `code nginx.conf`, which doesn't work in this terminal. If you try to run `code nginx.conf` in the integrated terminal however, VS Code opens it the file just fine.
+Say, you have just SSH'd into a remote server using your favorite terminal and would like to open a webserver config file in your local VS Code instance. So you type `code nginx.conf`, which doesn't work in this terminal. If you try to run `code nginx.conf` in the integrated terminal however, VS Code opens the file just fine.
 
 The aim of this project is to make the `code` cli available to _any_ terminal, not only to VS Code's integrated terminal.
 
 ## Prerequisites
 
-- **Linux** - we make assumptions on where VS Code stores it data based on Linux
+- **Linux** - we make assumptions on where VS Code stores its data based on Linux
 
   > Macs could also support everything out of the box, confirmation needed. Please don't hesitate to come into contact if you have any information to share.
 
-- **Python 3** - _tested under Python 3.8, but slightly older versions should work fine_
+- **Python 3**
+  > Tested under Python 3.8, but slightly older versions should work fine
 - **socat** - used for pinging UNIX sockets
   ```bash
   apt-get install socat
   ```
 
-### VS Code Server
+### Visual Studio Code Server
+
+You need to set up the server component of VS Code on the machine before using this utility. For this, [connect to your target in a remote SSH session](https://code.visualstudio.com/docs/remote/ssh).
 
-You need to set up VS Code Server before using this utility. For this, [connect to your target in a remote SSH session](https://code.visualstudio.com/docs/remote/ssh).  
 Afterwards, you should have a folder `.vscode-server` in your home directory.
 
 ## Installation
+
 ### [Fish](https://fishshell.com/)
+
+#### Installing
+
 With [fisher](https://github.com/jorgebucaran/fisher)
+
 ```fish
 fisher install chvolkmann/code-connect
 ```
-This downloads [`code_connect.py`](./functions/code_connect.py) and sets up an alias for you. See [`functions/code.fish`](./functions/code.fish)
+
+This downloads [`code_connect.py`](./bin/code_connect.py) along with two functions. See [`functions/code.fish`](./functions/code.fish) and [`functions/code-connect.fish`](./functions/code-connect.fish)
+
+You can autocomplete the repository name in subsequent commands, e.g. `fisher update code<TAB>`
+
+#### Updating
+
+```fish
+fisher update chvolkmann/code-connect
+```
+
+#### Uninstalling
+
+```fish
+fisher remove chvolkmann/code-connect
+```
+
 ### Bash
+
+#### Installing & Updating
+
+With [`bash/install.sh`](./bash/install.sh)
+
 ```bash
-source <(curl https://raw.githubusercontent.com/chvolkmann/code-connect/main/install.sh)
+curl -sS https://raw.githubusercontent.com/chvolkmann/code-connect/main/bash/install.sh | bash
 ```
 
-This downloads [`code_connect.py`](./functions/code_connect.py) and sets up an alias for you. See [`install.sh`](./install.sh).
-
-To uninstall, delete the alias from you `~/.bashrc` and remove `~/.code-connect`.
+This downloads [`code_connect.py`](./bin/code_connect.py) along with two scripts and sets up aliases in your `.bashrc` for you. See [`bash/code.sh`](./bash/code.sh) and [`bash/code-connect.sh`](./bash/code-connect.sh)
 
-### Manually
+#### Uninstalling
 
-Set up an alias for `code`, pointing to [`code_connect.py`](./functions/code_connect.py) by placing the following line in your shell's rcfile (bash: `~/.bashrc`, fish: `~/.config/fish/fuctions/code.fish`).
+With [`bash/uninstall.sh`](./bash/uninstall.sh)
 
 ```bash
-alias code="/path/to/code_connect.py"
+curl -sS https://raw.githubusercontent.com/chvolkmann/code-connect/main/bash/uninstall.sh | bash
 ```
 
+Deletes the aliases from `~/.bashrc` and removes the folder `~/.code-connect`
+
 ## Usage
-Just use `code` like you normally would!
+
+Use `code` as you would normally!
+
+If you have VS Code installed on your remote machine as well (i.e. a `code` executable already exists), you can use `code` for your local instance and `code-connect` for a IPC connected instance.
 
 ```
 Usage: code [options][paths...]
@@ -81,17 +112,20 @@ See [CHANGELOG.md](./CHANGELOG.md)
 
 ## How it works
 
+### VS Code Remote under the hood
+
 VS Code uses datagram sockets to communicate between a terminal and the rendering window.
 
-The integrated terminal as well as the WSL terminal spawn an IPC socket. You also create one when manually attaching a remote SSH session. These sockets can be found in the folder VS Code Server.
+The integrated terminal as well as the WSL terminal spawn an IPC socket. You also create one when connecting through a remote SSH session. These sockets can be found in the folders of VS Code Server.
 
-Each time you connect remotely, the VS Code client instructs the server to fetch the newest version of itself. All versions are stored by commit id in `~/.vscode-server/bin`. `code-connect` uses the version that has been most recently accessed. The corresponding binary can be found in `~/.vscode-server/bin/<commid-id>/bin/code`.
+Each time you connect remotely, the VS Code client instructs the server to fetch the newest version of itself. All versions are stored by commit id in `~/.vscode-server/bin`. `code-connect` uses the version that has been most recently accessed. The corresponding `code` executable can be found in `~/.vscode-server/bin/<commid-id>/bin/code`.
 
 A similar method is used to list all of VS Code's IPC sockets, which are located under `/run/user/<userid>/vscode-ipc-<UUID>.sock`, where `<userid>` is the [current user's UID](https://en.wikipedia.org/wiki/User_identifier) and `<UUID>` is a unique ID. VS Code does not seem to clean up all stale connections, so some of these sockets are active, some are not.
 
-So the socket that is listening and that was accessed within a timeframe of 4 hours by default is chosen.
+Thus the first socket that is listening and that was accessed within a timeframe of 4 hours by default is chosen.
+
+VS Code communicates the presence of an active IPC connection with the environment variable `VSCODE_IPC_HOOK_CLI` which stores the path to the socket.
 
-VS Code communicates the presence of an active IPC connection with the environment variable `VSCODE_IPC_HOOK_CLI` which stores the path to the socket.  
 You can verify this by opening a connection to your remote machine. In one case, you use VS Code's integrated terminal. In the other case, you use any other terminal.
 
 Run
@@ -110,15 +144,21 @@ socat -u OPEN:/dev/null UNIX-CONNECT:/path/to/socket
 
 This returns `0` if and only if there's something listening.
 
+### `code-connect` under the hood
+
 The script `code_connect.py` performs all of the above steps and runs the VS Code `code` executable
-as a child process with `VSCODE_IPC_HOOK_CLI` set properly.
+as a child process with `VSCODE_IPC_HOOK_CLI` set properly, making it a drop-in replacement for `code`.
+
+When we already have a `code` executable available, we don't need to search for it ourselves using `code_connect.py`. So we introduce two more scripts:
+
+- `code-connect`  
+  Direct alias to `code_connect.py`
+- `code`  
+  Checks whether there is a `code` executable locally installed already and tries to use it if available. Otherwise, `code-connect` will be used.
 
-## [Contributing](./CONTRIBUTING.md)
+## Contributing
 
-- Fork the repo
-- Commit your changes to your branch
-- Create a pull request  
-  _Please make sure that [edits to your pull request are permitted](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork)._
+See [CONTRIBUTING.md](./CONTRIBUTING.md)
 
 ## Credit
 

VERSION

@@ -1 +1 @@
-0.2.2
+0.3.0

bash/code-connect.sh

@@ -0,0 +1,8 @@
+#!/bin/bash
+
+# https://github.com/chvolkmann/code-connect
+
+# Use this script through an alias
+#   alias code-connect="/path/to/code-connect.sh"
+
+~/.code-connect/bin/code_connect.py $@

bash/code.sh

@@ -0,0 +1,15 @@
+#!/bin/bash
+
+# https://github.com/chvolkmann/code-connect
+
+# Use this script through an alias
+#   alias code="/path/to/code.sh"
+
+local_code_executable="$(which code)"
+if test -n "$local_code_executable"; then
+    # code is in the PATH, use that binary instead of the code-connect
+    $local_code_executable $@
+else
+    # code not locally installed, use code-connect
+    ~/.code-connect/bin/code_connect.py $@
+fi

bash/install.sh

@@ -0,0 +1,130 @@
+#!/bin/bash
+
+# https://github.com/chvolkmann/code-connect
+
+# Configure this variable to change the install location of code-connect
+CODE_CONNECT_INSTALL_DIR=~/.code-connect
+
+CODE_CONNECT_BASE_URL="https://raw.githubusercontent.com/chvolkmann/code-connect/main"
+
+
+####
+
+# Fancy output helpers
+
+c_cyan=`tput setaf 7`
+c_red=`tput setaf 1`
+c_magenta=`tput setaf 6`
+c_grey=`tput setaf 8`
+c_green=`tput setaf 10`
+c_reset=`tput sgr0`
+
+c_fg="$c_cyan"
+c_log="$c_grey"
+c_err="$c_red"
+c_emph="$c_magenta"
+c_path="$c_green"
+
+print () {
+    echo "$c_fg$@$c_reset"
+}
+
+log () {
+    echo "$c_log$@$c_reset"
+}
+
+error () {
+    echo "$c_err$@$c_reset"
+}
+
+
+# Helpers
+
+download-repo-file () {
+    repo_path="$1"
+    output_path="$2"
+    url="$CODE_CONNECT_BASE_URL/$repo_path"
+
+    if test "$output_path" != "-"; then
+        log "Downloading ${c_path}$repo_path${c_log} from ${c_path}$url"
+    fi
+
+    curl -sS -o "$output_path" "$url"
+    ret="$?"
+    if test "$ret" != "0"; then
+        error "ERROR: Could not fetch ${c_path}$url${c_err}"
+        error "${c_emph}curl${c_err} exited with status code ${c_emph}$ret"
+        exit $ret
+    fi
+}
+
+alias-exists () {
+    name="$1"
+    cat ~/.bashrc | grep -q "alias $name=*"
+}
+
+ensure-alias () {
+    name="$1"
+    val="$2"
+    if alias-exists "$name"; then
+        log "Alias ${c_emph}$name${c_log} already registered in ${c_path}~/.bashrc${c_log}, skipping"
+    else
+        echo "alias $name='$val'" >> ~/.bashrc
+        log "Adding alias ${c_emph}$name${c_log} to ${c_path}~/.bashrc"
+    fi
+}
+
+
+#####
+
+
+version=$(download-repo-file "VERSION" -)
+print ""
+print "${c_emph}code-connect ${c_log}v$version"
+print ""
+
+
+# Download the required files from the repository
+
+mkdir -p "$CODE_CONNECT_INSTALL_DIR/bin"
+
+CODE_CONNECT_PY="$CODE_CONNECT_INSTALL_DIR/bin/code_connect.py"
+download-repo-file "functions/code_connect.py" $CODE_CONNECT_PY
+chmod +x "$CODE_CONNECT_PY"
+
+mkdir -p "$CODE_CONNECT_INSTALL_DIR/bin"
+
+CODE_SH="$CODE_CONNECT_INSTALL_DIR/bin/code.sh"
+download-repo-file "bash/code.sh" $CODE_SH
+chmod +x "$CODE_SH"
+
+CODE_CONNECT_SH="$CODE_CONNECT_INSTALL_DIR/bin/code-connect.sh"
+download-repo-file "bash/code-connect.sh" $CODE_CONNECT_SH
+chmod +x "$CODE_CONNECT_SH"
+
+print ""
+
+
+# Add the aliases to ~/.bashrc if not already done
+ensure-alias "code" "$CODE_SH"
+ensure-alias "code-connect" "$CODE_CONNECT_SH"
+
+
+print ""
+print "${c_emph}code-connect${c_fg} installed to ${c_path}$CODE_CONNECT_INSTALL_DIR${c_fg} successfully!"
+print ""
+print "Restart your shell or reload your ${c_path}.bashrc${c_fg} to see the changes."
+print ""
+print "  ${c_emph}source ${c_path}.bashrc"
+print ""
+
+
+local_code_binary=$(which code)
+if test -z "$local_code_binary"; then
+    print "Local installation of ${c_emph}code${c_fg} detected at ${c_path}$local_code_binary"
+    print "Use the ${c_emph}code${c_fg} executable as you would normally."
+    print "If you want to connect to a remote VS Code session, use ${c_emph}code-connect${c_fg} as a drop-in replacement for ${c_emph}code${c_fg}!"
+else
+    print "Use the ${c_emph}code${c_fg} executable as you would normally and you will interface with an open VS Code remote session, if available."
+    print "If you want to ${c_err}explicitly${c_fg} connect to a remote VS Code session, use ${c_emph}code-connect${c_fg} as a drop-in replacement for ${c_emph}code${c_fg}!"
+fi