[CI]: Consider More Detailed JinJa2 Template Linting and Checking
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
Research direction
Start by reviewing the current CI check that validates generated test files with Black. Read the linked curlylint and Jinjalint rule documentation and compare their coverage with the indentation problem described here. The work is done when the project has agreed detailed Jinja2 checks and those checks are integrated into CI.
Written by the indexing model from the issue text.
Description
After doing numerous JinJa2 template PRs and test file regeneration (and getting caught by a nasty indentation bug), it feels like we could benefit from setting up some linting rules and checks for JinJa2 templates that are a bit more detailed and custom. Right now, we check that the files will produce test files that can be linted by Black, but we don't really do much additional validation.
Marking this as a discussion, since I haven't formed many more thoughts that that around this issue. But I anticipate both more contributors and more changes to templates going forward, so thought I'd make a note here of what I have found so far:
- Dominant language
- Python
- Stars
- 2.5k
- Forks
- 1.5k
- Avg merge
- 2d 17h
- Merged PRs (30d)
- 2
Getting set up
- Ships a Dockerfile or Docker Compose file
- No pull request template
- Read the contributing 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.
More from exercism/python
-
Difficulty 1/5 Under an hour Newbie friendliness 75/100
-
Difficulty 1/5 Under an hour Newbie friendliness 35/100
-
Difficulty 4/5 3-5 days Newbie friendliness 25/100
-
[General Docs] Audit/Cleanup of Track General/Shared DocsPossibly taken @Yrahcaz7 claimed this 6 days ago. Open
-
[Decimals]: New Concept and Concept ExerciseMay be free again @BethanyG claimed this 516 days ago, and no pull request is open. Open
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 88/100
snap-stanford/Biomni#380 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
microsoft/playwright-python#3361 ·
Maintainers usually reply within 1 day
-
documentation priority: low size: S status: needs triage
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
cubrid-lab/sqlalchemy-cubrid#1397 ·
Maintainers usually reply within 1 day
-
documentation priority: low size: S status: needs triage
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
cubrid-lab/pycubrid#1307 ·
Maintainers usually reply within 1 day
-
[Bug]: Installer hides SSL certificate errors as bare URLError, and the suggested fix can't workOpenbug
Difficulty 2/5 1-3 hours Newbie friendliness 80/100
ShaftHQ/chaosengine-harness#143 ·
Maintainers usually reply within 1 day