Lint nf-test snapshots for the word "false"
Open
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
Sometimes we can only check if the contents of a file contains a specific string.
It can be quite easy to miss that the contains check when generating the snapshot was false
"sarscov2 illumina paired-end [fastq_gz]": {
"content": [
[
"versions.yml:md5,7b5a545483277cc0ff9189f8891e737f"
],
[
false
]
]
It would be good to fail linting in these cases.
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
The issue provides an nf-test snapshot JSON example but names no implementation files or tests. Start by locating the snapshot linting entry point in nf-core/tools and trace how content values are validated; done means linting reports snapshots containing false content checks, with a test covering the example.
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
- 45/100