Skip to content

jq-lsp.md

Latest commit

 

History

History
53 lines (29 loc) · 2.14 KB

jq-lsp.md

File metadata and controls

53 lines (29 loc) · 2.14 KB

JQ Language Server

To enable JQ language support in your IDE, you can integrate the JQ Language Server by following these steps:

JQ LS demo

Step 1: Install the Language Server

  1. Open an .jq file in your project.

  2. Click on Install JQ Language Server:

    Open file

  3. This will open the New Language Server Dialog with JQ Language Server pre-selected:

    New Language Server Dialog

  4. Click OK. This will create the JQ Language Server definition and start the installation:

    Installing Language Server

  5. Once the installation completes, the server should start automatically and provide JQ language support (autocomplete, diagnostics, etc.).

Troubleshooting Installation

If the installation fails, you can customize the installation settings in the Installer tab,
then click on the Run Installation hyperlink to reinstall the server:

Installer tab

See Installer descriptor for more information.

Step 2: Install TextMate Bundle

Since IntelliJ does not provide native JQ TextMate support, and the language server does not handle syntax highlighting, you need to set up a TextMate bundle manually.

  • Clone the vscode-jq repository:

    git clone https://github.com/wader/vscode-jq.git

  • Open TextMate Bundles settings

TextMate Bundles Settings

  • Click the + button and select the folder vscode-jq folder. This folder contains the modified package.json and the TextMate grammar.

Once done, IntelliJ will apply syntax highlighting, bracket matching, and other basic editor features for .jq files.