Skip to content

Commit

Permalink
Merge branch 'release/0.2.1' into main
Browse files Browse the repository at this point in the history
  • Loading branch information
chvolkmann committed Feb 15, 2021
2 parents 4836d15 + 34d0ac2 commit d0a87f3
Show file tree
Hide file tree
Showing 5 changed files with 31 additions and 8 deletions.
17 changes: 15 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

## [0.2.1] - 2021-02-15

- Integrates #3

### Changed

- Created a `functions` folder and put `code_connect.py` into it. This lets [fisher](https://github.com/jorgebucaran/fisher#creating-a-plugin) discover it and copy it when installing. `code.fish` provides the alias.

## [0.2.0] - 2021-02-15

- Integrates #2

### Changed

- `source` was used to make `code` available through `code_connect.py`, which only output a shell string.
Expand All @@ -23,17 +33,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [0.1.1] - 2021-02-14

- Integrates #1

### Fixed

- Now raises an error when the `socat` binary cannot be found ([#1](https://github.com/chvolkmann/code-connect/pull/1))
- Now raises an error when the `socat` binary cannot be found (#1)

## [0.1.0] - 2021-02-13

### Added

- Initial release of `code-connect` and the corresponding fish plugin

[unreleased]: https://github.com/chvolkmann/code-connect/compare/v0.2.0...HEAD
[unreleased]: https://github.com/chvolkmann/code-connect/compare/v0.2.1...HEAD
[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
[0.1.1]: https://github.com/chvolkmann/code-connect/compare/v0.1.0...v0.1.1
[0.1.0]: https://github.com/chvolkmann/code-connect/releases/tag/v0.1.0
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,20 +29,20 @@ Afterwards, you should have a folder `.vscode-server` in your home directory.

## Usage

Set up an alias for `code`, pointing to `code_connect.py` by placing the following line in your shell's rcfile. That's it, you can now use `code` the usual way.
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. That's it, you can now use `code` the usual way.

```bash
alias code="/path/to/code_connect.py"
```

- For **bash**, use `~/.bashrc`.

- For **fish**, use `~/.config/fish/config.fish`.
- For [**fish**](https://fishshell.com/), use `~/.config/fish/config.fish`.

Fish users can alternatively install a [plugin](https://github.com/chvolkmann/code-connect-fish-plugin) with the [fisher plugin manager](https://github.com/jorgebucaran/fisher).
Fish users can use [fisher](https://github.com/jorgebucaran/fisher) for an automatic install

```bash
fisher install chvolkmann/code-connect-fish-plugin
fisher install chvolkmann/code-connect
```

## Changelog
Expand Down
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
0.2.0
0.2.1
10 changes: 10 additions & 0 deletions functions/code.fish
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
#!/usr/bin/fish

# https://github.com/chvolkmann/code-connect

# absolute path to code_connect.py
set _CODE_CONNECT_PY (dirname (realpath (status --current-filename)))/code_connect.py

function code --description 'Run Visual Studio Code through code-connect'
$_CODE_CONNECT_PY $argv
end
2 changes: 1 addition & 1 deletion code_connect.py → functions/code_connect.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/usr/bin/env python3

# based on https://stackoverflow.com/a/60949722
# https://github.com/chvolkmann/code-connect

import time
import subprocess as sp
Expand Down

0 comments on commit d0a87f3

Please sign in to comment.