Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wader/vscode-jq
jq extension for VSCode and (Neo)vim.
https://github.com/wader/vscode-jq
jq neovim vim vscode-extension
Last synced: 13 days ago
JSON representation
jq extension for VSCode and (Neo)vim.
- Host: GitHub
- URL: https://github.com/wader/vscode-jq
- Owner: wader
- License: mit
- Created: 2021-08-29T15:11:40.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2025-01-09T17:54:19.000Z (26 days ago)
- Last Synced: 2025-01-19T19:11:43.860Z (16 days ago)
- Topics: jq, neovim, vim, vscode-extension
- Language: TypeScript
- Homepage:
- Size: 269 KB
- Stars: 20
- Watchers: 6
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# vscode-jq
jq extension for VSCode/(Neo)Vim.
It provides:
- Syntax highlighting
- Syntax checking
- Auto completion
- Goto defintion
- Hover documentation
- Snippets
## Install
### Install jq-lsp
Install [jq-lsp](https://github.com/wader/jq-lsp) and make sure it's in `$PATH`:
```sh
go install github.com/wader/jq-lsp@latest
cp $(go env GOPATH)/bin/jq-lsp /usr/local/bin
```
### Install vim extension
- [coc-marketplace](https://github.com/fannheyward/coc-marketplace)
- [npm](https://www.npmjs.com/package/vscode-jq)
- vim:
```vim
" command line
CocInstall vscode-jq
" or add the following code to your vimrc
let g:coc_global_extensions = ['vscode-jq', 'other coc-plugins']
```
### Package and install vscode extension
```sh
npm install
vsce package && code --install-extension vscode-jq-*.vsix
# or if vsce is not installed
npm exec @vscode/vsce package && code --install-extension vscode-jq-*.vsix
```
If your using [dash](https://kapeli.com/dash) or [zeal](https://zealdocs.org/) I would
recommend installing the jq docset. Search for "jq" under "User Contributed Docsets" in dash
or goto https://zealusercontributions.now.sh/.
## Development
- Run `npm install`.
- Open VSCode
- Press Ctrl+Shift+B to compile the client and server.
- Switch to the Debug viewlet.
- Select `Launch Client` from the drop down.
- Run the launch config.