Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kestra-io/vscode-kestra
VSCode extension to bring Kestra's autocompletion to your IDE
https://github.com/kestra-io/vscode-kestra
Last synced: 11 days ago
JSON representation
VSCode extension to bring Kestra's autocompletion to your IDE
- Host: GitHub
- URL: https://github.com/kestra-io/vscode-kestra
- Owner: kestra-io
- License: apache-2.0
- Created: 2023-07-25T17:56:30.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-16T16:25:03.000Z (6 months ago)
- Last Synced: 2024-05-17T15:54:58.779Z (6 months ago)
- Language: TypeScript
- Size: 147 KB
- Stars: 10
- Watchers: 4
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Kestra extension for VSCode
## Features
- Flow autocompletion & validation on `.yaml` / `.yml` files by downloading the JSON schema.
- Dynamic documentation depending on tasks your flow includes.
## Requirements
- [Redhat's YAML extension](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml)
## Usage
### Kestra Schema - Enabling autocompletion
After installing the extension, you will get a new command called "Download Kestra schema".
You can use this command to download the schema that will enable autocompletion in YAML files.
To avoid having the schema apply on every YAML file, you can [set up the mapping in your settings file](https://code.visualstudio.com/docs/languages/json#_mapping-in-the-user-settings).
**Using the extension on the Kestra VSCode Kestra will automatically download the Schema.**
### Kestra Documentation - enabling live documentation
Kestra VSCode extension embeds the documentation. When on a YAML file, a new action called `Open Kestra Documentation` will appear and will open a new Webview. This webview contains the default properties of a flow and its tasks, but clicking on a specific task in your code will show its documentation.
## Configure
When using the extension on your local instance of VSCode, you will be prompted to enter a URL.
The default URL is the Kestra API that includes all plugins, but if you want to only display available plugins in your instance, use your Kestra Instance URL
**If you have a JWT-based authentication (EE), please copy your token from the "Copy JWT token" button available in the same menu as the Logout button on the UI.**
## Development
You can use the following alias to quickly install your extension to local Kestra instance for web extension testing:
```
alias extension="OLD_PWD=$(pwd) && \
npm run package-web && \
cp dist/web/extension.js {pathToKestraRoot}/ui/public/vscode/extensions/kestra/extension/dist/web/ && \
cp package.json {pathToKestraRoot}/ui/public/vscode/extensions/kestra/extension/ && \
cd {pathToKestraRoot} && \
rm -rf webserver/src/main/resources/ui && \
./gradlew assembleFrontend && \
cd $OLD_PWD"
```
## Package for local VSIX installation
`npm run vsix` will create a VSIX of your extension which you can use for local extension installation.
## Publish
Simply tag your commit with `v{major}.{minor}.{patch}` and it will trigger a GHA to do it.
## Configuration
The library allows two possible configurations:
- `kestra.api.url`: The URL of your Kestra instance
- `kestra.schema.match-path`: The path to files for which the Kestra API schema should be applied; this allows the extension to validate only YAML files from a specific folder desginated for kestra. For example, adding the following configuration to your `settings.json` will ensure that only files from the `_flows` directory will be validated as kestra flows:
```json
"kestra.schema.match-path": "_flow"
```