https://github.com/julindm/firestore-rules-lsp

Language server provider for the Firestore Security Rules language
https://github.com/julindm/firestore-rules-lsp

firebase firestore lsp

Last synced: about 4 hours ago
JSON representation

Language server provider for the Firestore Security Rules language

• Host: GitHub
• URL: https://github.com/julindm/firestore-rules-lsp
• Owner: JulindM
• Created: 2024-02-01T00:52:07.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-10-24T03:07:40.000Z (25 days ago)
• Last Synced: 2024-10-24T20:08:05.632Z (25 days ago)
• Topics: firebase, firestore, lsp
• Language: Rust
• Homepage:
• Size: 251 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Firestore Rules Language Server Provider

#### A LSP implementation for the [Firestore Security Rules Language](https://firebase.google.com/docs/rules/rules-language#firestore)

This LSP implementation is standalone and does not require the Firebase Admin SDK toolchain to parse a firestore rules document. It uses its own tree sitter based grammar currently maintaned in the [tree](https://github.com/JulindM/firestore-rules-lsp/tree/main/tree-sitter-firestore_rules).

---

### Overview

The LSP is currently in alpha.

> [!IMPORTANT]

> The error diagnostics are somewhat wonky as the evaluation still needs further work to be 1:1 with the Firebase Admin SDK parser.

### Usage

The server supports communicating over STDIO or TCP. Starting the server without any parameters will start it over STDIO.

#### Over TCP:

To start the server over TCP, you need to have a client started and already bound to `` awaiting the server capabilities to be sent. If this is the case then run

```sh

$ firestore-rules-lsp --socket=

```

for the lsp to initialize the connection

### Current capabilites

- Text Document Synchronization

- Semantic Tokens Provider

- Definition Provider

- Publish Diagnostics Notifications

- Hover

  - The current hover is a preview of the AST traversal to the lowest denominator under the cursor, so not that interesting

### Planned capabilites

- Improved Hover

  - For the methods and fields of the `request` and `resource` global variables

- Signature Help Request

  - For the current document defined functions

  - For the methods within the fields of the `request` and `resource` global variables

- Linting

### Also check out

Currently there is a VSCode extension in the works that simply wraps around this LSP to enable it in VSCode.

_Check it out [here](https://github.com/JulindM/firestore-rules-lsp-vscode)._