nf-core / nf-core/tools

Lint that module nf-tests use a single config with sourcing the args from params

Open
#3,277 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Description of feature

From https://github.com/nf-core/website/pull/2832#issuecomment-2475638869

More importantly do we have an issue to create linting around this?

what exactly should we lint for?

A single nextflow.config file in tests, and that it contains the string ext.args = params., and not ext.args = [{'"]

Also the same if ext.prefix is used. Check the string starts with ext.prefix = params. Although I'm not sure if ext.prefix has a need to be used in a test config.

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 locating the nf-tests linting entry point and its existing tests. The check should require a single nextflow.config containing ext.args = params.; if ext.prefix is used, verify it starts with ext.prefix = params. Done means the linter accepts these forms and rejects the ext.args list form.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.