https://github.com/cylc/vscode-cylc
VSCode language support for Cylc workflow configuration files
Science Score: 26.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (11.2%) to scientific vocabulary
Keywords
Keywords from Contributors
Repository
VSCode language support for Cylc workflow configuration files
Basic Info
Statistics
- Stars: 3
- Watchers: 4
- Forks: 3
- Open Issues: 0
- Releases: 8
Topics
Metadata Files
README.md
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)
- 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
Issues
Please report any syntax highlighting issues at cylc/cylc-textmate-grammar. Any other issues with the extension should be reported here.
Contributing
Syntax highlighting
This repo includes the 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 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 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 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 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.
Owner
- Name: The Cylc Workflow Engine
- Login: cylc
- Kind: organization
- Email: hilary.oliver@niwa.co.nz
- Location: Wellington, New Zealand
- Website: https://cylc.github.io
- Repositories: 20
- Profile: https://github.com/cylc
A workflow engine for cycling systems.
GitHub Events
Total
- Release event: 4
- Watch event: 1
- Delete event: 6
- Push event: 3
- Pull request review event: 4
- Pull request event: 6
- Create event: 6
Last Year
- Release event: 4
- Watch event: 1
- Delete event: 6
- Push event: 3
- Pull request review event: 4
- Pull request event: 6
- Create event: 6
Committers
Last synced: 10 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Ronnie Dutta | 6****e | 79 |
| Tim Pillinger | 2****m | 16 |
| github-actions[bot] | 4****] | 1 |
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 4
- Total pull requests: 26
- Average time to close issues: 3 months
- Average time to close pull requests: 3 days
- Total issue authors: 2
- Total pull request authors: 3
- Average comments per issue: 0.0
- Average comments per pull request: 0.69
- Merged pull requests: 26
- Bot issues: 0
- Bot pull requests: 2
Past Year
- Issues: 0
- Pull requests: 6
- Average time to close issues: N/A
- Average time to close pull requests: about 9 hours
- Issue authors: 0
- Pull request authors: 2
- Average comments per issue: 0
- Average comments per pull request: 0.0
- Merged pull requests: 6
- Bot issues: 0
- Bot pull requests: 2
Top Authors
Issue Authors
- MetRonnie (3)
- wxtim (1)
Pull Request Authors
- MetRonnie (24)
- wxtim (3)
- github-actions[bot] (2)
Top Labels
Issue Labels
Pull Request Labels
Dependencies
- actions/checkout v2 composite
- actions/setup-node v2 composite
- actions/checkout v4 composite
- cylc/release-actions/configure-git v1 composite
- cylc/release-actions/create-pr v1 composite