Git Product home page Git Product logo

action-nextflow-lint's Introduction

action-nextflow-lint

Nextflow linter

action-nextflow-lint's People

Contributors

cgpu avatar

Watchers

 avatar  avatar  avatar  avatar

action-nextflow-lint's Issues

As an action-nextflow-lint developer, I would like to have a parser for nextflow config files

Currently, information in nextflow.config cannot be parsed properly.
This is because the type of text is not appropriate to parse using Python packages such as ConfigParser. Therefore, current approach is to get values and keys by reading strings line by line. (i. e. Example)

Suggestion

To have a package to read config files properly. For instance:

>> read_data = open(“nextflow.config”)

>> read_data.profiles
////
standard {includeConfig params.config}
docker { docker.enabled = true }
test { includeConfig 'conf/test.config' }
singularity {includeConfig 'conf/singularity.config'}
test_gatk_mode { includeConfig 'conf/test_gatk_mode_small.config' }
awsbatch { includeConfig 'conf/awsbatch.config' }
test_awsbatch { includeConfig 'conf/test_awsbatch.config' }
test_gatk_awsbatch { includeConfig 'conf/test_gatk_awsbatch.config' }
////

This improvement might facilitate:

  • Linting
  • Pipeline Automation
  • Config Parsing

Create a profile checker script that checks if profile name matches the conf/<name>.config base name

Description of desired behaviour

  • The linter can detect if the name of the profile matches the basename of the respective config and report as a warning or error
profiles {
  should_fail { includeConfig 'conf/failing.config'}
  should_pass { includeConfig 'conf/should_pass.config' }
}
  • The Github action can report as a reviewer in the PR

  • The linting would provide a report similar to pytest where each screened profile status of the check should be

check: should_fail - FAILED ❌ 
check: should_pass - PASSED ✅ 

If even 1 profile check doesn’t pass, then the ci test, should fail

  • Add option to ignore some profiles awsbatch etc

References:

  • pytest output
  • codecov output

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.