[CI]: Consider More Detailed JinJa2 Template Linting and Checking

Open
#2,698 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
python
Domain
ci-cd, tooling

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

discussion 💬 smolder🍲

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:

curlylint
Jinjalint

Dominant language
Python
Stars
2.5k
Forks
1.5k
PR merge metrics
No merged PRs in 30d

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.

More from exercism/python

All issues in exercism/python

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.