Pierwsze kroki
Instalacja
Dział zatytułowany „Instalacja”djLint jest w PyPI, gdzie wymaga Pythona 3.11 lub nowszego, oraz w npm, który ma własnego Pythona. Do projektu w Pythonie dodaj go przez uv albo pip. Do projektu w JavaScripcie, takiego jak aplikacja w Angularze, strona w Eleventy czy motyw Shopify, przez npm.
Za pomocą uv dodaj go do projektu jako zależność deweloperską:
uv add --dev djlintMożesz też zainstalować go jako samodzielne narzędzie:
uv tool install djlintpip install djlintPakiet npm ma własnego Pythona, więc potrzebuje tylko Node.js 16.9 lub nowszego. Ma kompilacje dla Linuksa na x64, Arm64, ppc64le, s390x i riscv64, macOS na x64 i Arm64 oraz Windows na x64, x86 i Arm64. Na Linuksie z musl, takim jak Alpine, działa na x64 i Arm64. Dodaj go do projektu jako zależność deweloperską:
npm i -D djlintMożesz też zainstalować go globalnie:
npm i -g djlintZa pomocą pipx:
pipx install djlintW systemie macOS lub Linux za pomocą rozwijanej przez społeczność formuły Homebrew:
brew install djlintAby uruchamiać djLint w edytorze lub przy każdym commicie, zobacz Integracje i pre-commit.
Pierwsze uruchomienie
Dział zatytułowany „Pierwsze uruchomienie”Wskaż djLint folder z szablonami i ustaw w --profile swój język szablonów. Od profilu zależy, które reguły lintera zostaną uruchomione i jak zostanie sformatowana składnia szablonów. Dla projektu w Django:
Zlintuj szablony (lintowanie to tryb domyślny, więc --lint możesz pominąć):
djlint templates --lint --profile=djangoSprawdź, co zmieniłoby formatowanie. Z --check djLint wypisuje diff i nie rusza plików:
djlint templates --check --profile=djangoSformatuj pliki w miejscu:
djlint templates --reformat --profile=djangoWszystkie profile wymienia opcja profile. Każdy język szablonów ma też własną stronę, na przykład Django, Jinja albo Handlebars, na której widać, jak ustawić profil w pliku konfiguracyjnym, żeby nie podawać go za każdym razem.
Jeśli djLint został dodany do projektu przez uv add --dev, znajduje się w środowisku projektu: poprzedzaj polecenia uv run, na przykład uv run djlint templates --lint --profile=django. Po npm i -D poprzedzaj je zamiast tego npx, na przykład npx djlint templates --lint --profile=django.
Ścieżka a stdin
Dział zatytułowany „Ścieżka a stdin”djLint działa ze ścieżką lub ze standardowym wejściem (stdin).
Uruchomienie ze ścieżką:
djlint /path/to/templates --lintAlbo z konkretnym plikiem:
djlint /path/to/this.mustache --lintAlbo ze stdin:
echo "<div></div>" | djlint -Stdin można też wykorzystać do przeformatowania kodu. Na wyjściu pojawi się wtedy wyłącznie sformatowany kod, bez komunikatów.
echo "<div></div>" | djlint - --reformatWynik:
<div></div>Przy czytaniu ze stdin djLint nie ma prawdziwej ścieżki, którą mógłby dopasować do per-file-ignores lub pokazać w komunikatach, więc domyślnie używa -. Przekaż --stdin-filename, aby podać djLint prawdziwą ścieżkę przekazywanej treści, na przykład gdy integracja z edytorem przesyła przy zapisie zawartość pliku.
echo "<div></div>" | djlint - --stdin-filename templates/index.htmlKody wyjścia
Dział zatytułowany „Kody wyjścia”| Kod | Znaczenie |
|---|---|
0 |
Wszystko, co djLint miał sprawdzić, jest w porządku albo każdy znaleziony plik został pominięty zgodnie z konfiguracją. |
1 |
djLint znalazł błędy lintowania lub pliki wymagające przeformatowania. Przy --warn są one zgłaszane jako ostrzeżenia, a djLint kończy działanie z kodem 0. |
2 |
djLint nie sprawdził tego, o co go poproszono: ścieżki nie pasowały do żadnych plików, nie udało się odczytać pliku (nie jest w UTF-8 albo brak uprawnień), wiersz poleceń lub konfiguracja były nieprawidłowe albo djLint zawiódł. |
Tylko kod 1 oznacza, że djLint przejrzał twoje szablony i nie spodobało mu się to, co znalazł, więc potok CI odróżni nieudane sprawdzenie od uruchomienia, które niczego nie sprawdziło, na przykład z błędną ścieżką albo z --extension, które już do niczego nie pasuje.
Pliki, które djLint znalazł, a potem celowo pominął z powodu exclude, extend_exclude, use_gitignore lub require_pragma, nie są błędem i dzięki temu exclude działa w pre-commit. Jeśli w twoim potoku CI ścieżka bez szablonów jest czymś normalnym, wyłącz kod 2 opcją allow_empty_input:
djlint /path/to/templates --lint --allow-empty-inputUżycie w wierszu poleceń
Dział zatytułowany „Użycie w wierszu poleceń”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 © 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.