Last updated: 2024-05-15
A TextMate bundle for working with Cylc workflow configuration files.
Download this repository keeping the .tmbundle
extension.
-
TextMate - Open the bundle file.
-
PyCharm - instructions
-
WebStorm - instructions
-
Sublime Text 3:
git clone https://github.com/cylc/Cylc.tmbundle <path to sublime packages>/Cylc.tmbundle
(to get package path click Preferences => Browse Packages)
By default this bundle will enable highlighting for suite.rc
and .cylc
files (plus a few others), but not all .rc
files. However, you can add your own file associations:
Once you've downloaded the repository, open the Syntaxes/cylc.tmLanguage
file and add <string>rc</string>
under the fileTypes
key, like this:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>fileTypes</key>
<array>
<string>suite.rc</string>
<string>cylc</string>
+ <string>rc</string>
</array>
...
You will probably have to restart the editor for this to take effect.
Note: you can add exact matches (e.g. suite.rc.processed
) OR extensions without the dot (e.g. rc
), but you cannot use wildcards (e.g. *
won't work).
This bundle is built from the Cylc TextMate grammar.
The bundle needs to be re-built when the grammar is updated. This is done by
running build.rb
.
Tue builder requires the plist gem.
Bundles can be created via the TextMate app (Mac OS only).
The bundle editor appears to have disappeared in version 2, these steps apply to TextMate 1.5:
- Open TextMate.
- Open the bundle editor via the bundle menu.
- Create a new bundle.
- Within that bundle create a new language.
- Close the bundle editor.
- Navigate to
/Users/$USER/Library/Application Support/TextMate/Bundles/
.
You now have a blank bundle. We need the bundle for two things:
- The
info.plist
file (which we will keep). - The
uuid
in the language file (which we will use in the build process).