CloudSlang Editors¶
Although CloudSlang files can be composed in any text editor, using a modern code editor with support for syntax highlighting is recommended.
Atom¶
The language-cloudslang Atom package includes CloudSlang syntax highlighting and many code snippets.
Download, Install and Configure Atom¶
- Download and install Atom.
- Download and install the CloudSlang language package.
- From the Atom UI: File > Settings > Install and search for language-cloudslang
- From the command line:
apm install language-cloudslang
Note
If you are behind a proxy server you may need to configure Atom as described in their package manager documentation.
- Reload (View > Reload) or restart Atom.
- Files saved with the .sl extension will be recognized within Atom as CloudSlang files.
Snippets¶
To use the snippets start typing the snippet name and press enter when it appears on the screen.
The following snippets are provided:
Keyword | Description |
---|---|
flow | template for a flow file |
operation | template for an operation file |
decision | template for an decision file |
properties | template for a system properties file |
java_action | template for a Java action |
python_action | template for a Python action |
input | template for simple input name and value |
input with properties | template for an input with all possible properties |
output | template for an output name and value |
output with properties | template for an output with all possible properties |
result | template for a result name and value |
run_id | template for the run ID of the current execution |
cs_functions | template supporting
cs_function . See |
ROI | template to define the ROI from an automated step |
publish | template for a published variable name and value |
import | template for an import alias name and namespace |
navigate | template for a result mapped to a navigation target |
step | template for a standard step |
on_failure | template for an on_failure step |
for | template for an iterative step |
parallel_loop | template for a parallel step |
property | template for a system property |
property with properties | template for a system property with all possible properties |
@input | template for input documentation |
@description | template for file description documentation |
@prerequisites | template for prerequisite documentation |
@output | template for output documentation |
@result | template for result documentation |
Atom Troubleshooting¶
For troubleshooting Atom issues, see the Atom documentation and discussion board.
IntelliJ¶
The CloudSlang Plugin for IntelliJ package includes:
- CloudSlang file type support (.sl, .sl.yaml, .sl.yml, .prop.sl)
- Live templates (e.g: flow, operation, input, output, step, for, java_action etc.)
- Completion support for CloudSlang keywords
- Syntax highlighting
- CloudSlang file validation and error highlighting
Installation¶
- Install the CloudSlang IntelliJ Plugin in IntelliJ using the Plugin Installation Wizard from File > Settings > Plugins > Browse repositories… and search for: CloudSlang plugin.
- Click Apply button of the Settings dialog.
Note
Following the system prompt that appears, restart IntelliJ IDEA to activate the installed plugin, or postpone it, at your choice.