IDE tools for writing pest grammars, using the Language Server Protocol for Visual Studio Code, Vim and other editors

pest

Last update: Apr 8, 2023

Related tags

IDEs vim extension language-server ide vscode language-server-protocol vscode-extension pest lsp

Overview

Pest IDE Tools

IDE support for Pest, via the LSP.

This repository contains an implementation of the Language Server Protocol in Rust, for the Pest parser generator.

Features

Error reporting.
Warnings for unused rules.
Syntax highlighting definitions available.
Rename rules.
Go to rule declaration, definition, or references.
Hover information for built-in rules and documented rules.
Autocompletion of defined rule names.
Formatting.
Update checking.

Please see the issues page to suggest features or view previous suggestions.

Usage

You can find documentation on how to set up the server for in the DOCS.md file.

Supported IDEs

Visual Studio Code
- VSCode has a pre-built extension that can compile, update, and start up the language server. It also includes syntax highlighting definitions.

Due to the usage of the LSP by this project, adding support for new IDEs should be far more achievable than a custom implementation for each editor. Please see the tracking issue to request support for another IDE or view the current status of IDE support.

Development

This repository uses a Taskfile; install the task command for a better experience developing in this repository.

The task fmt-and-lint can be used to check the formatting and lint your code to ensure it fits with the rest of the repository.

In VSCode, press F5 to build and debug the VSCode extension. This is the only method of debugging that we have pre set-up.

Architecture

The server itself is implemented in Rust using tower-lsp. It communicates with editors via JSON-RPC through standard input/output, according to the language server protocol.

Contributing

We appreciate contributions! I recommend reaching out on Discord (the invite to which can be found at pest.rs) before contributing, to check with us.

Credits

OsoHQ, for their blog post, and open source code which was used as inspiration.
Stef Gijsberts for their Pest syntax highlighting TextMate bundle which is used in this extension under the MIT license.

Comments

The Great Rewrite of 2023
This rewrites the server to use tower_lsp.

The VSCode server will download and compile the server using cargo install.

TODO

[x] Get a new version of pest_fmt released, so we can have this commit

[x] Test the VSCode binary installer

[x] VScode should use the compiled version in target/debug when launching a debug window

[x] GIFs

[x] Unused rule warnings

enhancement
opened by Jamalam360 11

Crash when using Unicode Character

Using Unicode characters, such as Chinese, may crashes. But sometimes I can't reproduce it.

Source:

foobar = { "中文" }

Log:

thread 'main' panicked at 'byte index 13 is not a char boundary; it is inside '中' (bytes 12..15) of `foobar = { "中文" }`', C:\Users\zeng-\.cargo\registry\src\mirrors.tuna.tsinghua.edu.cn-df7c3c540f42cdbd\pest-language-server-0.2.1\src\helpers.rs:117:20

bug

opened by zeng-y-l 4

[BUG] Goto Definition handler
It seems like there is a bug in Goto Definition response.

Seems like it returns the result with a subtraction (with underflow) of 1 for all four fields. For the example below: | symbol | expected | lsp response | |---------|-----------|-----------------| | first | 0:0-0:5 | MAX:MAX-NAX:4 | | x | 3:0-3:1 | 2:MAX- 2:0 | | y | 5:4-5:5 | 4:3 - 4:4 |

, where MAX stands for u32::MAX

The example:

first = { ANY } // some comment x = { first } y = { x } // there are 4 spaces before this symbol

I noticed this commit (b503d1b) where a subtraction of one was added for both enum invariant (Pos and Span). It seems to work well when I delete this subtraction for Span (but not for Pos, as this make the wrong reponse for diagnostics).
bug server fixed
opened by miroslavbel 2
Better `unused` warning

In a pest file, there will be always have a grammar_rule is not used. But that is the final rule, so the extension it will always show the unused warning.
bug

opened by huacnlee 1
chore(deps): bump h2 from 0.3.16 to 0.3.17
Bumps h2 from 0.3.16 to 0.3.17.

Release notes

Sourced from h2's releases.

v0.3.17

What's Changed

Add Error::is_library() method to check if the originated inside h2.

Add max_pending_accept_reset_streams(usize) option to client and server builders.

Fix theoretical memory growth when receiving too many HEADERS and then RST_STREAM frames faster than an application can accept them off the queue. (CVE-2023-26964)

Changelog

Sourced from h2's changelog.

0.3.17 (April 13, 2023)

Add Error::is_library() method to check if the originated inside h2.

Add max_pending_accept_reset_streams(usize) option to client and server builders.

Fix theoretical memory growth when receiving too many HEADERS and then RST_STREAM frames faster than an application can accept them off the queue. (CVE-2023-26964)

Commits

af4bcac v0.3.17

d3f37e9 feat: add max_pending_accept_reset_streams(n) options

5bc8e72 fix: limit the amount of pending-accept reset streams

8088ca6 feat: add Error::is_library method

481c31d chore: Use Cargo metadata for the MSRV build job

d3d50ef chore: Replace unmaintained/outdated GitHub Actions

45b9bcc chore: set rust-version in Cargo.toml (#664)

See full diff in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) You can disable automated security fix PRs for this repo from the Security Alerts page.

dependencies rust
opened by dependabot[bot] 1
chore(deps): bump xml2js from 0.4.23 to 0.5.0 in /vscode
Bumps xml2js from 0.4.23 to 0.5.0.

Commits

See full diff in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) You can disable automated security fix PRs for this repo from the Security Alerts page.

dependencies javascript
opened by dependabot[bot] 0
chore(deps): bump openssl from 0.10.46 to 0.10.48
Bumps openssl from 0.10.46 to 0.10.48.

Release notes

Sourced from openssl's releases.

openssl v0.10.48

What's Changed

Fix LibreSSL version checking in openssl/ by @alex in sfackler/rust-openssl#1851

Skip a test that hangs on OpenSSL 3.1.0 by @alex in sfackler/rust-openssl#1850

Improve reliability of some tests by @smoelius in sfackler/rust-openssl#1852

Fix a series of security issues by @alex in sfackler/rust-openssl#1854

Release openssl v0.10.48 and openssl-sys v0.9.83 by @alex in sfackler/rust-openssl#1855

New Contributors

@smoelius made their first contribution in sfackler/rust-openssl#1852

Full Changelog: https://github.com/sfackler/rust-openssl/compare/openssl-v0.10.47...openssl-v0.10.48

openssl v0.10.47

No release notes provided.

Commits

4ff734f Release openssl v0.10.48 and openssl-sys v0.9.83 (#1855)

5efceaa Merge pull request #1854 from alex/davids-openssl-of-horrors

6ced4f3 Fix race condition with X509Name creation

a752805 Document the horror show

78aa9aa Always provide an X509V3Context in X509Extension::new because OpenSSL require...

332311b Resolve an injection vulnerability in EKU creation

482575b Resolve an injection vulnerability in SAN creation

690eeb2 Merge pull request #1852 from smoelius/master

e5b6d97 Improve reliability of some tests

319200a Merge pull request #1851 from alex/libressl-versions

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) You can disable automated security fix PRs for this repo from the Security Alerts page.

dependencies
opened by dependabot[bot] 0
Automatically fill changelog in release workflow

It would be ideal if the release workflow could automatically grab the changelog for the tag from CHANGELOG.md and use it as the body for the GitHub release. I don't have time to work on this myself for now
enhancement fixed

opened by Jamalam360 0
Add a code action to add an unused rule to `pestIdeTools.alwaysUsedRuleNames`

I haven't yet found a way in the LSP for servers to update their own config, which may be annoying. I'll look more but this might have to be vs code exclusive.
enhancement wontfix server

opened by Jamalam360 4
IDE Support: Tracking Issue
This issue tracks progress on support for IDEs other than VSCode.

Progress

General Tasks

[x] Pull request and merge the rewrite to Tower LSP, allowing us to communicate over std i/o as defined via the LSP specification.

[x] Create an XML TextMate syntax - I haven't seen another editor that supports the JSON TextMate bundles that VSCode uses (maybe VSCode can use the XML ones so that there's only one source of syntax truth?).

Editor List

[x] VSCode

[x] Sublime Text

[ ] Helix

[ ] (Neo)vim

[ ] Emacs

[ ] ~~Lapce~~; on hold, see comments

Do you use an editor that isn't on this list? Please let us know in the comments so we are aware.
enhancement new editor
opened by Jamalam360 9

Releases(v0.2.2)

v0.2.2(Apr 21, 2023)
v0.2.2

feat(vscode): allow relative paths in pestIdeTools.serverPath

fix(vscode): allow pestIdeTools.serverPath to be null in the schema

fix(server): CJK/non-ascii characters no longer crash the server

fix(server): add a CJK test case to the manual testing recommendations"

Source code(tar.gz)
Source code(zip)
pest.sublime-package(1.62 KB)
pest.vsix(113.11 KB)
v0.2.1(Apr 20, 2023)
v0.2.1

fix(vscode): scan both stdout and stderr of Cargo commands, fixes some issues with installation flow

feat(*): documentation, issue templates

feat(sublime): begin publishing a sublime text package

fix(server, vscode): server now hot-reloads config updates more reliably

fix(server, vscode): bump problematic dependencies (love the JS ecosystem...a CVE a day keeps the doctor away)

feat(server): add rule inlining code action

feat(server): ignore unused rule name analysis if there is only one unused rule (hack fix)

Full Changelog: https://github.com/pest-parser/pest-ide-tools/compare/v0.2.0...v0.2.1
Source code(tar.gz)
Source code(zip)
pest.sublime-package(1.62 KB)
pest.vsix(113.11 KB)
v0.2.0(Mar 17, 2023)
v0.2.0

feat(*): port to tower lsp

This will allow the usage of this LS by other IDEs.

The vscode extension will prompt you to download the server.

Other IDEs will have to have the LS installed via cargo install.

feat(*): add configuration options

feat(server, #6): diagnostic for unused rules

feat(server, #7): show rule docs (///) on hover

fix(server, #8): solve issue relating to 0 vs 1 indexing causing diagnostics to occur at the wrong locations

feat(server): add a version checker

feat(readme, #2): update readme and add demo gif

feat(ci, #4): automatically populate changelog

fix(ci): lint all rust code

Source code(tar.gz)
Source code(zip)
v0.1.2(Mar 6, 2023)

[0.1.2]

feat: upgrade pest v2.5.6, pest-fmt v0.2.3. See Release Notes. fix(server): solve issue relating to 0 vs 1 indexing. feat(server): suggest user-defined rule names in intellisense.
Source code(tar.gz)
Source code(zip)
pest.vsix(435.76 KB)
v0.1.1(Mar 5, 2023)
[0.1.1]

feat(server): add hover information for SOI and EOI

fix(ci): allow the release workflow to create releases.

fix(vscode): add a readme for the vscode extension.

fix(vscode): add a changelog.

Source code(tar.gz)
Source code(zip)
pest.vsix(433.74 KB)