Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cylc/vscode-cylc
VSCode language support for Cylc workflow configuration files
https://github.com/cylc/vscode-cylc
cylc visual-studio-code vscode vscode-extension vscode-language
Last synced: about 2 months ago
JSON representation
VSCode language support for Cylc workflow configuration files
- Host: GitHub
- URL: https://github.com/cylc/vscode-cylc
- Owner: cylc
- License: gpl-3.0
- Created: 2020-04-14T10:37:20.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-08-06T09:55:39.000Z (6 months ago)
- Last Synced: 2024-08-06T11:06:32.994Z (6 months ago)
- Topics: cylc, visual-studio-code, vscode, vscode-extension, vscode-language
- Language: Python
- Homepage:
- Size: 193 KB
- Stars: 2
- Watchers: 5
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# vscode-cylc
A Visual Studio Code extension that provides language support for Cylc workflow configuration files.
## Features
- Syntax highlighting:
- Cylc 7
- Cylc 8
- Jinja2 (can be used with a Jinja extension e.g. [Better Jinja](https://marketplace.visualstudio.com/items?itemName=samuelcolvin.jinjahtml))
- Snippets for Cylc 8 sections/settings
### Screenshot
## Installation
Either:
- In VSCode, go to `View > Extensions` and search for "Cylc"
- Or install from the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=cylc.vscode-cylc)
## Issues
Please report any syntax highlighting issues at [cylc/cylc-textmate-grammar](https://github.com/cylc/cylc-textmate-grammar/issues). Any other issues with the extension should be reported [here](https://github.com/cylc/vscode-cylc/issues).
## Contributing
### Syntax highlighting
This repo includes the [cylc/cylc-textmate-grammar](https://github.com/cylc/cylc-textmate-grammar) repo as a git submodule in the `/syntaxes/` directory. If you don't have experience with submodules, you should [read the docs](https://git-scm.com/book/en/v2/Git-Tools-Submodules) first.
The cylc-textmate-grammar repo contains a JSON TextMate grammar file which is used by VSCode for syntax highlighting. Read the [VSCode syntax highlight guide](https://code.visualstudio.com/api/language-extensions/syntax-highlight-guide) for more information.
> [!IMPORTANT]
> Do not edit the JSON file when contributing; instead you should edit the JavaScript grammar file and build it, as explained in the [contributing](https://github.com/cylc/cylc-textmate-grammar#contributing) section of cylc-texmate-grammar.
To install a development version of this extension:
```
git clone --recurse-submodules https://github.com/cylc/vscode-cylc.git
```
The `--recurse-submodules` option automatically initialises the cylc-textmate-grammar repo in the `/syntaxes` directory.
Run/debug the development version in a new window by pressing F5.
You can then edit the `/syntaxes/src/cylc.tmLanguage.js` grammar file. First, [read the contributing section](https://github.com/cylc/cylc-textmate-grammar#contributing) of the cylc-textmate-grammar repo - any such edits will be part of that repo as opposed to this vscode-cylc repo. After editing & saving the file, there is a build shortcut task (in `/.vscode/tasks.json`) which can be triggered by Ctrl+Shift+B. This will run the cylc-textmate-grammar build script which compiles the JSON grammar file. Reload the debugging window using the button on the toolbar or Ctrl+Shift+F5
> [!NOTE]
> Contributions to VSCode-specific features, e.g. bracket matching or snippets, are to be made in this repo, not the submodule.
### Snippets
Snippets are simply generated from the Cylc 8 workflow configuration spec by running:
```
./bin/build_snippets.py
```
or using the VSCode build task (Ctrl+Shift+B).
The latest version of cylc-flow should be installed for this to work.