Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add basic support for Workflow Test Files '*-test.yml' #63

Merged
merged 98 commits into from
May 31, 2024

Conversation

davelopez
Copy link
Owner

@davelopez davelopez commented Dec 4, 2023

This PR adds a new workflow-tests-language-service package with a basic implementation of a language service for Galaxy workflow tests definition files.

It also includes a big refactoring using a new IoC container approach based on Inversify and much more test coverage.

The schema definition for workflow test files is still experimental (galaxyproject/galaxy#17128) but good enough to be very useful already (thanks to @mvdbeek).

Features:

  • YAML syntax coloring and validation
  • Schema support
    • Schema-based help tooltips
      image
    • Basic schema-based auto-completion
      image
    • Basic schema-based validation
      image
  • Associated WF file support
    Given the following associated workflow:
    class: GalaxyWorkflow
    doc: ""
    inputs:
      the_input:
        type: File
        doc: This is the documentation for the input parameter.
      a collection:
        type: Collection
        collection_type: list
    outputs:
      the_output:
        outputSource: cat1/out_file
    steps:
      cat:
        tool_id: cat1
        doc: ""
        in:
          input1: the_input
    
    • Documentation on hover for inputs/outputs
      image
    • Auto-complete input/output names
      image
    • Validate input/outputs
      image

@davelopez davelopez added the enhancement New feature or request label Dec 4, 2023
Rename WorkflowLanguageService to LanguageServiceBase and make it generic (for any kind of documents)
as it doesn't have anything particularly workflow related about it.

Includes more rename refactorings around language services definitions.
Nothing particularly workflow related about it.
For some reason webpack doesn't seem to find the mapping...
Add experimental decorators and emit decorator
metadata to tsconfig.json
Unfortunately, the existing yaml-language-server from RedHat has some dependencies that conflict with the browser version of the extension.

The code related to schema handling, with some simplifications and adaptations for our use case, has been included here.
@davelopez davelopez force-pushed the add_wf_tests_document_support branch from 3a93886 to 5ded943 Compare May 28, 2024 16:32
@davelopez davelopez marked this pull request as ready for review May 31, 2024 14:39
@davelopez davelopez merged commit f82b850 into main May 31, 2024
4 checks passed
@davelopez davelopez deleted the add_wf_tests_document_support branch May 31, 2024 14:47
@davelopez davelopez added this to the v0.4.0 milestone Jun 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant