nf-core / nf-core/tools

`modules lint --fix` changes more entries in the meta.yml than expected

Open
#3,363 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Description of the bug

See also this Dicussion on the PR: https://github.com/nf-core/modules/pull/7201#discussion_r1888543191

Running linting with the --fix flag leads to the meta.yml being changed a lot while only one output pattern would have needed to be changed. Instead the whole output section of the meta.yml is affected. Changes look like:

Image

Seems as if the pattern part is moved up to the meta map and the type of the actual file output is changed to map and its description changed to the meta description.

Command used and terminal output
nf-core modules lint --fix custom/matrixfilter
System information

will be supplied by @nschcolnicov

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 reproducing nf-core modules lint --fix custom/matrixfilter and inspect the affected meta.yml output section. Compare the changes with the PR discussion at https://github.com/nf-core/modules/pull/7201#discussion_r1888543191. Done means --fix changes only the intended output pattern rather than unrelated output entries.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.