You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[](https://open.vscode.dev/davelopez/galaxy-workflows-vscode)
7
7
8
-
VSCode extension to assist in editing [Galaxy Workflow](https://galaxyproject.org/) files while enforcing [best practices](https://planemo.readthedocs.io/en/latest/best_practices_workflows.html). Use it in combination with [Planemo](https://github.com/galaxyproject/planemo) for the best experience developing and maintaining your Galaxy workflows.
8
+
The **Galaxy Workflows VSCode extension** assists in editing [Galaxy](https://galaxyproject.org/)Workflow files while enforcing [best practices](https://planemo.readthedocs.io/en/latest/best_practices_workflows.html). Use it in combination with [Planemo](https://github.com/galaxyproject/planemo) for an optimal experience in developing and maintaining your Galaxy workflows.
9
9
10
-
The extension can be installed either locally, or in a web context, like [github.dev](https://github.dev) or [vscode.dev](https://vscode.dev). The aim is to support the maximum number of features in both modes but the web mode may have some limitations.
10
+
You can install the extension locally or in a web context, such as [github.dev](https://github.dev) or [vscode.dev](https://vscode.dev). The extension aims to support as many features as possible in both modes, though the web mode may have some limitations.
11
11
12
-
The extension aims to focus on assist in editing [**Format 2** Galaxy Workflow](https://github.com/galaxyproject/gxformat2) (.gxwf.yml) files. However, it will work with _legacy_ or _native_**Galaxy Workflow** format (documents with **.ga** extension) as an experiment for legacy workflow maintainers.
12
+
The extension focuses on assisting with editing [**Format 2** Galaxy Workflow](https://github.com/galaxyproject/gxformat2) (**.gxwf.yml**) files. However, it also supports the _native_**Galaxy Workflow** format documents (with **.ga** extension) for legacy reasons.
13
13
14
-
> ⚠️ Please note the _Native_ Galaxy Workflow format (.ga) is considered internal and _legacy_. The support provided here is temporal and experimental. If you are developing workflows manually use the new [**Format 2** Galaxy Workflow](https://github.com/galaxyproject/gxformat2) (.gxwf.yml).
14
+
> ⚠️ Please note the _Native_(or _Format1_) Galaxy Workflow format (.ga) is considered internal and is not meant to be edited manually. The support provided here is temporary and experimental. If you are developing workflows manually, use the new [**Format 2** Galaxy Workflow](https://github.com/galaxyproject/gxformat2) (.gxwf.yml).
15
15
16
-
If you find a bug or have an idea or suggestion that can improve your experience please create a [new issue here](https://github.com/davelopez/galaxy-workflows-vscode/issues) or comment in any of the existing ones.
16
+
If you find a bug or have a suggestion to improve your experience, please create a [new issue here](https://github.com/davelopez/galaxy-workflows-vscode/issues) or comment on any existing ones.
17
17
18
18
## Quick Start
19
19
20
+
> ⚠️ Important: To properly detect your Galaxy Workflow files, they must have the correct file extension. For **Format 2** Galaxy Workflows, use the `.gxwf.yml` extension, and for the _native_ Galaxy Workflows, use the `.ga` extension.
21
+
20
22
### Option 1: Install extension locally
21
23
22
24
1. Open VSCode
23
-
2. Install the extension from the [marketplace](https://marketplace.visualstudio.com/items?itemName=davelopez.galaxy-workflows).
25
+
2. Install the extension from the [Marketplace](https://marketplace.visualstudio.com/items?itemName=davelopez.galaxy-workflows).
24
26
3. Open any Galaxy Workflow document (.gxwf.yml or .ga) and the extension will activate.
25
27
26
28
### Option 2: Use it directly in `vscode.dev` or `github.dev`
@@ -31,7 +33,7 @@ If you find a bug or have an idea or suggestion that can improve your experience
31
33
32
34
2. Install the extension if you haven't already:
33
35
34
-
- Go to the extensions panel (`Ctrl+Shift+x`) and search for `davelopez.galaxy-workflows` then click `Install`
36
+
- Go to the extensions panel (`Ctrl+Shift+x`), search for `davelopez.galaxy-workflows`, and click `Install`
35
37
36
38
3. Enjoy the workflow editing features directly on your browser ✨
37
39
@@ -49,15 +51,16 @@ Just make sure to read the [Contributing Guidelines](docs/CONTRIBUTING.md) 😉
49
51
50
52
The following table shows all the implemented features and the current support for each workflow format.
@@ -66,7 +69,7 @@ The following table shows all the implemented features and the current support f
66
69
67
70
🔜 Feature not yet available but planned for future release.
68
71
69
-
❔ This feature may not apply to this format or not planned yet.
72
+
❔ This feature may not apply to this format or is not planned yet.
70
73
71
74
🔶 This feature is only supported in local repositories or file systems. Not supported in _Web_ mode or _Virtual File Systems_.
72
75
@@ -77,7 +80,7 @@ The following table shows all the implemented features and the current support f
77
80
78
81
### Workflow Validation
79
82
80
-
You will get diagnostics for every syntax error or incorrect property value as you type so you can fix them right away.
83
+
You will receive diagnostics for every syntax error or incorrect property value as you type, allowing you to fix them immediately.
81
84
82
85
#### Gxformat2 (yaml)
83
86
@@ -91,7 +94,7 @@ You will get diagnostics for every syntax error or incorrect property value as y
91
94
92
95
### Documentation on Hover
93
96
94
-
Hover over properties to get a description of what they are and how can you use them. The documentation displayed is based on the Workflow schema annotations, if you think you need more details or something is off, please help us improve the schema [here](https://github.com/galaxyproject/gxformat2)!
97
+
Hover over properties to get a description of what they are and how to use them. The documentation displayed is based on the Workflow schema annotations. If need more details or find something incorrect, please help us improve the schema [here](https://github.com/galaxyproject/gxformat2)!
95
98
96
99
#### Gxformat2 (yaml)
97
100
@@ -105,7 +108,7 @@ Hover over properties to get a description of what they are and how can you use
105
108
106
109
### IntelliSense
107
110
108
-
Get [IntelliSense](https://code.visualstudio.com/docs/editor/intellisense#:~:text=IntelliSense%20is%20a%20general%20term,%2C%20and%20%22code%20hinting.%22) suggestions depending on your cursor context. Remember that you can manually trigger the suggestions at your current cursor position using `Ctrl+Space`.
111
+
Get [IntelliSense](https://code.visualstudio.com/docs/editor/intellisense#:~:text=IntelliSense%20is%20a%20general%20term,%2C%20and%20%22code%20hinting.%22) suggestions based on your cursor context. You can manually trigger suggestions at your current cursor position using `Ctrl+Space`.
109
112
110
113
#### Gxformat2 (yaml)
111
114
@@ -119,7 +122,7 @@ Get [IntelliSense](https://code.visualstudio.com/docs/editor/intellisense#:~:tex
119
122
120
123
### Formatting
121
124
122
-
Keep your workflow document consistently formatted. We recommend enabling your VSCode setting to `Format on Save` so you don't have to manually format after the changes.
125
+
Keep your workflow document consistently formatted. We recommend enabling the VSCode `Format on Save`setting so you don't have to manually format after making changes.
123
126
124
127
#### Gxformat2 (yaml)
125
128
@@ -133,7 +136,7 @@ Keep your workflow document consistently formatted. We recommend enabling your V
133
136
134
137
### Custom Outline
135
138
136
-
The `Custom Outline` allows you to navigate and find different parts of the Workflow faster using the Outline panel or the [Breadcrumbs](https://code.visualstudio.com/docs/editor/editingevolved#_breadcrumbs). The Outline representation has been enhanced, in comparison to the standard JSON Outline, by displaying relevant information more prominently (like using the workflow step name instead of the index on step nodes) or hiding non-essential nodes.
139
+
The `Custom Outline` allows you to navigate and find different parts of the Workflow faster using the Outline panel or [Breadcrumbs](https://code.visualstudio.com/docs/editor/editingevolved#_breadcrumbs). Compared to the standard JSON Outline, the enhanced Outline representation displays relevant information more prominently (e.g., using the workflow step name instead of the index on step nodes) and hides non-essential nodes.
137
140
138
141
#### Gxformat2 (yaml)
139
142
@@ -147,7 +150,7 @@ The `Custom Outline` allows you to navigate and find different parts of the Work
147
150
148
151
### Workflow Cleanup Command
149
152
150
-
You can clean up the non-essential properties of a (legacy .ga) workflow with this command. These properties are usually related to the display of the workflow in the editor and are not part of the workflow semantics. This command will remove those properties from the document, but you can also use the `Preview clean workflow` command, which will show you a preview of the clean workflow instead of making the changes to the original.
153
+
You can clean up the non-essential properties of a (legacy .ga) workflow with this command. These properties are usually related to the display of the workflow in the editor and are not part of the workflow semantics. This command will remove those properties from the document, but you can also use the `Preview clean workflow` command to show a preview of the clean workflow without making changes to the original.
151
154
152
155
#### Legacy (ga)
153
156
@@ -159,7 +162,7 @@ You can clean up the non-essential properties of a (legacy .ga) workflow with th
159
162
160
163
> ⚠️ This feature is experimental and is only available using a local git repository.
161
164
162
-
Sometimes you want to compare different revisions of the same (legacy .ga) workflow and see what has changed between them. If the workflow has been through the Galaxy editor or some of the nodes have been moved around, there can be many changes that are just cosmetical and not part of the workflow logic. In those cases, you may want to get a 'simplified' diff so you can focus on the 'real' changes. You can do so in <del>the `Timeline` or</del> the `File Explorer` by using `Select workflow for (clean) compare` in one revision and then `Compare with this workflow (clean)`on the other revision, this will compare both revisions using the 'clean' version of the workflow (see the [Workflow Cleanup Command](#workflow-cleanup-command)), meaning the non-essential parts are removed from both documents before the comparison.
165
+
Sometimes you want to compare different revisions of the same (legacy .ga) workflow and see what has changed. If the workflow has been through the Galaxy editor or some nodes have been moved around, there can be many cosmetic changes that are not part of the workflow logic. In those cases, you may want to get a 'simplified' diff to focus on the 'real' changes. You can do this in <del>the `Timeline` or</del> the `File Explorer` by using `Select workflow for (clean) compare` in one revision and then `Compare with this workflow (clean)`in the other revision. This will compare both revisions using the 'clean' version of the workflow (see the [Workflow Cleanup Command](#workflow-cleanup-command)), meaning the non-essential parts are removed from both documents before the comparison.
163
166
164
167
> ⚠️ **NOTE**:
165
168
> This feature is no longer supported in the `Timeline` until a new version of the VSCode Timeline API is finalized and published. See [this PR](https://github.com/davelopez/galaxy-workflows-vscode/pull/59) for more details.
@@ -168,4 +171,10 @@ Sometimes you want to compare different revisions of the same (legacy .ga) workf
You can now edit Workflow Test Files (`*-test.yml`) with basic language support. This includes syntax highlighting, validation, auto-completion, and documentation on hover based on the _experimental_ schema for Workflow Test Files.
177
+
178
+
Copy file name to clipboardExpand all lines: server/README.md
+4Lines changed: 4 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,3 +27,7 @@ This library contains common classes, interfaces and type definitions used by bo
27
27
### packages/yaml-language-service
28
28
29
29
This library implements a language service to provide basic _smarts_ for YAML documents. It is based and inspired by both the [YAML Language Server](https://github.com/redhat-developer/yaml-language-server) implementation from Red Hat and the [vscode-json-languageservice](https://github.com/microsoft/vscode-json-languageservice) by Microsoft.
30
+
31
+
### packages/workflow-tests-language-service
32
+
33
+
This library implements a language service to provide basic _smarts_ for **Galaxy workflow test documents**. This library is used by the `gxformat2` language server to provide autocompletion, validation and hover information for test documents.
0 commit comments