Skip to content

Commit

Permalink
go to v0.5.5
Browse files Browse the repository at this point in the history
  • Loading branch information
michaelb committed May 5, 2021
1 parent d79725f commit 513fa03
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 6 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
## v0.5.5
- Configurable colors
- Use current buffer instead of save files for import level

## v0.5.4
- Support configuring compiler, interpreter or venv (python)
Expand Down
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "sniprun"
version = "0.5.4"
version = "0.5.5"
authors = ["michaelb <[email protected]>"]
edition = "2018"

Expand Down
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -415,17 +415,16 @@ Due to its nature, Sniprun may have trouble with programs that :

- Meddle with standart output / stderr
- Need to read from stdin
- Prints incorrect UTF8 characters, or just too many lines
- Access files; sniprun does not run in a virtual environment, it accesses files just like your own code do, but since it does not run the whole program, something might go wrong. **Relative paths may cause issues**, as the current working directory for sniprun will be somewhere in ~/.cache, and relative imports may miss.
- For import support level and higher, Sniprun fetch code from the saved file (and not the neovim buffer). Be sure that the functions / imports your code need have been _written_.
- Print incorrect UTF8 characters, or just too many lines
- Access files; sniprun does not run in a virtual environment, it accesses files just like your own code do, but since it does not run the whole program, something might go wrong. **Relative paths may cause issues**, as the current working directory for sniprun will be somewhere in ~/.cache/sniprun, and relative imports may miss.

## Troubleshooting

begin by updating the plugin and running `:checkhealth sniprun`

- **Silent fail**: the sniprun binary may be incompatible with your distro/OS/arch. Use `bash ./install.sh 1` as post-install to compile locally.
- Terminal and FloatinWindow display mode do not work: Linked to [this](https://github.com/michaelb/sniprun/issues/70) issue, no fix found yet.
- Jupyter-based interpreter fails: due to a race condition that may trigger on some computers, but too hard to fix for now.
- Jupyter-based interpreter fails: due to a race condition that may trigger on some computers, see (or open) related issues.

## Changelog
[Changelog](CHANGELOG.md)
Expand All @@ -436,6 +435,8 @@ It's super easy: see [contributing](CONTRIBUTING.md).
I actually thought out the project structure so you only have to worry about one file (yours), when creating an interpreter. All you have to do is copy the example.rs interpreter and modify some parts to suit the language you wish to support.



## Related projects

This project: [vscode-code-runner](https://github.com/formulahendry/vscode-code-runner) but sniprun is an attempt to make the same kind of plugin for Neovim, and more feature-complete. Actually, it already is (more complete, more extendable).
Expand All @@ -449,6 +450,8 @@ The [replvim](https://gitlab.com/HiPhish/repl.nvim) project, [vim-ipython-cell](
And many more projects, somewhat similar, but never quite, that I didn't notice or wanted to include.



#### **Why should you use sniprun instead of these alternatives?**

- **All-language support**. Sniprun can work with virtually any language, including compiled ones. If the language is not supported yet, anyone can create a sniprun interpreter for it!
Expand Down
2 changes: 1 addition & 1 deletion doc/sniprun.txt
Original file line number Diff line number Diff line change
Expand Up @@ -80,4 +80,4 @@ EOF
TROUBLESHOOTING *sniprun-troubleshooting*

If anything is not working; you should consult the README at github.com/michaelb/sniprun, as well as the
documentation for every interpreter through :SnipInfo <name>
documentation for every interpreter through :SnipInfo <name>, as well as the :checkhealth sniprun

0 comments on commit 513fa03

Please sign in to comment.