Django/Jinja template indenter
Project description
DjHTML
A pure-Python Django/Jinja template indenter without dependencies.
DjHTML is a fully automatic template indenter that works with mixed HTML/CSS/Javascript templates that contain Django or Jinja template tags. It works similar to other code-formatting tools such as Black and interoperates nicely with pre-commit.
DjHTML is an indenter and not a formatter: it will only add/remove whitespace at the beginning of lines. It will not insert newlines or other characters. The goal is to correctly indent already well-structured templates, not to fix broken ones.
For example, consider the following incorrectly indented template:
<!doctype html>
<html>
<body>
{% block content %}
Hello, world!
{% endblock %}
<script>
$(function() {
console.log('Hi mom!');
});
</script>
</body>
</html>
This is what it will look like after processing by DjHTML:
<!doctype html>
<html>
<body>
{% block content %}
Hello, world!
{% endblock %}
<script>
$(function() {
console.log('Hi mom!');
});
</script>
</body>
</html>
Installation
Install DjHTML with the following command:
$ pip install djhtml
Usage
After installation you can indent templates using the djhtml
command:
$ djhtml template.html
reindented template.html
1 template has been reindented.
An exit status of 0 means that everything went well, regardless of
whether any files were changed. When the option -c / --check is
used, the exit status is 1 when one or more files would have changed,
but no changes are actually made. The exit status of 123 means that
there was an error while indenting one or more files. All available
options are given by djthml -h / djthml --help.
fmt:off and fmt:on
You can exclude specific lines from being processed with the
{# fmt:off #} and {# fmt:on #} operators:
<div class="
{# fmt:off #}
,-._|\
/ .\
\_,--._/
{# fmt:on #}
"/>
Contents inside <pre> ... </pre>, <!-- ... --->, /* ... */, and
{% comment %} ... {% endcomment %} tags are also ignored (depending
on the current mode).
Modes
The indenter operates in one of three different modes:
-
DjHTML mode: the default mode. Invoked by using the
djhtmlcommand or the pre-commit hook. -
DjCSS mode. Will be entered when a
<style>tag is encountered in DjHTML mode. It can also be invoked directly with the commanddjcss. -
DjJS mode. Will be entered when a
<script>tag is encountered in DjHTML mode. It can also be invoked directly with the commanddjjs.
pre-commit configuration
The best way to use DjHTML is as a pre-commit hook, so all your HTML, CSS and JavaScript files will automatically be indented upon every commit.
First, install pre-commit:
$ pip install pre-commit
$ pre-commit install
Then, add the following to your .pre-commit-config.yaml:
repos:
- repo: https://github.com/rtts/djhtml
rev: 'main' # replace with the latest tag on GitHub
hooks:
- id: djhtml
- id: djcss
- id: djjs
Now run pre-commit autoupdate to automatically replace main with
the latest tag on GitHub,
as recommended by pre-commit.
If you want to override a command-line option, for example to change
the default tabwidth, you change the entry point of these hooks:
hooks:
- id: djhtml
# Use a tabwidth of 2 for HTML files
entry: djhtml --tabwith 2
- id: djcss
- id: djjs
If you want to limit the files these hooks operate on, you can use pre-commit mechanisms for filtering. For example:
hooks:
- id: djhtml
# Indent only HTML files in template directories
files: .*/templates/.*\.html$
- id: djcss
# Run this hook only on SCSS files (CSS and SCSS is the default)
types: [scss]
- id: djjs
# Exclude JavaScript files in vendor directories
exclude: .*/vendor/.*
Now when you run git commit you will see something like the
following output:
$ git commit
DjHTML...................................................................Failed
- hook id: djhtml
- files were modified by this hook
reindented template.html
1 template has been reindented.
To inspect the changes that were made, use git diff. If you are
happy with the changes, you can commit them normally. If you are not
happy, please do the following:
-
Run
SKIP=djhtml git committo commit anyway, skipping thedjhtmlhook. -
Consider opening an issue with the relevant part of the input file that was incorrectly formatted, and an example of how it should have been formatted.
Your feedback for improving DjHTML is very welcome!
Development
Use your preferred system for setting up a virtualenv, docker environment, or whatever else, then run the following:
python -m pip install -e '.[dev]'
pre-commit install --install-hooks
Tests can then be run quickly in that environment:
python -m unittest discover -v
Or testing in all available supported environments and linting can be run
with nox:
nox
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
