Firestore Rules Language Server Provider

A LSP implementation for the Firestore Security Rules Language

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.

---

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 <PORT_NUMBER> awaiting the server capabilities to be sent. If this is the case then run

$ firestore-rules-lsp --socket=<PORT_NUMBER>

for the lsp to initialize the connection

Current capabilites

• Dynamic Type inference
  • Work is still ongoing on a more broad type inference during variable definition. At the moment the type inference is done through the detection of a global variable/function usage
• 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
• Autocomplete
• Crude linting
  • Currently it supports diagnostics of variable usages that no definiton was found for them

Planned capabilites

• Improved Hover for type documentation
• Signature Help Request

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.