Lint for error messages in modules main.nf
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 322
- Forks
- 255
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 5
Description
Description of feature
Hey!
A while ago we learned that having the error message that conda is not supported too early in the main.nf of a module can lead to failures even when this particular tool is not run: see here https://github.com/nf-core/modules/issues/3683
For a bunch of modules the error message was then moved after script . It would be great, if we could have linting for this. And maybe while we are at it, also lint that error and not exit is used :)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the linting entry point for module main.nf and review the linked nf-core/modules issue for the early error-message failure. Define checks that catch the conda-not-supported message before script and require error rather than exit; add tests showing both violations are reported.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100