Merge pull request #81 from galaxyproject/prepare-release-0.3.0

Prepare release 0.3.0

Author: davelopez

README.md

@@ -11,7 +11,7 @@ The aim of this project is to implement the [Language Server Protocol](https://m
 
 This repository contains both the [server](https://github.com/davelopez/galaxy-language-server/tree/master/server) implementation in [Python](https://www.python.org/) and the [client](https://github.com/davelopez/galaxy-language-server/tree/master/client) implementation of a [Visual Studio Code](https://code.visualstudio.com/) [extension](https://marketplace.visualstudio.com/VSCode) in [Node.js](https://nodejs.org/en/).
 
-> Please note this is still an early work in progress and **bugs and issues are expected**.
+> Please note this is still a work in progress so **bugs and issues are expected**. If you find any, you are welcome to open a new [issue](https://github.com/galaxyproject/galaxy-language-server/issues).
 
 ## Features
 ### Tag and attribute auto-completion 
@@ -59,69 +59,11 @@ Snippets can be really helpful to speed up your tool wrapper development. They a
 ---
 
 # Getting Started
+If you just want to use the Galaxy Language Server, the easiest option is to install the VSCode extension from the [Market](https://marketplace.visualstudio.com/items?itemName=davelopez.galaxy-tools) or the [Open VSX registry](https://open-vsx.org/extension/davelopez/galaxy-tools). Additionally you can download the VSIX package from the [releases](https://github.com/galaxyproject/galaxy-language-server/releases) and install it manually.
+
 If you are considering contributing, please read the [contribution guide](docs/CONTRIBUTING.md).
 
-## Setup for local development
-
-1. Fork this repo on Github
-2. Clone your fork locally:
-    ````sh
-    git clone https://github.com/<your_github_name>/galaxy-language-server.git
-    ````
-3. Create a virtual environment using conda and install the dependencies:
-
-    ```sh
-    conda create -n <environment-name> python=3.8
-    conda activate <environment-name>
-
-    # For the language server:
-    cd galaxy-language-server/server/
-    pip install -r requirements-dev.txt
-
-    # For the client vscode extension:
-    cd galaxy-language-server/client/
-    conda install -c conda-forge nodejs typescript
-    npm install
-    ```
-4. Run the tests locally
-    ```sh
-    # For the language server:
-    pytest
-    # Additionally you can check the coverage:
-    pytest --cov=server
-    ```
-
-5. Create a branch for local development:
-
-    ```sh
-    git checkout -b name-of-your-bugfix-or-feature
-    ```
-    >Now you can make your changes locally.
-    >
-    >Remember to check the [Style Guide](#style-guide) to maintain an uniform code style.
-
-6. When you're done making changes, check that your changes pass ``style linter`` and the ``tests``.
-    ```sh
-    flake8
-    pytest
-    ```
-
-7. Commit your changes and push your branch to GitHub::
-    ```sh
-    git add .
-    git commit -m "Your detailed description of your changes."
-    git push origin name-of-your-bugfix-or-feature
-    ```
-
-8. Submit a pull request through the GitHub website.
-
-
-### Setup Visual Studio Code for debugging
-If you want to debug the [extension](../client) and the [Language Server](../server) at the same time follow these steps:
-1. Select or activate your ``<environment-name>`` in Visual Studio Code as explained [here](https://code.visualstudio.com/docs/python/environments#_select-and-activate-an-environment).
-2. Open the `galaxy-language-server` directory in Visual Studio Code.
-3. Open debug view (`ctrl + shift + D`).
-4. Select `Server + Client` and click ``RUN`` (or press `F5`).
+To setup your development environment you can read [this guide](docs/CONTRIBUTING.md#getting-started).
 
 
 ## How to manually run the server

client/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Galaxy Tools (VS Code Extension) Changelog
 
+## [0.3.0] - 2021-01-01
+
+### Added
+
+- Custom language definition (XML dialect) for Galaxy Tool Wrapper files and basic embedded language syntax highlighting (`Cheetah` and `reStructuredText`) ([#79](https://github.com/galaxyproject/galaxy-language-server/pull/79)).
+- A custom command (`Ctrl+Alt+c`) to auto-generate the `<command>` section with boilerplate Cheetah template based on the current `inputs` and `outputs` defined in the tool ([#77](https://github.com/galaxyproject/galaxy-language-server/pull/77)).
+- A custom command (`Ctrl+Alt+t`) to auto-generate `<test>` cases based on the current `inputs` and `outputs` defined in the tool ([#73](https://github.com/galaxyproject/galaxy-language-server/pull/73)).
+- New snippets for common `param` definitions ([#71](https://github.com/galaxyproject/galaxy-language-server/pull/71/files)).
+
+### Changed
+
+- Updated Galaxy Language Server [v0.3.0](./server/CHANGELOG.md#030)
+
 ## [0.2.1] - 2020-11-22
 
 ### Changed

client/README.md

@@ -1,10 +1,10 @@
 # Galaxy Tools (Visual Studio Code Extension)
 This extensions provides XML validation, tag and attribute completion, help/documentation on hover and other *smart* features to assist in following best practices during the development process of XML tool wrappers for [Galaxy](https://galaxyproject.org/).
 
-> Please note this is still an early work in progress so **bugs and issues are expected**.
+> Please note this is still a work in progress so **bugs and issues are expected**. If you find any, you are welcome to open a new [issue](https://github.com/galaxyproject/galaxy-language-server/issues).
 
 # Requires ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/galaxy-language-server)
-In order to use the [Galaxy Language Server](https://pypi.org/project/galaxy-language-server/) features you need Python 3.8+ installed in your system.
+In order to use the [Galaxy Language Server](https://pypi.org/project/galaxy-language-server/) features you need Python 3.8+ installed in your system. See the [Installation](#Installation) section for more details.
 
 # Features
 ### Tag and attribute auto-completion 
@@ -49,6 +49,24 @@ Whenever you write a closing ``>`` the corresponding closing tag will be inserte
 Snippets can be really helpful to speed up your tool wrapper development. They allow to quickly create common blocks and let you enter just the important information by pressing ``tab`` and navigating to the next available value.
 >If you want to add more snippets check the [guide](./docs/CONTRIBUTING.md#adding-snippets) in the contribution guidelines.
 
+### Embedded syntax highlighting
+
+![Demo feature embedded syntax highlighting](../assets/feature.embedded.syntax.png)
+
+Basic support for `Cheetah` and `reStructuredText` syntax highlighting inside the `<command>`, `<configfile>` and `<help>` tags. The embedded code should be inside a `CDATA` block.
+
+### Auto-generate tests
+
+![Demo feature auto-generate tests](../assets/feature.generate.tests.gif)
+
+After you define the `<inputs>` and `<outputs>` of the tool, you can press `Ctrl+Alt+t` (or `Cmd+Alt+t` in Mac) to create a `<tests>` section with a basic structure and some test cases. This is especially useful when using conditionals and other nested parameters since you can get right aways most of the bolerplate XML.
+
+### Auto-generate command section
+
+![Demo feature auto-generate command section](../assets/feature.generate.command.gif)
+
+Similar to the [auto-generate tests](#Auto-generate-tests) command, but this time it will generate boilerplate `Cheetah` code for the `<command>` section.
+
 # Installation
 When the extension is activated for the first time, a notification will pop up informing that the `Galaxy Language Server` [Python package](https://pypi.org/project/galaxy-language-server/) must be installed.
 

client/package.json

@@ -5,7 +5,7 @@
   "author": "davelopez",
   "publisher": "davelopez",
   "license": "Apache-2.0",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "preview": true,
   "repository": {
     "type": "git",

docs/CONTRIBUTING.md

@@ -74,6 +74,9 @@ Adding a new snippet is really easy, you just need to edit the [snippets.json](.
 
 After testing your snippet in your local environment, just make a pull request and share it!
 
+### Customizing grammars
+You can help improve the syntax highlighting of the different languages that are used in a Galaxy tool wrapper (currently `XML`, `Cheetah` and `reStructuredText`). This can be done by extending or fixing the [TextMate grammars](https://macromates.com/manual/en/language_grammars) found [here](../client/src/syntaxes). You can learn more about how these grammars are used in the [VSCode documentation](https://code.visualstudio.com/api/language-extensions/syntax-highlight-guide).
+
 # Your First Contribution
 If this is your first time... congratulations! :tada: You will learn lots of things! For example, you can find a great number of resources [here](https://github.com/freeCodeCamp/how-to-contribute-to-open-source).
 
@@ -153,10 +156,11 @@ If you are using `Windows` we recommend installing and using [WSL](https://docs.
 8. Submit a pull request through the GitHub website.
 
 ### Setup Visual Studio Code for debugging
-If you want to debug the [extension](../client) and the [Language Server](../server) at the same time, follow these steps:
-1. Open the `galaxy-tool-extension` directory in Visual Studio Code
-2. Open debug view (`ctrl + shift + D`)
-3. Select `Server + Client` and press `F5`
+If you want to debug the [extension](../client) and the [Language Server](../server) at the same time follow these steps:
+1. Select or activate your ``<environment-name>`` in Visual Studio Code as explained [here](https://code.visualstudio.com/docs/python/environments#_select-and-activate-an-environment).
+2. Open the `galaxy-language-server` directory in Visual Studio Code.
+3. Open debug view (`ctrl + shift + D`).
+4. Select `Server + Client` and click ``RUN`` (or press `F5`).
 
 ## Pull Request Guidelines
 

server/CHANGELOG.md

@@ -1,4 +1,17 @@
 # Galaxy Language Server Changelog
+
+## [0.3.0] - 2021-01-01
+
+### Added
+
+- A custom command to auto-generate the `<command>` section with boilerplate Cheetah template based on the current `inputs` and `outputs` defined in the tool ([#77](https://github.com/galaxyproject/galaxy-language-server/pull/77)).
+- A custom command to auto-generate `<test>` cases based on the current `inputs` and `outputs` defined in the tool ([#73](https://github.com/galaxyproject/galaxy-language-server/pull/73)).
+
+### Fixed
+
+- Avoid processing unknown XML documents (aka *not* tool wrappers) ([#75](https://github.com/galaxyproject/galaxy-language-server/pull/75)).
+- Broken XML parsing when more than one comment block was present in the document ([#70](https://github.com/galaxyproject/galaxy-language-server/pull/70)).
+
 ## [0.2.1] - 2020-11-22
 
 ### Fixed

server/README.md

@@ -13,4 +13,4 @@
 
 
 # Getting Started
-See [this](https://github.com/davelopez/galaxy-language-server/blob/master/README.md#getting-started).
+See [this](https://github.com/galaxyproject/galaxy-language-server/blob/master/docs/CONTRIBUTING.md#getting-started).

server/galaxyls/services/language.py

@@ -2,7 +2,6 @@
 
 from galaxyls.services.tools.document import GalaxyToolXmlDocument
 from galaxyls.services.tools.generators.command import GalaxyToolCommandSnippetGenerator
-from galaxyls.services.tools.generators.snippets import SnippetGenerator
 from galaxyls.services.tools.generators.tests import GalaxyToolTestSnippetGenerator
 from pygls.types import (
     CompletionList,

server/requirements.txt

@@ -1,4 +1,4 @@
 pygls==0.9.1
-lxml==4.6.1
+lxml==4.6.2
 anytree==2.8.0
 galaxy-tool-util==20.9.1