{"id":21646769,"url":"https://github.com/cylc/vscode-cylc","last_synced_at":"2025-04-11T19:22:14.369Z","repository":{"id":51292954,"uuid":"255580349","full_name":"cylc/vscode-cylc","owner":"cylc","description":"VSCode language support for Cylc workflow configuration files","archived":false,"fork":false,"pushed_at":"2025-01-16T10:30:41.000Z","size":205,"stargazers_count":2,"open_issues_count":0,"forks_count":3,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-25T15:15:48.786Z","etag":null,"topics":["cylc","visual-studio-code","vscode","vscode-extension","vscode-language"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cylc.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-04-14T10:37:20.000Z","updated_at":"2025-01-16T10:22:20.000Z","dependencies_parsed_at":"2024-08-06T10:58:38.076Z","dependency_job_id":"e384197b-eccb-4756-9cf3-aba125e7d8e2","html_url":"https://github.com/cylc/vscode-cylc","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cylc%2Fvscode-cylc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cylc%2Fvscode-cylc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cylc%2Fvscode-cylc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cylc%2Fvscode-cylc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cylc","download_url":"https://codeload.github.com/cylc/vscode-cylc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248465352,"owners_count":21108244,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cylc","visual-studio-code","vscode","vscode-extension","vscode-language"],"created_at":"2024-11-25T06:46:41.089Z","updated_at":"2025-04-11T19:22:14.342Z","avatar_url":"https://github.com/cylc.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# vscode-cylc\n\nA Visual Studio Code extension that provides language support for Cylc workflow configuration files.\n\n## Features\n\n- Syntax highlighting:\n  - Cylc 7\n  - Cylc 8\n  - Jinja2 (can be used with a Jinja extension e.g. [Better Jinja](https://marketplace.visualstudio.com/items?itemName=samuelcolvin.jinjahtml))\n- Snippets for Cylc 8 sections/settings\n\n### Screenshot\n\n![Screenshot of syntax highlighting](img/screen1.png)\n\n## Installation\n\nEither:\n- In VSCode, go to `View \u003e Extensions` and search for \"Cylc\"\n- Or install from the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=cylc.vscode-cylc)\n\n## Issues\n\nPlease 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).\n\n## Contributing\n\n### Syntax highlighting\n\nThis 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.\n\nThe 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.\n\n\u003e [!IMPORTANT]\n\u003e 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.\n\nTo install a development version of this extension:\n```\ngit clone --recurse-submodules https://github.com/cylc/vscode-cylc.git\n```\nThe `--recurse-submodules` option automatically initialises the cylc-textmate-grammar repo in the `/syntaxes` directory.\n\nRun/debug the development version in a new window by pressing \u003ckbd\u003eF5\u003c/kbd\u003e.\n\nYou 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 \u0026 saving the file, there is a build shortcut task (in `/.vscode/tasks.json`) which can be triggered by \u003ckbd\u003eCtrl\u003c/kbd\u003e+\u003ckbd\u003eShift\u003c/kbd\u003e+\u003ckbd\u003eB\u003c/kbd\u003e. 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 \u003ckbd\u003eCtrl\u003c/kbd\u003e+\u003ckbd\u003eShift\u003c/kbd\u003e+\u003ckbd\u003eF5\u003c/kbd\u003e\n\n\u003e [!NOTE]\n\u003e Contributions to VSCode-specific features, e.g. bracket matching or snippets, are to be made in this repo, not the submodule.\n\n### Snippets\n\nSnippets are simply generated from the Cylc 8 workflow configuration spec by running:\n\n```\n./bin/build_snippets.py\n```\n\nor using the VSCode build task (\u003ckbd\u003eCtrl\u003c/kbd\u003e+\u003ckbd\u003eShift\u003c/kbd\u003e+\u003ckbd\u003eB\u003c/kbd\u003e).\n\nThe latest version of cylc-flow should be installed for this to work.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcylc%2Fvscode-cylc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcylc%2Fvscode-cylc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcylc%2Fvscode-cylc/lists"}