Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jnoortheen/vscode-xonsh
VSCode extension for Xonsh language support
https://github.com/jnoortheen/vscode-xonsh
vscode-extension xonsh xonshrc
Last synced: 3 months ago
JSON representation
VSCode extension for Xonsh language support
- Host: GitHub
- URL: https://github.com/jnoortheen/vscode-xonsh
- Owner: jnoortheen
- License: mit
- Created: 2020-10-06T19:46:14.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-12-01T08:52:35.000Z (about 1 year ago)
- Last Synced: 2024-10-11T23:48:52.900Z (4 months ago)
- Topics: vscode-extension, xonsh, xonshrc
- Language: TypeScript
- Homepage: https://marketplace.visualstudio.com/items?itemName=jnoortheen.xonsh
- Size: 818 KB
- Stars: 16
- Watchers: 2
- Forks: 4
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
If you like the template click ⭐ on the repo.
# Overview
Adds [xonsh](https://xon.sh/) language support for VSCode Editor.
## Features
* Syntax Highlight
+ the tmLanguage file from [MagicPython](https://github.com/MagicStack/MagicPython/blob/master/grammars/src/MagicPython.syntax.yaml) extension is used.
+ code snippets inside `markdown` files also work.
* Other IDE like features using Language server protocol.
+ [pylsp](https://github.com/python-lsp/python-lsp-server) is used for jedi completion.
## Installation
### Visual Studio Code
Hit `F1` and enter the `ext install jnoortheen.xonsh` command or search for `xonsh` .
### Python-language-server
* Make sure that [ `pylsp` ](https://github.com/python-lsp/python-lsp-server) is installed and available on the `$PATH`
* I recommend using [pipx](https://github.com/pipxproject/pipx/)
```sh
pipx install 'python-lsp-server[all]'
```
* Previous versions of this extension used the [ older `pyls` ](https://github.com/palantir/python-language-server/) by Palantir. Further development is taking place in the community fork [pylsp](https://github.com/python-lsp/python-lsp-server). Due to the way configuration variables are handled, this extension is NOT backwards compatible with `pyls`. If you must use `pyls`, please downgrade to version 0.1.13.
## Contributing
I have created this extension since there were none to support Xonsh. PRs are welcome to add new features/fixes.
Please make sure that you
* Document the purpose of functions and classes.
* When adding a new feature, please mention it in the `README.md` Features section. Use screenshots when applicable.
* [Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/) style should be used for commit messages as it is used to generate changelog.
## Development
* TypeScript is used to develop the extension
```sh
yarn install
yarn build # this will build the extension
```
* check [Extension Quickstart](./vsc-extension-quickstart.md)
* husky is used for git hooks
## Release
```sh
yarn release
```
* Github CI is configured to publish the extensions to VSCode and OpenVSCode registries
---
Special thanks to
* The extension [sublime-coconut](https://github.com/evhub/sublime-coconut) does support coconut language. Which is also a superset of Python.
## Links
* [Extension page](https://marketplace.visualstudio.com/items?itemName=jnoortheen.xonsh)