https://github.com/avast/yls
YARA Language Server
https://github.com/avast/yls
avast lsp-server python3 vscode yara
Last synced: about 1 year ago
JSON representation
YARA Language Server
- Host: GitHub
- URL: https://github.com/avast/yls
- Owner: avast
- License: mit
- Created: 2022-06-08T10:21:23.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2025-03-10T14:37:54.000Z (over 1 year ago)
- Last Synced: 2025-03-28T19:08:24.498Z (about 1 year ago)
- Topics: avast, lsp-server, python3, vscode, yara
- Language: Python
- Homepage: https://avast.github.io/yls/
- Size: 1.44 MB
- Stars: 69
- Watchers: 5
- Forks: 12
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-yara - YLS
README
# YLS
[Language server](https://microsoft.github.io/language-server-protocol/) for
[YARA](https://yara.readthedocs.io/en/stable/) language.
:rocket: Features:
- Code completion of all available modules (including function parameters)
- Function documentation for hovers and code completion
- Opinionated code formatting
- Signature help
- Linting
- Go-to definition and references
- Symbol highlighting under the cursor
- Debugging using [yari](https://github.com/avast/yari)
- ...
For more information, check out:
- [Blog post](https://engineering.avast.io/yls-first-step-towards-yara-development-environment/)
- [Wiki](https://www.github.com/avast/yls/wiki)
:snake: Minimal supported version of Python is `3.8`.
## Installation
To setup your environment please follow instructions on
[wiki](https://github.com/avast/yls/wiki/How-to-setup).
## How to develop
Install YLS in development mode with all necessary dependencies.
```bash
poetry install
```
### Tests
You can run tests with the following command:
```bash
poetry run pytest
```
## License
Copyright (c) 2022 Avast Software, licensed under the MIT license. See the
[`LICENSE`](https://github.com/avast/yls/blob/master/LICENSE) file for more
details.
YLS and its related projects uses third-party libraries or other resources
listed, along with their licenses, in the
[`LICENSE-THIRD-PARTY`](https://github.com/avast/yls/blob/master/LICENSE-THIRD-PARTY)
file.
## FAQ
### Why are you using `pluggy`?
Some parts depend on our internal services, however we are working on making
most of the code available. This is just the first piece.