Skip to content

wight554/vscode-xonsh

Repository files navigation

Adds xonsh language support for VSCode Editor.

Features

  • Syntax Highlight

    • the tmLanguage file from MagicPython extension is used.

    • code snippets inside markdown files also work.

  • Autocompletion with Language server protocol.

    • pyls 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 pyls is installed and available on the $PATH
  • I recommend using pipx
pipx install 'python-language-server[all]'

Contributing

I have created this extension since there were none to support Xonsh. It is a superset of Python but has breaking syntax definition. So setting language mode as Python will list Syntax errors. This is just a start, adding basic syntax highlight. PRs are welcome. If we can add features from the Python extension it is great editor as well. Our aim is to make the Python extension support xonsh as well. It will happen only when it becomes popular enough.

  • 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 style should be used for commit messages as it is used to generate changelog.

Development

  • TypeScript is used to develop the extension
  yarn install
  yarn build # this will build the extension

Special thanks to

  • The extension sublime-cocnut does support coconut language. Which is also a superset of Python.

Links

Packages

No packages published

Languages

  • TypeScript 100.0%