Skip to content

vscode: update readme #580

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kodiakhq merged 1 commit into from
Jul 3, 2025
Merged

vscode: update readme #580

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions crates/squawk_server/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ use lsp_server::{Connection, Message, Notification, Response};
use lsp_types::{
CodeDescription, Diagnostic, DiagnosticSeverity, DidChangeTextDocumentParams,
DidCloseTextDocumentParams, DidOpenTextDocumentParams, GotoDefinitionParams,
GotoDefinitionResponse, InitializeParams, Location, OneOf, Position, PublishDiagnosticsParams,
Range, ServerCapabilities, TextDocumentSyncCapability, TextDocumentSyncKind, Url,
GotoDefinitionResponse, InitializeParams, Location, Position, PublishDiagnosticsParams, Range,
ServerCapabilities, TextDocumentSyncCapability, TextDocumentSyncKind, Url,
notification::{
DidChangeTextDocument, DidCloseTextDocument, DidOpenTextDocument, Notification as _,
PublishDiagnostics,
Expand All @@ -23,7 +23,7 @@ pub fn run() -> Result<()> {

let server_capabilities = serde_json::to_value(&ServerCapabilities {
text_document_sync: Some(TextDocumentSyncCapability::Kind(TextDocumentSyncKind::FULL)),
definition_provider: Some(OneOf::Left(true)),
// definition_provider: Some(OneOf::Left(true)),
..Default::default()
})
.unwrap();
Expand Down
26 changes: 25 additions & 1 deletion squawk-vscode/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,31 @@

> Visual Studio Code support for Squawk

## dev
Surface SQL related lint errors directly in VSCode.

## Install

Install via the [VSCode marketplace](https://marketplace.visualstudio.com/items?itemName=sbdchd.squawk).

## Install

### From online marketplace

Open the [online marketplace listing](https://marketplace.visualstudio.com/items?itemName=sbdchd.squawk) for Squawk and click "Install". Follow the prompts to open VSCode and install Squawk.

### From VSCode

In VSCode, type `CMD`+`P`, run `Extensions: Install Extensions`, search for `sbdchd.squawk` and click install.

### From Github release

Download the extension package from the [latest Github release](https://github.com/sbdchd/squawk/releases/latest) and run `code --install-extension squawk-*.vsix`

### From source

With `vsce` installed from NPM (`npm install -g @vscode/vsce`), clone [this repo](https://github.com/sbdchd/vscode-squawk) and run `vsce package`. Install the resulting package with `code --install-extension squawk-*.vsix`

## Dev

Make sure you're on a vscode version >= the one defined in the `package.json`,
otherwise the extension development host won't load the extension.
1 change: 0 additions & 1 deletion squawk-vscode/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@
"engines": {
"vscode": "^1.101.0"
},
"preview": true,
"keywords": [
"postgres",
"postgreSQL",
Expand Down
Loading