nf-core / nf-core/tools

Lint pipeline schema with meta-schema

Open
#2,654 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

linting
Dominant language
Python
Stars
322
Forks
255
Avg merge
2d 3h
Merged PRs (30d)
5

Description

Description of feature

Since https://github.com/nf-core/tools/issues/2436 is completed and we have parameters_meta_schema.json, we can automatically validate that pipeline schema are valid nextflow schema.

This should be a pipeline lint test that raises a failure if something is wrong.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading parameters_meta_schema.json and locating the existing pipeline lint tests in the nf-core/tools repository. Run the current lint test suite to understand its structure. Done means the lint pipeline detects and fails on pipeline schemas that do not conform to the meta-schema.

Written by the indexing model from the issue text.

Assessment

Tech stack
json, python
Domain
testing, tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.