Skip to content

Commit

Permalink
tweak: Use VS Code (#288)
Browse files Browse the repository at this point in the history
  • Loading branch information
max-sixty authored Aug 9, 2023
1 parent 5aa146e commit bfb80a0
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ See [releases](https://github.com/PRQL/prql-vscode/releases) for a brief summary

- Refactor SQL Preview webview implementation
([#60](https://github.com/PRQL/prql-vscode/issues/60))
- Add VSCode marketplace badges to README.md
- Add VS Code marketplace badges to README.md
([#87](https://github.com/PRQL/prql-vscode/issues/87))
- Add PRQL Settings shortcut menu button to SQL Preview and PRQL Editor titlebar
([#90](https://github.com/PRQL/prql-vscode/issues/90))
Expand All @@ -26,7 +26,7 @@ See [releases](https://github.com/PRQL/prql-vscode/releases) for a brief summary
([#98](https://github.com/PRQL/prql-vscode/issues/98))
- Set PRQL Settings order to show Target setting first
([#99](https://github.com/PRQL/prql-vscode/issues/99))
- Implement SQL Preview webview deserialize to show it after VSCode reload
- Implement SQL Preview webview deserialize to show it after VS Code reload
([#102](https://github.com/PRQL/prql-vscode/issues/102))
- Add boolean prql.addTargetDialectToSqlFilenames setting for the generated SQL filenames
([#103](https://github.com/PRQL/prql-vscode/issues/103))
Expand Down
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,17 @@
PRQL is a modern language for transforming data — a simple, powerful, pipelined
SQL replacement.

This extension adds [PRQL](https://prql-lang.org/) support to VSCode IDE.
This extension adds [PRQL](https://prql-lang.org/) support to VS Code.

![PRQL Editor and SQL Preview](https://github.com/PRQL/prql-vscode/blob/main/docs/images/prql-vscode.png?raw=true)

## Features

- [PRQL](https://prql-lang.org/) language support and syntax highlighting
- SQL Previews with Problems diagnostics and PRQL errors display updated on every keystroke as you type PRQL
- Dedicated SQL Previews linked to open PRQL documents in VSCode editor
- Restore open SQL Previews on VSCode reload
- Copy SQL from an open SQL Preview to VSCode Clipboard
- Dedicated SQL Previews linked to open PRQL documents in VS Code editor
- Restore open SQL Previews on VS Code reload
- Copy SQL from an open SQL Preview to VS Code Clipboard
- Generate SQL File PRQL editor context menu shortcut
- View PRQL Settings editor context menu shortcut
- PRQL compile target setting for the generated SQL dialect
Expand All @@ -30,15 +30,15 @@ This extension adds [PRQL](https://prql-lang.org/) support to VSCode IDE.

### Feature Contributions

PRQL extension contributes the following Settings, Commands, Languages and Activation Events to the VSCode IDE:
PRQL extension contributes the following Settings, Commands, Languages and Activation Events to the VS Code:

![PRQL VSCode Feature Contributions](https://github.com/PRQL/prql-vscode/blob/main/docs/images/prql-vscode-features.png?raw=true)
![PRQL VS Code Feature Contributions](https://github.com/PRQL/prql-vscode/blob/main/docs/images/prql-vscode-features.png?raw=true)

## Configuration

Modify
[User or Workspace Settings](https://code.visualstudio.com/docs/getstarted/settings#_creating-user-and-workspace-settings)
in VSCode to change the default PRQL extension Settings globally or only for the open project workspace.
in VS Code to change the default PRQL extension Settings globally or only for the open project workspace.

![PRQL Extension Settings](https://github.com/PRQL/prql-vscode/blob/main/docs/images/prql-settings.png?raw=true)

Expand Down Expand Up @@ -73,7 +73,7 @@ You can also disable this PRQL compiler option in vscode extension by setting `p
cd prql-vscode && npm install
```

- Open the project in VSCode and start the TypeScript compilation task via
- Open the project in VS Code and start the TypeScript compilation task via
`Command Palette` -> `Tasks: Run build task` -> `npm: watch`. Alternatively,
you can run the compilation in your terminal directly:

Expand Down

0 comments on commit bfb80a0

Please sign in to comment.