Jinja template strings should only be linted for in template files
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 322
- Forks
- 255
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 5
Description
Description of feature
Hi,
I recently added pdf files to the docs folder in sarek, because we like to keep posters and such in the repo. These files seem to be linted now and nf-core lint throws an error:
╭─ [✗] 1 Pipeline Test Failed ─────────────────────────────────────────────────╮
│ │
│ template_strings: Found a Jinja template string in │
│ /home/runner/work/sarek/sarek/docs/posters/EMBO_2022_FHanssen.pdf L9442: │
│ ¼{{ö/^pÓÿ�Ó5ðgÅïÿ�Â'ᦶ³n¥©uDþ9?�p=ϵ}} │
│ │
╰──────────────────────────────────────────────────────────────────────────────╯
@ewels proposed here that only files present in the nf-core template should be linted for these strings.
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 by reproducing the failure with nf-core lint on the PDF at docs/posters/EMBO_2022_FHanssen.pdf, then trace the template_strings lint entry point. Check how files are selected for this check and compare them with files present in the nf-core template. Done means template strings are still detected in template files while binary PDFs and other non-template files no longer trigger the error.
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
- 35/100