Git Product home page Git Product logo

snakemake-lang-vscode-plugin's Introduction

Snakemake Language Support

Provides basic language support for Snakemake files (Snakefile, *.smk). Feedback, suggestions, and contributions are very welcome!

This project has been started by Peter Alping, and can be considered a fork of this repository.

Features

  • Syntax definitions based on Python, with added Snakemake keywords
  • Language rules based on Python
  • Snippets

Example

Snakemake syntax highlighting example

Example taken from Snakemake documentation.

Supported Syntax

Keywords and Functions
  • Configurations
    • configfile
    • include
    • localrules
    • onerror
    • onstart
    • onsuccess
    • ruleorder
    • snakefile
    • workdir
  • Rules
    • checkpoint
    • rule
    • subworkflow
  • Rule Parameters
    • benchmark
    • conda
    • cwl
    • group
    • input
    • log
    • message
    • output
    • params
    • priority
    • resources
    • run
    • script
    • shadow
    • shell
    • singularity
    • threads
    • version
    • wildcard_constraints
    • wrapper
  • Functions
    • ancient
    • directory
    • expand
    • pipe
    • protected
    • temp
    • touch
    • unpack

TODO

  • Indentation rules (really tricky for some reason)
  • Recognize string substitutions: "command {input}"
  • Recognize wildcard constraints inside string substitutions: "{sample,[A-Za-z0-9]+}"

Snakemake Support for other Editors

snakemake-lang-vscode-plugin's People

Contributors

alping avatar bilke avatar calebthomas259 avatar ftabaro avatar github-actions[bot] avatar johanneskoester avatar lustigeperson avatar

Watchers

avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.