djhtml for Mac

A pure-Python Django/Jinja template indenter without dependencies.

DjHTML indents mixed HTML/CSS/JavaScript templates that contain

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.

If you are looking for an actual template _formatter_, check out the djangofmt project.

Installation

DjHTML requires Python 3.9 or higher and is compatible with all operating systems supported by Python. Install DjHTML with the following command:

$ pip install djhtml

Note that

instead of UTF-8. It is highly advised to set the environment variable PYTHONUTF8 to 1 with the

command:

C:> setx /m PYTHONUTF8 1

Usage

After installation you can indent templates using the djhtml command:

$ djhtml template.html reindented template.html 1 template has been reindented.

You can also run djhtml . to indent all HTML files beneath the current directory.

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. All available options are given by djthml -h / djthml --help.

Command-line arguments

DjHTML supports the following command-line arguments: -h / --help: Show help text. -v / --version: Show version number. -c / --check: Dry-run, checks without modifying files. -t / --tabwidth N: Tabwidth. The default is to guess. -b / --extra-block BEGIN,END: Define an extra non-standard block tag. Can be used multiple times.

fmt:off and fmt:on

You can exclude specific lines from being processed with the {# fmt:off #} and {# fmt:on #} operators:

Contents inside ... , `, / ... /, 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 djhtml command or the pre-commit hook. DjCSS mode. Will be entered when a tag is encountered in DjHTML mode. It can also be invoked directly with the command djcss. DjJS mode. Will be entered when a tag is encountered in DjHTML mode. It can also be invoked directly with the command djjs.

pre-commit configuration

A great 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:

Now run pre-commit autoupdate to automatically replace main with the latest tag on GitHub, as recommended by pre-commit.