https://github.com/freed-wu/sublime-syntax-language-server
language server and vim plugin for sublime-syntax and syntax-test.
https://github.com/freed-wu/sublime-syntax-language-server
lsp-server sublime-syntax
Last synced: 5 months ago
JSON representation
language server and vim plugin for sublime-syntax and syntax-test.
- Host: GitHub
- URL: https://github.com/freed-wu/sublime-syntax-language-server
- Owner: Freed-Wu
- License: gpl-3.0
- Created: 2023-06-19T08:24:21.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-21T20:24:42.000Z (over 1 year ago)
- Last Synced: 2024-10-22T14:43:21.859Z (over 1 year ago)
- Topics: lsp-server, sublime-syntax
- Language: Python
- Homepage: https://sublime-syntax-language-server.readthedocs.io/
- Size: 77.1 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# sublime-syntax-language-server
[](https://sublime-syntax-language-server.readthedocs.io)
[](https://results.pre-commit.ci/latest/github/Freed-Wu/sublime-syntax-language-server/main)
[](https://github.com/Freed-Wu/sublime-syntax-language-server/actions)
[](https://codecov.io/gh/Freed-Wu/sublime-syntax-language-server)
[](https://deepsource.io/gh/Freed-Wu/sublime-syntax-language-server)
[](https://github.com/Freed-Wu/sublime-syntax-language-server/releases)
[](https://github.com/Freed-Wu/sublime-syntax-language-server/releases/latest)
[](https://github.com/Freed-Wu/sublime-syntax-language-server/issues)
[](https://github.com/Freed-Wu/sublime-syntax-language-server/issues?q=is%3Aissue+is%3Aclosed)
[](https://github.com/Freed-Wu/sublime-syntax-language-server/pulls)
[](https://github.com/Freed-Wu/sublime-syntax-language-server/pulls?q=is%3Apr+is%3Aclosed)
[](https://github.com/Freed-Wu/sublime-syntax-language-server/discussions)
[](https://github.com/Freed-Wu/sublime-syntax-language-server/milestones)
[](https://github.com/Freed-Wu/sublime-syntax-language-server/network/members)
[](https://github.com/Freed-Wu/sublime-syntax-language-server/stargazers)
[](https://github.com/Freed-Wu/sublime-syntax-language-server/watchers)
[](https://github.com/Freed-Wu/sublime-syntax-language-server/graphs/contributors)
[](https://github.com/Freed-Wu/sublime-syntax-language-server/graphs/commit-activity)
[](https://github.com/Freed-Wu/sublime-syntax-language-server/commits)
[](https://github.com/Freed-Wu/sublime-syntax-language-server/releases/latest)
[](https://github.com/Freed-Wu/sublime-syntax-language-server/blob/main/LICENSE)
[](https://github.com/Freed-Wu/sublime-syntax-language-server)
[](https://github.com/Freed-Wu/sublime-syntax-language-server)
[](https://github.com/Freed-Wu/sublime-syntax-language-server)
[](https://github.com/Freed-Wu/sublime-syntax-language-server)
[](https://github.com/Freed-Wu/sublime-syntax-language-server)
[](https://github.com/Freed-Wu/sublime-syntax-language-server)
[](https://pypi.org/project/sublime-syntax-language-server/#description)
[](https://pypi.org/project/sublime-syntax-language-server/#history)
[](https://pypi.org/project/sublime-syntax-language-server/#files)
[](https://pypi.org/project/sublime-syntax-language-server/#files)
[](https://pypi.org/project/sublime-syntax-language-server/#files)
[](https://pypi.org/project/sublime-syntax-language-server/#files)
Language server and vim plugin for
[sublime-syntax](https://www.sublimetext.com/docs/syntax.html)
and
[syntax-test](https://www.sublimetext.com/docs/syntax.html#testing)'s
[scope names](https://www.sublimetext.com/docs/scope_naming.html).
sublime-syntax is a subtype of yaml. See
[json schema](https://www.schemastore.org/json)
to get support of yaml language server.
- [x] document hover
- [x] completion
- [x] diagnostic: requires [syntest](https://github.com/trishume/syntect)
For vim plugin:
- [x] ftplugin: commentstring, etc
- [x] compilers: bat, syntest
- [x] syntax highlight, include incorrect header
## Document Hover

## Completion

## Diagnostic

## Compilers
Install
- [syntest](https://github.com/trishume/syntect) for `syntax_test_*`
- [bat](https://github.com/sharkdp/bat) for `*.sublime-syntax`
### syntest
#### Build From Source
```sh
git clone --depth=1 https://github.com/trishume/syntect
cd syntect
cargo build --release --example syntest
sudo install -D target/release/examples/syntest -t /usr/local/bin
```
#### For Archlinux
```sh
yay -S syntest
```
## Syntax Highlight
Every syntax test file should have a correct header. If you input a typo, syntax
highlight will tell you:


If you input correct keyword of sublime syntax file, it will be highlighted as `Keyword`.
Note `watch` should be `match` and `strings` should be `string`:

## More usages
[`:help sublime-syntax`](doc/sublime-syntax.txt)
## Vim Plugin
You can use
[branch release](https://github.com/Freed-Wu/sublime-syntax-language-server/tree/release)
to avoid downloading unnecessary files for vim plugin. Such as for
[dein.vim](https://github.com/Shougo/dein.vim):
```vim
call dein#add('Freed-Wu/sublime-syntax-language-server', {
\ 'rev': 'release',
\ })
```