Zed Cylc Extension
October 7, 2024 · View on GitHub
This extension adds support for .cylc and suite.rc workflow configuration files to the Zed code editor.
Cylc (pronounced silk) is a general purpose workflow engine that also manages cycling systems very efficiently. It is used in production weather, climate, and environmental forecasting on HPC, but is not specialized to those domains.
It uses the grammar defined in tree-sitter-cylc.
Demo
Features
| Description | |
|---|---|
| 🌈 Syntax Highlighting | Provides comprehensive highlighting for .cylc and suite.rc files. |
| 📜 Hierarchical Outline | Displays a collapsible, structured view of your Cylc configuration file, making it easy to navigate large workflows. |
| ⌨️ Auto-Indentation | Automatically adjusts indentation as you write, ensuring your workflow configuration is consistently formatted. |
| 📂 Code Folding | Collapse or expand sections of your Cylc files for easier management of large blocks of code. |
| 🖥️ BASH Language Injection | Embedded Shell syntax inside script settings and the [[environment]] section, for easier validation of your tasks scripts. |
Installation
zed-cylc is available in the official Zed Extension Gallery and can be installed directly from the Editor.
For manual installation, follow these steps:
- Download the latest release or a specific commit from GitHub.
- Unzip the downloaded file.
- In Zed, open the Extensions manager (⇧⌘X on MacOS) and click on Install Dev Extension, then select the unzipped folder.
Contributing
Contributions and bug reports are welcome! Please submit a pull request or file an issue on the GitHub repository.