# 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',
\ })
```
Raw data
{
"_id": null,
"home_page": "",
"name": "sublime-syntax-language-server",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "sublime-syntax,language server",
"author": "",
"author_email": "Wu Zhenyu <wuzhenyu@ustc.edu>",
"download_url": "https://files.pythonhosted.org/packages/40/0e/8c6ea966a52e5848ef28ec2077fbab3f839cb4445f514be04a29dde83033/sublime-syntax-language-server-0.0.4.tar.gz",
"platform": null,
"description": "# sublime-syntax-language-server\n\n[](https://sublime-syntax-language-server.readthedocs.io)\n[](https://results.pre-commit.ci/latest/github/Freed-Wu/sublime-syntax-language-server/main)\n[](https://github.com/Freed-Wu/sublime-syntax-language-server/actions)\n[](https://codecov.io/gh/Freed-Wu/sublime-syntax-language-server)\n[](https://deepsource.io/gh/Freed-Wu/sublime-syntax-language-server)\n\n[](https://github.com/Freed-Wu/sublime-syntax-language-server/releases)\n[](https://github.com/Freed-Wu/sublime-syntax-language-server/releases/latest)\n[](https://github.com/Freed-Wu/sublime-syntax-language-server/issues)\n[](https://github.com/Freed-Wu/sublime-syntax-language-server/issues?q=is%3Aissue+is%3Aclosed)\n[](https://github.com/Freed-Wu/sublime-syntax-language-server/pulls)\n[](https://github.com/Freed-Wu/sublime-syntax-language-server/pulls?q=is%3Apr+is%3Aclosed)\n[](https://github.com/Freed-Wu/sublime-syntax-language-server/discussions)\n[](https://github.com/Freed-Wu/sublime-syntax-language-server/milestones)\n[](https://github.com/Freed-Wu/sublime-syntax-language-server/network/members)\n[](https://github.com/Freed-Wu/sublime-syntax-language-server/stargazers)\n[](https://github.com/Freed-Wu/sublime-syntax-language-server/watchers)\n[](https://github.com/Freed-Wu/sublime-syntax-language-server/graphs/contributors)\n[](https://github.com/Freed-Wu/sublime-syntax-language-server/graphs/commit-activity)\n[](https://github.com/Freed-Wu/sublime-syntax-language-server/commits)\n[](https://github.com/Freed-Wu/sublime-syntax-language-server/releases/latest)\n\n[](https://github.com/Freed-Wu/sublime-syntax-language-server/blob/main/LICENSE)\n[](https://github.com/Freed-Wu/sublime-syntax-language-server)\n[](https://github.com/Freed-Wu/sublime-syntax-language-server)\n[](https://github.com/Freed-Wu/sublime-syntax-language-server)\n[](https://github.com/Freed-Wu/sublime-syntax-language-server)\n[](https://github.com/Freed-Wu/sublime-syntax-language-server)\n[](https://github.com/Freed-Wu/sublime-syntax-language-server)\n\n[](https://pypi.org/project/sublime-syntax-language-server/#description)\n[](https://pypi.org/project/sublime-syntax-language-server/#history)\n[](https://pypi.org/project/sublime-syntax-language-server/#files)\n[](https://pypi.org/project/sublime-syntax-language-server/#files)\n[](https://pypi.org/project/sublime-syntax-language-server/#files)\n[](https://pypi.org/project/sublime-syntax-language-server/#files)\n\nLanguage server and vim plugin for\n[sublime-syntax](https://www.sublimetext.com/docs/syntax.html)\nand\n[syntax-test](https://www.sublimetext.com/docs/syntax.html#testing)'s\n[scope names](https://www.sublimetext.com/docs/scope_naming.html).\n\nsublime-syntax is a subtype of yaml. See\n[json schema](https://www.schemastore.org/json)\nto get support of yaml language server.\n\n- [x] document hover\n- [x] completion\n- [x] diagnostic: requires [syntest](https://github.com/trishume/syntect)\n\nFor vim plugin:\n\n- [x] ftplugin: commentstring, etc\n- [x] compilers: bat, syntest\n- [x] syntax highlight, include incorrect header\n\n## Document Hover\n\n\n\n## Completion\n\n\n\n## Diagnostic\n\n\n\n## Compilers\n\nInstall\n\n- [syntest](https://github.com/trishume/syntect) for `syntax_test_*`\n- [bat](https://github.com/sharkdp/bat) for `*.sublime-syntax`\n\n### syntest\n\n#### Build From Source\n\n```sh\ngit clone --depth=1 https://github.com/trishume/syntect\ncd syntect\ncargo build --release --example syntest\nsudo install -D target/release/examples/syntest -t /usr/local/bin\n```\n\n#### For Archlinux\n\n```sh\nyay -S syntest\n```\n\n## Syntax Highlight\n\nEvery syntax test file should have a correct header. If you input a typo, syntax\nhighlight will tell you:\n\n\n\n\n\nIf you input correct keyword of sublime syntax file, it will be highlighted as `Keyword`.\nNote `watch` should be `match` and `strings` should be `string`:\n\n\n\n## More usages\n\n[`:help sublime-syntax`](doc/sublime-syntax.txt)\n\n## Vim Plugin\n\nYou can use\n[branch release](https://github.com/Freed-Wu/sublime-syntax-language-server/tree/release)\nto avoid downloading unnecessary files for vim plugin. Such as for\n[dein.vim](https://github.com/Shougo/dein.vim):\n\n```vim\ncall dein#add('Freed-Wu/sublime-syntax-language-server', {\n \\ 'rev': 'release',\n \\ })\n```\n",
"bugtrack_url": null,
"license": "GPL v3",
"summary": "sublime-syntax language server",
"version": "0.0.4",
"project_urls": {
"Bug Report": "https://github.com/Freed-Wu/sublime-syntax-language-server/issues",
"Download": "https://github.com/Freed-Wu/sublime-syntax-language-server/releases",
"Homepage": "https://sublime-syntax-language-server.readthedocs.io",
"Source": "https://github.com/Freed-Wu/sublime-syntax-language-server"
},
"split_keywords": [
"sublime-syntax",
"language server"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "457e62f8eb01e9aa5e5b1b96be8c1da881bedb275259898f42f2fb8758310f6d",
"md5": "a46c1d9280abae9ac28360ffe7a6a622",
"sha256": "8acb79eeeb4c2a14c37a2cf7a7950f5939d383a8b6114c955ef30b2a41fdb8ea"
},
"downloads": -1,
"filename": "sublime_syntax_language_server-0.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a46c1d9280abae9ac28360ffe7a6a622",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 29880,
"upload_time": "2023-09-05T10:01:40",
"upload_time_iso_8601": "2023-09-05T10:01:40.113126Z",
"url": "https://files.pythonhosted.org/packages/45/7e/62f8eb01e9aa5e5b1b96be8c1da881bedb275259898f42f2fb8758310f6d/sublime_syntax_language_server-0.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "400e8c6ea966a52e5848ef28ec2077fbab3f839cb4445f514be04a29dde83033",
"md5": "d5ae747e74353f635780617b96a4c822",
"sha256": "6c2de056c8c931c700e6fc5dc15ebf0cd4e7f35f91080a6b8cb801310023cb3b"
},
"downloads": -1,
"filename": "sublime-syntax-language-server-0.0.4.tar.gz",
"has_sig": false,
"md5_digest": "d5ae747e74353f635780617b96a4c822",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 50558,
"upload_time": "2023-09-05T10:01:41",
"upload_time_iso_8601": "2023-09-05T10:01:41.713880Z",
"url": "https://files.pythonhosted.org/packages/40/0e/8c6ea966a52e5848ef28ec2077fbab3f839cb4445f514be04a29dde83033/sublime-syntax-language-server-0.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-05 10:01:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Freed-Wu",
"github_project": "sublime-syntax-language-server",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "sublime-syntax-language-server"
}