Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zephir-lang/zephir-vscode
Zephir syntax support for VSCode
https://github.com/zephir-lang/zephir-vscode
editor-plugin vscode zephir zephir-vscode
Last synced: 16 days ago
JSON representation
Zephir syntax support for VSCode
- Host: GitHub
- URL: https://github.com/zephir-lang/zephir-vscode
- Owner: zephir-lang
- License: mit
- Created: 2017-12-21T23:19:09.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2019-09-27T10:31:59.000Z (over 5 years ago)
- Last Synced: 2024-11-08T20:26:26.380Z (2 months ago)
- Topics: editor-plugin, vscode, zephir, zephir-vscode
- Homepage: https://zephir-lang.com
- Size: 222 KB
- Stars: 6
- Watchers: 7
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Zephir for VSCode
[](https://opensource.org/licenses/MIT)
[](https://marketplace.visualstudio.com/items?itemName=zephir-lang.zephir)
[](https://marketplace.visualstudio.com/items?itemName=zephir-lang.zephir)
[](https://marketplace.visualstudio.com/items?itemName=zephir-lang.zephir)
[Zephir Language](https://zephir-lang.com) syntax highlighting and snippets for VSCode.
---
[Become a sponsor](https://opencollective.com/phalcon#sponsor) | [Become a backer](https://opencollective.com/phalcon#backer).
## Features [↑](#zephir-for-vscode)
* Highlighting
- [x] Basic highlighting
- [x] Advanced syntax highlighting for Zephir
* Editing
- [x] Completion and snippets
- [x] Smart Bracket Matching
- [x] Smart indent rules
* Navigation
- [x] [Regions Folding](https://code.visualstudio.com/docs/editor/codebasics#_folding) by markers:
- `// #region` and `// #endregion`
- `// ` and `// `
## Getting Started [↑](#zephir-for-vscode)
You can install this extension through the [Visual Studio Code Marketplace](https://marketplace.visualstudio.com/items?itemName=zephir-lang.zephir).
## Recommended Syntax Themes [↑](#zephir-for-vscode)
Although syntax highlighting should display well in most themes we recommend and test with the following:
* [Atom One Dark](https://marketplace.visualstudio.com/items?itemName=freebroccolo.theme-atom-one-dark)
* Dark+ (default theme)
* [Zephyr](https://marketplace.visualstudio.com/items?itemName=atrX.vscode-zephyr-theme)
* Monokai (bundled with VSCode)
* [Oceanic Next](https://marketplace.visualstudio.com/items?itemName=naumovs.theme-oceanicnext)
## Installation [↑](#zephir-for-vscode)
### Using VSCode Command Pallete [↑](#zephir-for-vscode)
Open the *Command Pallete*:
* 
[Linux][linux-kbd] Ctrl + Shift + P
* 
[macOS][macos-kbd] Cmd + Shift + P
* 
[Windows][windows-kbd] Ctrl + Shift + P
Then type "Install Extensions" and hit Enter. Finally find "Zephir for VSCode" and hit Enter.
Once the extension is installed, reload VSCode.
### Packaged VSIX Extension [↑](#zephir-for-vscode)
[Download the latest .vsix release](https://github.com/zephir-lang/zephir-vscode/releases/latest) file from the GitHub repository
and install it from the command line:
```sh
code --install-extension zephir-*.*.*.vsix
```
or from within VS Code by launching *Quick Open* and running the *Install from VSIX...* command.
Once the extension is installed, reload VSCode.
### GitHub Repository Clone [↑](#zephir-for-vscode)
Change to your `.vscode/extensions` [VSCode extensions directory](https://code.visualstudio.com/docs/extensions/install-extension#_side-loading).
Depending on your platform it is located in the following folders:
* `$HOME/.vscode/extensions`
* `$HOME/.vscode/extensions`
* `%USERPROFILE%\.vscode\extensions`
Clone extension repository as `zephir-lang.zephir`:
```sh
git clone https://github.com/zephir-lang/zephir-vscode.git zephir-lang.zephir
```
Once the extension is cloned, reload VSCode.
## Contributing [↑](#zephir-for-vscode)
The source for this extension is available on [GitHub](https://github.com/zephir-lang/zephir-vscode). If anyone feels that there is
something missing or would like to suggest improvements please [open a new issue](https://github.com/zephir-lang/zephir-vscode/issues)
or send a pull request. Instructions for running/debugging extensions locally [here](https://code.visualstudio.com/docs/extensions/overview).
## Discussion [↑](#zephir-for-vscode)
There is an `#editorsupport` channel on the Phalcon [Discord Server](https://discord.gg/PNFsSsr).
If you would like to discuss an idea or need help or have other feedback you can usually find me (`@klay`) idling there.
## License [↑](#zephir-for-vscode)
The "Zephir for VSCode" is open source software licensed under the MIT License.
See the [LICENSE](https://github.com/zephir-lang/zephir-vscode/blob/master/LICENSE) file for more.
---
Copyright © 2017-2019 Zephir Team
[linux-kbd]: https://code.visualstudio.com/shortcuts/keyboard-shortcuts-linux.pdf
[macos-kbd]: https://code.visualstudio.com/shortcuts/keyboard-shortcuts-macos.pdf
[windows-kbd]: https://code.visualstudio.com/shortcuts/keyboard-shortcuts-windows.pdf