https://github.com/wennmo/vscode-core-script
https://github.com/wennmo/vscode-core-script
catwalk qix qlikcore vscode
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/wennmo/vscode-core-script
- Owner: wennmo
- Created: 2018-11-09T07:25:18.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-12-04T12:45:42.000Z (over 6 years ago)
- Last Synced: 2025-02-16T01:26:20.451Z (3 months ago)
- Topics: catwalk, qix, qlikcore, vscode
- Language: JavaScript
- Size: 10.7 MB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
[](https://circleci.com/gh/wennmo/vscode-core-script)
# vscode-core-script
## Description
This repo contains a vscode extension for developing and validating scripts using the editor. You can validate the script syntax, load the script in Qlik Associative Engine and view the current data model using `Catwalk`.
Keep in mind that this repository is under heavy development and the appareance and behaviour will probably change in the coming weeks.
## Prerequisites
- Qlik Associative Engine
We also recommend you to install the [vscode-qlik](https://github.com/Gimly/vscode-qlik) extension to get load script syntax highlighting in `vscode`!
## Configuration
This extension will by default use `localhost:9076` for communication with a Qlik Associative Engine. However `host` and `port` can be configured in your user settings for `vscode` like [this](./.vscode/settings.json).
If you want to connect with secure websocket and/or use headers you can also define them in settings.
If the `reloadLimit` is set the engine will reload the app in debug mode making it possible to limit the amount of rows loaded per field. Default is `null` = unlimited.
```json
{
"engine.host": "localhost",
"engine.port": 19076,
"engine.secure": true,
"engine.headers": {
"headerKey": "headerValue"
},
"engine.reloadLimit": 100
}
```
## Features
### Validate script syntax
The extension will use the running Qlik Associative Engine for validating the script syntax of the load script. If errors are detected they will be highlighted in the editor and also the errors will be displayed in the status bar and in the `Problems`console.
The command can be executed by running `Ctrl+Shift+p` and is also triggered when saving a `.qvs` file.
### Show data model in Catwalk
To make it possible to view the data model created by your load script, the extension makes use of [`Catwalk`](https://github.com/qlik-oss/catwalk).
The command can be executed by running `Ctrl+Shift+c`.
### Insert Qlik Ctrl+0+0 script
There is a command available for inserting the Ctrl+0+0 script into your editor: `Qlik: Insert the Qlik Ctrl+0+0 script into your load script`.
This command can be tied by a user to a key binding if often used.
### Stay tuned
## Try it out
The extension is not yet published to Visual Studio Marketplace, but if you want to try it out you can clone the repo and run it in debugger with `F5`.