Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/neomutt/lsp-tree-sitter
A library to create language servers.
https://github.com/neomutt/lsp-tree-sitter
json-schema language-server-protocol tree-sitter
Last synced: 1 day ago
JSON representation
A library to create language servers.
- Host: GitHub
- URL: https://github.com/neomutt/lsp-tree-sitter
- Owner: neomutt
- License: gpl-3.0
- Created: 2023-06-19T15:04:15.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-29T10:34:29.000Z (4 months ago)
- Last Synced: 2024-03-01T09:18:05.321Z (4 months ago)
- Topics: json-schema, language-server-protocol, tree-sitter
- Language: Python
- Homepage: https://lsp-tree-sitter.readthedocs.io/
- Size: 190 KB
- Stars: 30
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Lists
- stars - neomutt/lsp-tree-sitter
README
# lsp-tree-sitter
[](https://lsp-tree-sitter.readthedocs.io)
[](https://results.pre-commit.ci/latest/github/neomutt/lsp-tree-sitter/main)
[](https://github.com/neomutt/lsp-tree-sitter/actions)
[](https://codecov.io/gh/neomutt/lsp-tree-sitter)
[](https://deepsource.io/gh/neomutt/lsp-tree-sitter)
[](https://github.com/neomutt/lsp-tree-sitter/releases)
[](https://github.com/neomutt/lsp-tree-sitter/releases/latest)
[](https://github.com/neomutt/lsp-tree-sitter/issues)
[](https://github.com/neomutt/lsp-tree-sitter/issues?q=is%3Aissue+is%3Aclosed)
[](https://github.com/neomutt/lsp-tree-sitter/pulls)
[](https://github.com/neomutt/lsp-tree-sitter/pulls?q=is%3Apr+is%3Aclosed)
[](https://github.com/neomutt/lsp-tree-sitter/discussions)
[](https://github.com/neomutt/lsp-tree-sitter/milestones)
[](https://github.com/neomutt/lsp-tree-sitter/network/members)
[](https://github.com/neomutt/lsp-tree-sitter/stargazers)
[](https://github.com/neomutt/lsp-tree-sitter/watchers)
[](https://github.com/neomutt/lsp-tree-sitter/graphs/contributors)
[](https://github.com/neomutt/lsp-tree-sitter/graphs/commit-activity)
[](https://github.com/neomutt/lsp-tree-sitter/commits)
[](https://github.com/neomutt/lsp-tree-sitter/releases/latest)
[](https://github.com/neomutt/lsp-tree-sitter/blob/main/LICENSE)
[](https://github.com/neomutt/lsp-tree-sitter)
[](https://github.com/neomutt/lsp-tree-sitter)
[](https://github.com/neomutt/lsp-tree-sitter)
[](https://github.com/neomutt/lsp-tree-sitter)
[](https://github.com/neomutt/lsp-tree-sitter)
[](https://github.com/neomutt/lsp-tree-sitter)
[](https://pypi.org/project/lsp-tree-sitter/#description)
[](https://pypi.org/project/lsp-tree-sitter/#history)
[](https://pypi.org/project/lsp-tree-sitter/#files)
[](https://pypi.org/project/lsp-tree-sitter/#files)
[](https://pypi.org/project/lsp-tree-sitter/#files)
[](https://pypi.org/project/lsp-tree-sitter/#files)
A core library to support language servers.
I write many language servers and they share some same code so I extract the
shared code to this library.
I've had enough of writing many DSLs in my editor without any LSP support
(completion, hover, ...). So I decide to sacrifice my time to do this work.
## Language servers
- [termux-language-server](https://github.com/termux/termux-language-server/):
for some specific bash scripts:
- [`build.sh`](https://github.com/termux/termux-packages/wiki/Creating-new-package)
- [`PKGBUILD`](https://wiki.archlinux.org/title/PKGBUILD)
- [`*.ebuild`](https://dev.gentoo.org/~zmedico/portage/doc/man/ebuild.5.html)
- ...
- [mutt-language-server](https://github.com/neomutt/mutt-language-server):
for [(neo)mutt](https://github.com/neomutt/neomutt)'s (neo)muttrc
- [More](https://github.com/Freed-Wu?tab=repositories&q=lsp-server)
## Usage
### Schema
A `Trie` to convert a file to a json, then you can use json schema to validate
it to get diagnostics.
Take
[termux-language-server](https://github.com/termux/termux-language-server/) as
an example.
`PKGBUILD`:
```sh
pkgname=hello
pkgver=0.0.1
pkgrel=1
pkgdesc="hello"
arch=(wrong_arch)
license=(GPL3)
build() {
cat < hello
#!/usr/bin/env sh
echo hello
EOF
}
package() {
install -D hello -t $pkgdir/usr/bin
}
```
```sh
termux-language-server --convert PKGBUILD
```
```json
{
"pkgname": "hello",
"pkgver": "0.0.1",
"pkgrel": "1",
"pkgdesc": "hello",
"arch": [
"wrong_arch"
],
"license": [
"GPL3"
],
"build": 0,
"package": 0
}
```
So, we can validate the json by [a json schema](https://github.com/termux/termux-language-server/tree/main/src/termux_language_server/assets/json):
```sh
$ termux-language-server --check PKGBUILD
PKGBUILD:5:7-5:17:error: 'wrong_arch' is not one of ['any', 'pentium4', 'i486', 'i686', 'x86_64', 'x86_64_v3', 'arm', 'armv6h', 'armv7h', 'armv8', 'aarch64']
```
Sometimes it will be more complicated:
`neomuttrc`:
```neomuttrc
set allow_ansi=yes sleep_time = no ispell = aspell
set query_command = 'mutt_ldap_query.pl %s'
```
```sh
mutt-language-server --convert neomuttrc
```
```json
{
"set": {
"allow_ansi": "yes",
"sleep_time": "no",
"ispell": "aspell",
"query_command": "mutt_ldap_query.pl %s"
}
}
```
```sh
$ mutt-language-server --check neomuttrc
neomuttrc:1:33-1:35:error: 'no' is not of type 'number'
```
We put the result to the json's `.set` not `.` just in order to reserve the
other keys for other usages.
### Finders
Some finders to find the required node in tree-sitter's AST.
Such as, if you want to get the node under the cursor:
```python
@self.feature(TEXT_DOCUMENT_COMPLETION)
def completions(params: CompletionParams) -> CompletionList:
document = self.workspace.get_document(params.text_document.uri)
uni = PositionFinder(params.position, right_equal=True).find(
document.uri, self.trees[document.uri]
)
# ...
```
UNI (Universal Node Identifier) is URI + node.
### Utilities
This library also provides many utility functions. Such as converting man page to
markdown and tokenizing it in order to generate the json schema.
```sh
mutt-language-server --generate-schema neomuttrc
```
````json
{
"$id": "https://github.com/neomutt/mutt-language-server/blob/main/src/termux_language_server/assets/json/neomuttrc.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"$comment": "Don't edit this file directly! It is generated by `mutt-language-server --generate-schema=neomuttrc`.",
"type": "object",
"properties": {
"account-hook": {
"description": "```neomuttrc\naccount-hook regex command\n```\nThis hook is executed whenever you access a remote mailbox. Useful to adjust configuration settings to different IMAP or POP servers."
},
"$comment": "..."
}
}
````
## References
- some [Chinese blogs](https://freed-wu.github.io/tag/lsp/) about how I write
these language servers
- [tree-sitter](https://tree-sitter.github.io/tree-sitter/)
- [language server protocol](https://microsoft.github.io/language-server-protocol/specifications/specification-current)
- [json schema](https://json-schema.org/specification)