nf-core / nf-core/modules

[FEATURE] Add `stub` support to every module

Open
#4,570 12 comments 3 reactions 1 assignee View on GitHub

@HReed1 is already working on this.

Since Apr 27, 2026.

enhancement
Dominant language
Nextflow
Stars
429
Forks
1.1k
Avg merge
1d 6h
Merged PRs (30d)
153

Description

Using command stub blocks in Nextflow is useful when developing syntax and quickly testing pipelines. However, its use within nf-core is limited because the vast majority of nf-core modules do not have stub blocks.

My suggestion is to require that every module should have a stub block. All 1095 of them :trollface:

We can lint for the presence of this in linting and also potentially run with -stub-run in the module CI.

Although adding a stub block for one or two modules is not difficult, adding it for all will be a significant effort. This could be a nice project focus for a future hackathon(s).

### Tasks

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.