Přeskočit na obsah

Začínáme

djLint je na PyPI, kde potřebuje Python 3.11 nebo novější, a na npm, který si nese vlastní Python. Do projektu v Pythonu ho přidejte přes uv nebo pip. Do projektu v JavaScriptu, například aplikace v Angularu, webu v Eleventy nebo šablony pro Shopify, přes npm.

S uv ho přidejte do projektu jako vývojovou závislost:

Terminál
uv add --dev djlint

Nebo ho nainstalujte jako samostatný nástroj:

Terminál
uv tool install djlint

Chcete-li djLint spouštět v editoru nebo při každém commitu, přečtěte si Integrace a pre-commit.

Předejte djLint složku se šablonami a v --profile uveďte svůj šablonovací jazyk. Na profilu závisí, která pravidla linteru se spustí a jak se naformátuje syntaxe šablon. Pro projekt v Djangu:

Lintujte šablony (lintování je výchozí režim, takže --lint můžete vynechat):

Terminál
djlint templates --lint --profile=django

Podívejte se, co by formátování změnilo. S --check djLint vypíše diff a soubory nechá beze změny:

Terminál
djlint templates --check --profile=django

Naformátujte soubory přímo na místě:

Terminál
djlint templates --reformat --profile=django

Všechny profily uvádí volba profile. Každý šablonovací jazyk má navíc vlastní stránku, například Django, Jinja nebo Handlebars, kde se dočtete, jak profil nastavit v konfiguračním souboru, abyste ho nemuseli zadávat pokaždé.

Pokud jste djLint přidali do projektu přes uv add --dev, je v prostředí projektu: příkazy spouštějte s uv run na začátku, například uv run djlint templates --lint --profile=django. Po npm i -D dejte na začátek místo toho npx, například npx djlint templates --lint --profile=django.

djLint pracuje s cestou i se standardním vstupem (stdin).

Spuštění s cestou:

Terminál
djlint /path/to/templates --lint

Nebo s konkrétním souborem:

Terminál
djlint /path/to/this.mustache --lint

Nebo se stdin:

Terminál
echo "<div></div>" | djlint -

Stdin lze použít i k přeformátování kódu. Výstupem bude jen naformátovaný kód bez dalších zpráv.

Terminál
echo "<div></div>" | djlint - --reformat

Výstup:

<div></div>

Při čtení ze stdin nemá djLint žádnou skutečnou cestu, se kterou by porovnal per-file-ignores nebo kterou by zobrazil ve zprávách, a proto ve výchozím nastavení používá -. Pomocí --stdin-filename sdělíte djLint skutečnou cestu obsahu předaného rourou, například když integrace v editoru při ukládání posílá obsah souboru rourou.

Terminál
echo "<div></div>" | djlint - --stdin-filename templates/index.html
Kód Význam
0 Vše, co měl djLint zkontrolovat, je v pořádku, nebo vaše konfigurace přeskočila všechny soubory, které našel.
1 djLint našel chyby lintování nebo soubory, které je potřeba přeformátovat. --warn je místo toho nahlásí jako varování a skončí s kódem 0.
2 djLint nezkontroloval to, co jste chtěli: cestám neodpovídaly žádné soubory, některý soubor nešel přečíst (není v UTF-8 nebo chybí oprávnění), příkazový řádek nebo konfigurace byly neplatné, nebo djLint selhal.

Jen kód 1 znamená, že se djLint na vaše šablony podíval a nelíbilo se mu, co našel, takže pipeline rozliší neúspěšnou kontrolu od spuštění, které nic nezkontrolovalo, například s chybnou cestou nebo s --extension, které už neodpovídá.

Soubory, které djLint našel a pak záměrně přeskočil kvůli exclude, extend_exclude, use_gitignore nebo require_pragma, nejsou chybou, a díky tomu funguje exclude v pre-commit. Pokud je pro vaši pipeline normální, že cesta neobsahuje žádné šablony, vypněte kód 2 pomocí allow_empty_input:

Terminál
djlint /path/to/templates --lint --allow-empty-input

Použití z příkazového řádku

Sekce “Použití z příkazového řádku”
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.