Pular para o conteúdo

Primeiros passos

O djLint está no PyPI, onde precisa do Python 3.11 ou mais recente, e no npm, que traz o próprio Python. Em um projeto Python, adicione-o com o uv ou o pip. Em um projeto JavaScript, como um app Angular, um site Eleventy ou um tema da Shopify, com o npm.

Com o uv, adicione-o ao seu projeto como dependência de desenvolvimento:

Janela do terminal
uv add --dev djlint

Ou instale-o como uma ferramenta independente:

Janela do terminal
uv tool install djlint

Para executar o djLint no seu editor ou a cada commit, consulte Integrações e pre-commit.

Passe ao djLint a pasta com os seus templates e defina --profile com a sua linguagem de template. O perfil decide quais regras do linter rodam e como a sintaxe dos templates é formatada. Para um projeto Django:

Faça o lint dos templates (esse é o modo padrão, então dá para omitir --lint):

Janela do terminal
djlint templates --lint --profile=django

Veja o que a formatação mudaria. Com --check, o djLint mostra um diff e não mexe nos arquivos:

Janela do terminal
djlint templates --check --profile=django

Formate os arquivos no próprio lugar:

Janela do terminal
djlint templates --reformat --profile=django

A opção profile lista todos os perfis. Cada linguagem de template também tem uma página própria, por exemplo Django, Jinja ou Handlebars, que mostra como definir o perfil em um arquivo de configuração para não precisar passá-lo toda vez.

Se você adicionou o djLint ao projeto com uv add --dev, ele fica no ambiente do projeto: coloque uv run antes dos comandos, por exemplo uv run djlint templates --lint --profile=django. Com npm i -D, coloque npx antes deles, por exemplo npx djlint templates --lint --profile=django.

O djLint funciona com um caminho ou com o stdin.

Executando com um caminho:

Janela do terminal
djlint /path/to/templates --lint

Ou com um arquivo específico:

Janela do terminal
djlint /path/to/this.mustache --lint

Ou com o stdin:

Janela do terminal
echo "<div></div>" | djlint -

O stdin também pode ser usado para reformatar código. A saída será apenas o código formatado, sem mensagens.

Janela do terminal
echo "<div></div>" | djlint - --reformat

Saída:

<div></div>

Ao ler do stdin, o djLint não tem um caminho real para comparar com per-file-ignores nem para mostrar nas mensagens, então usa - por padrão. Passe --stdin-filename para informar ao djLint o caminho real do conteúdo recebido pelo pipe, por exemplo quando uma integração com editor envia o conteúdo de um arquivo pelo pipe ao salvar.

Janela do terminal
echo "<div></div>" | djlint - --stdin-filename templates/index.html
Código Significado
0 Tudo o que você pediu para o djLint verificar está limpo, ou todos os arquivos encontrados foram ignorados pela sua configuração.
1 O djLint encontrou erros de lint ou arquivos que precisam ser reformatados. --warn relata esses casos como avisos e, em vez disso, sai com 0.
2 O djLint não verificou o que você pediu: os caminhos não corresponderam a nenhum arquivo, um arquivo não pôde ser lido (não está em UTF-8, ou falta permissão), a linha de comando ou a configuração era inválida, ou o djLint falhou.

Somente o código 1 significa que o djLint analisou seus templates e não gostou do que encontrou, então um pipeline consegue distinguir uma verificação que falhou de uma execução que não verificou nada, como uma com um caminho errado ou com uma --extension que não corresponde mais a nada.

Arquivos que o djLint encontrou e depois ignorou de propósito, por meio de exclude, extend_exclude, use_gitignore ou require_pragma, não são um erro, e é isso que permite que exclude funcione com o pre-commit. Se um caminho sem templates for normal no seu pipeline, desative o código 2 com allow_empty_input:

Janela do terminal
djlint /path/to/templates --lint --allow-empty-input
Usage: djlint [OPTIONS] SRC ...
djLint · HTML template linter and formatter.
Modes:
--lint Lint the files. This is the default when
neither --reformat nor --check is given.
--reformat Format the files in place.
--check Show what formatting would change, without
changing the files.
--lsp Run as a language server over stdio, for
editors.
Files:
-e, --extension EXT Extension of the files to look for in folders.
[default: html]
--exclude PATHS Regexes of the paths to skip, comma-separated,
in place of the default list.
--extend-exclude PATHS Regexes of the paths to skip on top of the
exclude list, comma-separated.
--use-gitignore Also skip the paths that the .gitignore in the
project root lists.
--require-pragma Only format or lint files whose first line is
a djlint:on comment.
--stdin-filename PATH Path that stands for stdin in messages,
excludes and per-file ignores. [default: -]
--allow-empty-input Exit with 0 instead of 2 when the given paths
match no files.
Configuration:
--profile NAME Template language: html, django, jinja,
nunjucks, handlebars, liquid, golang, angular,
tera, askama, mako or all. It decides which
linter rules run and how template syntax is
formatted. Without one, formatting follows all
and the linter runs the rules of html.
--configuration FILE Global config file: a pyproject.toml,
djlint.toml or .djlintrc. The project's own
config file wins where both set an option.
--prefer-configuration Let the --configuration file win over the
project's own config file.
Linter:
-i, --ignore CODES Linter codes to skip, comma-separated, for
example H014,H017.
--include CODES Linter codes to turn on, comma-separated, for
example H017. Works for rules that are off by
default and for rules the profile leaves out.
--per-file-ignores <PATTERN CODES>...
Skip linter codes in the files whose path
matches a regex. Can be repeated.
--rules FILE Custom linter rules, in the .djlint_rules.yaml
format.
Output:
--quiet Do not print diffs, the progress bar or the
summary.
--warn Exit with 0 instead of 1 when there are lint
errors or files to reformat.
--statistics After linting, print how many times each code
was found.
--linter-output-format FORMAT Layout of each lint message, from {filename},
{line}, {end}, {code}, {message} and {match}.
[default: {code} {line} {message} {match}]
--github-output / --no-github-output
Print results as GitHub Actions annotations.
On by default inside GitHub Actions.
--sarif Print findings as a SARIF 2.1.0 JSON document,
for GitHub code scanning and other tools.
Layout:
--indent N Spaces per indent level. [default: 4, or
indent_size from .editorconfig]
--max-line-length N Join tags onto one line only when the line
fits within this length. [default: 120, or
max_line_length from .editorconfig]
--max-attribute-length N Spread a tag's attributes over lines once they
are longer than this. [default: 70]
--single-attribute-per-line When an opening tag wraps, put each attribute
on its own line.
--line-break-after-multiline-tag
When a tag's attributes are spread over lines,
start its content on a new line.
--no-indent-inner-html Do not indent <head> and <body> inside <html>.
--keep-br-inline Keep <br> on the line of the text it breaks.
--custom-blocks TAGS Names of the custom template blocks to indent,
comma-separated, for example toc.
--custom-html TAGS Names of the custom HTML tags to indent,
comma-separated, for example mjml.
--ignore-blocks TAGS Template blocks that do not indent their
contents, comma-separated.
--blank-line-after-tag TAGS Template tags to follow with a blank line,
comma-separated, for example load,extends.
--blank-line-before-tag TAGS Template tags to precede with a blank line,
comma-separated, for example load,extends.
--max-blank-lines N Keep at most this many blank lines in a row.
Has no effect with --preserve-blank-lines.
[default: 0]
--preserve-blank-lines Keep blank lines where possible.
--preserve-leading-space Keep the leading spaces of text lines where
possible.
--no-line-after-yaml Do not add a blank line after YAML front
matter.
Rewrites:
--close-void-tags Close void tags with a slash, so <img> becomes
<img />.
--ignore-case Do not fix the case of known HTML tags.
--sort-attributes Sort attributes by name, with id first and
class second.
--sort-load-tags Sort the libraries in {% load %} tags and drop
repeated ones.
--name-endblocks Name the block in its {% endblock %} when the
block spans lines.
--quote-style [double|single] Quotes for strings inside template tags.
[default: double]
--no-entity-formatting Do not rewrite entity references such as
&copy; as the characters they name.
--no-function-formatting Do not format the arguments of function calls
inside {{ }}.
--no-set-formatting Do not format the contents of {% set %} tags.
--preserve-class-newlines Keep the line breaks in class attributes
written across lines.
--format-attribute-template-tags
Format template syntax inside tag attributes.
CSS and JavaScript:
--format-css Also format the contents of <style> tags, with
css-beautify.
--indent-css N Indent width inside <style> tags, for
--format-css. [default: 4]
--format-js Also format JavaScript and JSON in <script>
tags, with js-beautify.
--indent-js N Indent width inside <script> tags, for
--format-js. [default: 4]
--format-attribute-js-json Also format JavaScript and JSON in attributes
such as onclick and x-data.
--format-attribute-js-json-pattern REGEX
Regex for the names of the attributes to
format as JavaScript or JSON. [default: on*
event handlers and Alpine, Vue, Angular and
Aurelia bindings]
--format-attribute-js-json-min-props N
Format an object only when it has at least
this many properties. [default: 2]
Other:
--version Show the version and exit.
-h, --help Show this message and exit.