CTFd/CTFd

Jinja HTML/Nunjucks linting

Open

#1193 opened on Dec 23, 2019

View on GitHub
 (7 comments) (0 reactions) (0 assignees)Python (5,091 stars) (1,927 forks)batch import
help wantedlong term fixeswishlist

Description

CTFd makes heavy use of Jinja because of it's origins as a Flask app. Most other code in CTFd is linted and prettified but Jinja doesn't appear to have great open source tools to pull this off. This is to gather resources and knowledge about different approaches that can be used.

Contributor guide

Tech stack
pythonflaskhtml
Domain
frontendtoolingdeveloper experience
Issue type
research
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
needs investigation
Prerequisites
basic knowledge of Jinjafamiliarity with Flask
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
20
Research direction
This issue is about exploring tools for linting Jinja templates in CTFd. Start by reading the existing comments (https://github.com/CTFd/CTFd/issues/1193) to see what has been discussed. Then research tools like djlint or Nunjucks linters. Compile a list of approaches, their pros and cons, and perhaps try running them on a sample template. The deliverable is a summary of findings with recommendations.