sublime-syntax-language-server


Namesublime-syntax-language-server JSON
Version 0.0.4 PyPI version JSON
download
home_page
Summarysublime-syntax language server
upload_time2023-09-05 10:01:41
maintainer
docs_urlNone
author
requires_python>=3.7
licenseGPL v3
keywords sublime-syntax language server
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # sublime-syntax-language-server

[![readthedocs](https://shields.io/readthedocs/sublime-syntax-language-server)](https://sublime-syntax-language-server.readthedocs.io)
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/Freed-Wu/sublime-syntax-language-server/main.svg)](https://results.pre-commit.ci/latest/github/Freed-Wu/sublime-syntax-language-server/main)
[![github/workflow](https://github.com/Freed-Wu/sublime-syntax-language-server/actions/workflows/main.yml/badge.svg)](https://github.com/Freed-Wu/sublime-syntax-language-server/actions)
[![codecov](https://codecov.io/gh/Freed-Wu/sublime-syntax-language-server/branch/main/graph/badge.svg)](https://codecov.io/gh/Freed-Wu/sublime-syntax-language-server)
[![DeepSource](https://deepsource.io/gh/Freed-Wu/sublime-syntax-language-server.svg/?show_trend=true)](https://deepsource.io/gh/Freed-Wu/sublime-syntax-language-server)

[![github/downloads](https://shields.io/github/downloads/Freed-Wu/sublime-syntax-language-server/total)](https://github.com/Freed-Wu/sublime-syntax-language-server/releases)
[![github/downloads/latest](https://shields.io/github/downloads/Freed-Wu/sublime-syntax-language-server/latest/total)](https://github.com/Freed-Wu/sublime-syntax-language-server/releases/latest)
[![github/issues](https://shields.io/github/issues/Freed-Wu/sublime-syntax-language-server)](https://github.com/Freed-Wu/sublime-syntax-language-server/issues)
[![github/issues-closed](https://shields.io/github/issues-closed/Freed-Wu/sublime-syntax-language-server)](https://github.com/Freed-Wu/sublime-syntax-language-server/issues?q=is%3Aissue+is%3Aclosed)
[![github/issues-pr](https://shields.io/github/issues-pr/Freed-Wu/sublime-syntax-language-server)](https://github.com/Freed-Wu/sublime-syntax-language-server/pulls)
[![github/issues-pr-closed](https://shields.io/github/issues-pr-closed/Freed-Wu/sublime-syntax-language-server)](https://github.com/Freed-Wu/sublime-syntax-language-server/pulls?q=is%3Apr+is%3Aclosed)
[![github/discussions](https://shields.io/github/discussions/Freed-Wu/sublime-syntax-language-server)](https://github.com/Freed-Wu/sublime-syntax-language-server/discussions)
[![github/milestones](https://shields.io/github/milestones/all/Freed-Wu/sublime-syntax-language-server)](https://github.com/Freed-Wu/sublime-syntax-language-server/milestones)
[![github/forks](https://shields.io/github/forks/Freed-Wu/sublime-syntax-language-server)](https://github.com/Freed-Wu/sublime-syntax-language-server/network/members)
[![github/stars](https://shields.io/github/stars/Freed-Wu/sublime-syntax-language-server)](https://github.com/Freed-Wu/sublime-syntax-language-server/stargazers)
[![github/watchers](https://shields.io/github/watchers/Freed-Wu/sublime-syntax-language-server)](https://github.com/Freed-Wu/sublime-syntax-language-server/watchers)
[![github/contributors](https://shields.io/github/contributors/Freed-Wu/sublime-syntax-language-server)](https://github.com/Freed-Wu/sublime-syntax-language-server/graphs/contributors)
[![github/commit-activity](https://shields.io/github/commit-activity/w/Freed-Wu/sublime-syntax-language-server)](https://github.com/Freed-Wu/sublime-syntax-language-server/graphs/commit-activity)
[![github/last-commit](https://shields.io/github/last-commit/Freed-Wu/sublime-syntax-language-server)](https://github.com/Freed-Wu/sublime-syntax-language-server/commits)
[![github/release-date](https://shields.io/github/release-date/Freed-Wu/sublime-syntax-language-server)](https://github.com/Freed-Wu/sublime-syntax-language-server/releases/latest)

[![github/license](https://shields.io/github/license/Freed-Wu/sublime-syntax-language-server)](https://github.com/Freed-Wu/sublime-syntax-language-server/blob/main/LICENSE)
[![github/languages](https://shields.io/github/languages/count/Freed-Wu/sublime-syntax-language-server)](https://github.com/Freed-Wu/sublime-syntax-language-server)
[![github/languages/top](https://shields.io/github/languages/top/Freed-Wu/sublime-syntax-language-server)](https://github.com/Freed-Wu/sublime-syntax-language-server)
[![github/directory-file-count](https://shields.io/github/directory-file-count/Freed-Wu/sublime-syntax-language-server)](https://github.com/Freed-Wu/sublime-syntax-language-server)
[![github/code-size](https://shields.io/github/languages/code-size/Freed-Wu/sublime-syntax-language-server)](https://github.com/Freed-Wu/sublime-syntax-language-server)
[![github/repo-size](https://shields.io/github/repo-size/Freed-Wu/sublime-syntax-language-server)](https://github.com/Freed-Wu/sublime-syntax-language-server)
[![github/v](https://shields.io/github/v/release/Freed-Wu/sublime-syntax-language-server)](https://github.com/Freed-Wu/sublime-syntax-language-server)

[![pypi/status](https://shields.io/pypi/status/sublime-syntax-language-server)](https://pypi.org/project/sublime-syntax-language-server/#description)
[![pypi/v](https://shields.io/pypi/v/sublime-syntax-language-server)](https://pypi.org/project/sublime-syntax-language-server/#history)
[![pypi/downloads](https://shields.io/pypi/dd/sublime-syntax-language-server)](https://pypi.org/project/sublime-syntax-language-server/#files)
[![pypi/format](https://shields.io/pypi/format/sublime-syntax-language-server)](https://pypi.org/project/sublime-syntax-language-server/#files)
[![pypi/implementation](https://shields.io/pypi/implementation/sublime-syntax-language-server)](https://pypi.org/project/sublime-syntax-language-server/#files)
[![pypi/pyversions](https://shields.io/pypi/pyversions/sublime-syntax-language-server)](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

![Document Hover](https://user-images.githubusercontent.com/32936898/246753924-17f4063c-3f2c-4956-b60a-996d351ccb79.jpg)

## Completion

![Completion](https://user-images.githubusercontent.com/32936898/246778261-76ca6d66-0e1d-4184-a7d7-2660ba79008c.jpg)

## Diagnostic

![Diagnostic](https://user-images.githubusercontent.com/32936898/194603713-1dbc6a4c-cd9a-4894-8cd0-bae0563fa176.png)

## 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:

![Correct](https://user-images.githubusercontent.com/32936898/194894921-0f9167a8-a297-4719-986f-93298111963a.png)

![Incorrect](https://user-images.githubusercontent.com/32936898/194894923-9b82fd5f-2f13-4651-abe5-1a645e737671.png)

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`:

![Keyword](https://user-images.githubusercontent.com/32936898/195125476-59f056e1-7001-4aa9-b2ba-62a8fd0e0d2e.png)

## 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[![readthedocs](https://shields.io/readthedocs/sublime-syntax-language-server)](https://sublime-syntax-language-server.readthedocs.io)\n[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/Freed-Wu/sublime-syntax-language-server/main.svg)](https://results.pre-commit.ci/latest/github/Freed-Wu/sublime-syntax-language-server/main)\n[![github/workflow](https://github.com/Freed-Wu/sublime-syntax-language-server/actions/workflows/main.yml/badge.svg)](https://github.com/Freed-Wu/sublime-syntax-language-server/actions)\n[![codecov](https://codecov.io/gh/Freed-Wu/sublime-syntax-language-server/branch/main/graph/badge.svg)](https://codecov.io/gh/Freed-Wu/sublime-syntax-language-server)\n[![DeepSource](https://deepsource.io/gh/Freed-Wu/sublime-syntax-language-server.svg/?show_trend=true)](https://deepsource.io/gh/Freed-Wu/sublime-syntax-language-server)\n\n[![github/downloads](https://shields.io/github/downloads/Freed-Wu/sublime-syntax-language-server/total)](https://github.com/Freed-Wu/sublime-syntax-language-server/releases)\n[![github/downloads/latest](https://shields.io/github/downloads/Freed-Wu/sublime-syntax-language-server/latest/total)](https://github.com/Freed-Wu/sublime-syntax-language-server/releases/latest)\n[![github/issues](https://shields.io/github/issues/Freed-Wu/sublime-syntax-language-server)](https://github.com/Freed-Wu/sublime-syntax-language-server/issues)\n[![github/issues-closed](https://shields.io/github/issues-closed/Freed-Wu/sublime-syntax-language-server)](https://github.com/Freed-Wu/sublime-syntax-language-server/issues?q=is%3Aissue+is%3Aclosed)\n[![github/issues-pr](https://shields.io/github/issues-pr/Freed-Wu/sublime-syntax-language-server)](https://github.com/Freed-Wu/sublime-syntax-language-server/pulls)\n[![github/issues-pr-closed](https://shields.io/github/issues-pr-closed/Freed-Wu/sublime-syntax-language-server)](https://github.com/Freed-Wu/sublime-syntax-language-server/pulls?q=is%3Apr+is%3Aclosed)\n[![github/discussions](https://shields.io/github/discussions/Freed-Wu/sublime-syntax-language-server)](https://github.com/Freed-Wu/sublime-syntax-language-server/discussions)\n[![github/milestones](https://shields.io/github/milestones/all/Freed-Wu/sublime-syntax-language-server)](https://github.com/Freed-Wu/sublime-syntax-language-server/milestones)\n[![github/forks](https://shields.io/github/forks/Freed-Wu/sublime-syntax-language-server)](https://github.com/Freed-Wu/sublime-syntax-language-server/network/members)\n[![github/stars](https://shields.io/github/stars/Freed-Wu/sublime-syntax-language-server)](https://github.com/Freed-Wu/sublime-syntax-language-server/stargazers)\n[![github/watchers](https://shields.io/github/watchers/Freed-Wu/sublime-syntax-language-server)](https://github.com/Freed-Wu/sublime-syntax-language-server/watchers)\n[![github/contributors](https://shields.io/github/contributors/Freed-Wu/sublime-syntax-language-server)](https://github.com/Freed-Wu/sublime-syntax-language-server/graphs/contributors)\n[![github/commit-activity](https://shields.io/github/commit-activity/w/Freed-Wu/sublime-syntax-language-server)](https://github.com/Freed-Wu/sublime-syntax-language-server/graphs/commit-activity)\n[![github/last-commit](https://shields.io/github/last-commit/Freed-Wu/sublime-syntax-language-server)](https://github.com/Freed-Wu/sublime-syntax-language-server/commits)\n[![github/release-date](https://shields.io/github/release-date/Freed-Wu/sublime-syntax-language-server)](https://github.com/Freed-Wu/sublime-syntax-language-server/releases/latest)\n\n[![github/license](https://shields.io/github/license/Freed-Wu/sublime-syntax-language-server)](https://github.com/Freed-Wu/sublime-syntax-language-server/blob/main/LICENSE)\n[![github/languages](https://shields.io/github/languages/count/Freed-Wu/sublime-syntax-language-server)](https://github.com/Freed-Wu/sublime-syntax-language-server)\n[![github/languages/top](https://shields.io/github/languages/top/Freed-Wu/sublime-syntax-language-server)](https://github.com/Freed-Wu/sublime-syntax-language-server)\n[![github/directory-file-count](https://shields.io/github/directory-file-count/Freed-Wu/sublime-syntax-language-server)](https://github.com/Freed-Wu/sublime-syntax-language-server)\n[![github/code-size](https://shields.io/github/languages/code-size/Freed-Wu/sublime-syntax-language-server)](https://github.com/Freed-Wu/sublime-syntax-language-server)\n[![github/repo-size](https://shields.io/github/repo-size/Freed-Wu/sublime-syntax-language-server)](https://github.com/Freed-Wu/sublime-syntax-language-server)\n[![github/v](https://shields.io/github/v/release/Freed-Wu/sublime-syntax-language-server)](https://github.com/Freed-Wu/sublime-syntax-language-server)\n\n[![pypi/status](https://shields.io/pypi/status/sublime-syntax-language-server)](https://pypi.org/project/sublime-syntax-language-server/#description)\n[![pypi/v](https://shields.io/pypi/v/sublime-syntax-language-server)](https://pypi.org/project/sublime-syntax-language-server/#history)\n[![pypi/downloads](https://shields.io/pypi/dd/sublime-syntax-language-server)](https://pypi.org/project/sublime-syntax-language-server/#files)\n[![pypi/format](https://shields.io/pypi/format/sublime-syntax-language-server)](https://pypi.org/project/sublime-syntax-language-server/#files)\n[![pypi/implementation](https://shields.io/pypi/implementation/sublime-syntax-language-server)](https://pypi.org/project/sublime-syntax-language-server/#files)\n[![pypi/pyversions](https://shields.io/pypi/pyversions/sublime-syntax-language-server)](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![Document Hover](https://user-images.githubusercontent.com/32936898/246753924-17f4063c-3f2c-4956-b60a-996d351ccb79.jpg)\n\n## Completion\n\n![Completion](https://user-images.githubusercontent.com/32936898/246778261-76ca6d66-0e1d-4184-a7d7-2660ba79008c.jpg)\n\n## Diagnostic\n\n![Diagnostic](https://user-images.githubusercontent.com/32936898/194603713-1dbc6a4c-cd9a-4894-8cd0-bae0563fa176.png)\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![Correct](https://user-images.githubusercontent.com/32936898/194894921-0f9167a8-a297-4719-986f-93298111963a.png)\n\n![Incorrect](https://user-images.githubusercontent.com/32936898/194894923-9b82fd5f-2f13-4651-abe5-1a645e737671.png)\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![Keyword](https://user-images.githubusercontent.com/32936898/195125476-59f056e1-7001-4aa9-b2ba-62a8fd0e0d2e.png)\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"
}
        
Elapsed time: 0.11046s