nf-core / nf-core/tools

Update lint checks for `modules_testdata_base_path` and `pipelines_testdata_base_path`

Open Beginner friendly
#4,176 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

The parameters modules_testdata_base_path and pipelines_testdata_base_path currently need to be defined in both tests/nextflow.config and nextflow.config. To prevent duplication of parameter definitions, simplify updates, and reduce ambiguity, it would be better if parameters were only defined once. This should be done in nextflow.config only so that configs included here can access these variables, but it is currently not possible due to current linting checks, for example:

nf_test_content: 'tests/nextflow.config' does not contain pipelines_testdata_base_path

For this, it is necessary to:

  • Remove modules_testdata_base_path and pipelines_testdata_base_path from tests/nextflow.config.
  • Remove associated linting checks for the content of tests/nextflow.config.
  • Add linting checks for the content of nextflow.config instead.

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

Inspect tests/nextflow.config and nextflow.config, then locate the lint checks that validate their parameter contents. Remove the duplicated parameters and update the checks so nextflow.config is validated instead; done when the lint checks pass with definitions only in nextflow.config.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Refactor
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
72/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.