Przejdź do głównej zawartości

Konfiguracja

Konfigurację zapisuje się w pliku pyproject.toml projektu, w djlint.toml lub .djlint.toml albo w .djlintrc. Opcje wiersza poleceń mają pierwszeństwo przed plikiem konfiguracyjnym, ale flaga może opcję tylko włączyć, więc nie wyłączy przełącznika ustawionego w pliku konfiguracyjnym. Ustawienia projektu mają pierwszeństwo przed globalnym plikiem konfiguracyjnym podanym przez --configuration, chyba że ustawiono --prefer-configuration.

djLint szuka tych plików, idąc w górę od pierwszej sprawdzanej ścieżki (dla - od folderu z --stdin-filename, a bez tej opcji od bieżącego katalogu). Zatrzymuje się na pierwszym folderze, w którym jest plik djlint.toml, .djlint.toml, .djlintrc, .djlint_rules.yaml albo pyproject.toml z [tool.djlint], i nigdy nie wychodzi poza katalog główny repozytorium (folder z folderem lub plikiem .git albo z folderem .hg). pyproject.toml bez ustawień djLint go nie zatrzymuje, więc pakiet w monorepo z własnym pyproject.toml dostaje ustawienia repozytorium. djLint czyta tylko folder, na którym się zatrzymał: [tool.djlint] z jego pyproject.toml, jeśli ta tabela coś ustawia, a jeśli nie, jego djlint.toml lub .djlint.toml, a w ostateczności jego .djlintrc, i ostrzega o plikach, które tam leżą, ale nie są czytane.

Jeśli ani wiersz poleceń, ani konfiguracja nie ustawiają indent lub max_line_length, djLint bierze indent_size lub max_line_length z plików .editorconfig, tak jak edytory: każdy plik dostaje je według własnej ścieżki, najbliższy .editorconfig wygrywa, a te wyżej uzupełniają resztę, aż do pliku z root = true lub do katalogu głównego projektu.

Plik pyproject.toml ma format toml.

[tool.djlint]
profile = "django"
ignore = ["H014", "H015"]

Pliki djlint.toml i .djlint.toml mają format toml.

profile = "django"
ignore = ["H014", "H015"]

Plik .djlintrc ma format json.

{ "profile": "django", "ignore": ["H014", "H015"] }

Opcje z wieloma wartościami, takie jak ignore, przyjmują listę. Działa też ciąg rozdzielony przecinkami, na przykład "H014,H015", którego wymaga djLint starszy niż 1.41.

Od wersji 1.51 djLint ostrzega przed ustawieniem lub kodem reguły, którego nie zna, i podaje najbliższy znany.

allow_empty_input

od wersji 1.44.0 formatter linter --allow-empty-input

Domyślnie: false

Kończy działanie z kodem 0 zamiast 2, gdy podane ścieżki nie pasują do żadnego pliku. Pliki, które zostały znalezione, a następnie pominięte przez exclude, extend_exclude, use_gitignore lub require_pragma, i tak kończą działanie z kodem 0.

allow_empty_input=true

blank_line_after_tag

od wersji 0.4.2 formatter --blank-line-after-tag

Domyślnie: brak

Tagi szablonu, po których ma się znaleźć pusty wiersz, na przykład load i extends. Grupa takich tagów z rzędu dostaje jeden pusty wiersz po ostatnim z nich, a na końcu bloku pusty wiersz nie jest dodawany.

blank_line_after_tag=["load", "extends", "include"]

blank_line_before_tag

od wersji 1.8.0 formatter --blank-line-before-tag

Domyślnie: brak

Tagi szablonu, przed którymi ma się znaleźć pusty wiersz, na przykład load i extends. Grupa takich tagów z rzędu dostaje jeden pusty wiersz przed pierwszym z nich, a na początku pliku lub bloku pusty wiersz nie jest dodawany.

blank_line_before_tag=["load", "extends", "include"]

close_void_tags

od wersji 1.26.0 formatter linter --close-void-tags

Domyślnie: false

Zamyka znane tagi void ukośnikiem, dzięki czemu <img> staje się <img />. Przy tej opcji nie jest zgłaszana reguła H018, która wymaga czegoś odwrotnego.

close_void_tags=true

configuration

od wersji 1.13.0 formatter linter --configuration

Globalny plik konfiguracyjny, pyproject.toml, djlint.toml lub .djlintrc, na przykład w twoim folderze domowym. Własny plik konfiguracyjny projektu wygrywa tam, gdzie oba ustawiają opcję, chyba że włączono prefer_configuration.

Okno terminala
--configuration ~/.djlintrc

custom_blocks

od wersji 0.3.5 formatter --custom-blocks

Domyślnie: brak

Nazwy własnych bloków szablonu do wcinania, na przykład toc dla {% toc %}...{% endtoc %}.

custom_blocks=["toc", "example"]

custom_html

od wersji 0.7.0 formatter --custom-html

Domyślnie: brak

Nazwy własnych tagów HTML do wcinania, na przykład mjml lub simple-greeting. Nazwa może być wyrażeniem regularnym, jak mj-\w+.

custom_html=["mjml", "simple-greeting", 'mj-\w+']

exclude

od wersji 0.4.0 linter formatter --exclude

Domyślnie: "__pypackages__,_build,_site,.bzr,.direnv,.eggs,.git,.git-rewrite,.hg,.nox,.svn,.tox,.venv,build,dist,htmlcov,node_modules,site-packages,venv"

Ścieżki do pominięcia, zamiast domyślnej listy. Każdy wpis to wyrażenie regularne dopasowywane do całych nazw folderów lub plików w ścieżce względnej wobec katalogu głównego projektu lub sprawdzanego folderu, na przykład vendor lub templates/legacy, więc *.min.html zapisuje się jako .*\.min\.html.

exclude=[".venv", "venv", "build"]

extend_exclude

od wersji 0.4.0 linter formatter --extend-exclude

Domyślnie: brak

Ścieżki do pominięcia oprócz tych z exclude albo, gdy exclude nie jest ustawione, z domyślnej listy, w postaci wyrażeń regularnych takich jak w exclude.

extend_exclude=[".custom"]

extension

od wersji 0.0.5 linter formatter --extension

Domyślnie: "html"

Rozszerzenie plików wyszukiwanych w folderach. Przyjmuje jedno rozszerzenie; plik podany z nazwy jest sprawdzany niezależnie od rozszerzenia.

extension="html.dj"

files

od wersji 1.14.0 linter formatter

Domyślnie: brak

Ścieżki do sprawdzenia zamiast tych z wiersza poleceń, gdzie trzeba wtedy podać -, tak jak przy używaniu stdin. --stdin-filename sprawia, że - mimo to oznacza stdin.

[tool.djlint]
files=["index.html"]

format_attribute_js_json

od wersji 1.37.0 formatter --format-attribute-js-json

Domyślnie: false

Formatuje także kod JavaScript i JSON w atrybutach takich jak onclick i x-data, czyli tych, które wskazuje format_attribute_js_json_pattern. Obiekt z mniejszą liczbą właściwości niż format_attribute_js_json_min_props pozostaje w jednym wierszu.

format_attribute_js_json=true

format_attribute_js_json_min_props

od wersji 1.37.0 formatter --format-attribute-js-json-min-props

Domyślnie: 2

Formatuje obiekt tylko wtedy, gdy ma co najmniej tyle właściwości. Obiekt z mniejszą liczbą właściwości pozostaje w jednym wierszu.

format_attribute_js_json_min_props=3

format_attribute_js_json_pattern

od wersji 1.37.0 formatter --format-attribute-js-json-pattern

Domyślnie: "^(?:on[a-z]+|x-[a-z\\-]+|@[a-z\\-]+|:[a-z\\-]+|v-[a-z\\-]+|\\([a-z\\-]+\\)|\\[[a-z\\-]+\\]|\\*ng[A-Z][a-zA-Z]*|[a-z\\-]+\\.(bind|delegate|call|trigger))$"

Wyrażenie regularne dla nazw atrybutów, które mają być formatowane jako JavaScript lub JSON. Domyślne obejmuje procedury obsługi zdarzeń on* oraz wiązania Alpine, Vue, Angulara i Aurelii.

format_attribute_js_json_pattern="^(on[a-z]+|data-[a-z-]+|x-[a-z-]+)$"

format_attribute_template_tags

od wersji 0.6.7 formatter --format-attribute-template-tags

Domyślnie: false

Formatuje składnię szablonu wewnątrz atrybutów tagów.

format_attribute_template_tags=true

format_css

od wersji 1.9.0 formatter --format-css

Domyślnie: false

Formatuje także zawartość tagów <style> za pomocą css-beautify. Składnia szablonów w ich wnętrzu nie jest w pełni obsługiwana.

Wcięcie wewnątrz tagów <style> ustawia indent_size w tabeli css lub --indent-css w wierszu poleceń, domyślnie 4. Tabela przyjmuje też pozostałe opcje css-beautify.

[tool.djlint]
format_css=true
[tool.djlint.css]
indent_size=5

format_js

od wersji 1.9.0 formatter --format-js

Domyślnie: false

Formatuje także kod JavaScript i JSON w tagach <script> za pomocą js-beautify. Skrypt, którego type nie jest ani JavaScriptem, ani JSON-em, na przykład szablon po stronie klienta w text/template, zostaje bez zmian. Składnia szablonów w ich wnętrzu nie jest w pełni obsługiwana.

Wcięcie wewnątrz tagów <script> ustawia indent_size w tabeli js lub --indent-js w wierszu poleceń, domyślnie 4. Tabela przyjmuje też pozostałe opcje js-beautify.

[tool.djlint]
format_js=true
[tool.djlint.js]
indent_size=5

github_output

od wersji 1.37.0 formatter linter --github-output

Domyślnie: brak

Wypisuje wyniki jako adnotacje GitHub Actions. W GitHub Actions jest domyślnie włączone, a --no-github-output je wyłącza. Zobacz GitHub Actions.

Okno terminala
--github-output

ignore

od wersji 0.1.5 linter --ignore

Domyślnie: brak

Kody lintera do pominięcia.

ignore=["H014", "H015"]

ignore_blocks

od wersji 1.24.0 formatter --ignore-blocks

Domyślnie: brak

Bloki szablonu, które nie wcinają swojej zawartości. Ich elementy potomne są traktowane jak elementy równorzędne bloku i odpowiednio do tego wcinane.

ignore_blocks=["raw", "example"]

ignore_case

od wersji 1.23.0 formatter linter --ignore-case

Domyślnie: false

Nie poprawia wielkości liter w znanych tagach HTML. Przy tej opcji nie są zgłaszane H009 i H010.

[tool.djlint]
ignore_case=true

include

od wersji 1.20.0 linter --include

Domyślnie: brak

Kody lintera do włączenia, także domyślnie wyłączone lub pominięte przez profil.

include=["H014", "H015"]

indent

od wersji 0.3.5 formatter --indent

Domyślnie: 4

Liczba spacji na poziom wcięcia. Gdy opcja nie jest ustawiona, djLint używa wartości indent_size, którą .editorconfig przypisuje plikowi, jeśli taka jest.

indent=3

keep_br_inline

od wersji 1.45.0 formatter --keep-br-inline

Domyślnie: false

Zostawia <br> w wierszu tekstu, który dzieli, zamiast przenosić go do osobnego wiersza. Nie dotyczy to <hr>, który renderuje się jako linia pod poprzedzającą treścią.

keep_br_inline=true

line_break_after_multiline_tag

od wersji 1.27.0 formatter --line-break-after-multiline-tag

Domyślnie: false

Gdy atrybuty tagu są rozłożone na kilka wierszy, zaczyna jego zawartość w nowym wierszu.

line_break_after_multiline_tag=true

linter_output_format

od wersji 0.6.7 linter --linter-output-format

Domyślnie: "{code} {line} {message} {match}"

Układ każdego komunikatu lintera, złożony z {filename}, {line}, {end}, {code}, {message} i {match}. Bez {filename} wyniki są grupowane według plików, a każda grupa dostaje nagłówek.

linter_output_format="{filename}:{line}: {code} {message} {match}"

max_attribute_length

od wersji 0.5.8 formatter --max-attribute-length

Domyślnie: 70

Gdy atrybuty tagu są dłuższe niż ta wartość, formater rozkłada je na kilka wierszy.

max_attribute_length=10

max_blank_lines

od wersji 1.31.0 formatter --max-blank-lines

Domyślnie: 0

Zostawia najwyżej tyle pustych wierszy z rzędu, więc 0 je usuwa. Nie działa razem z preserve_blank_lines.

max_blank_lines=5

max_line_length

od wersji 0.5.7 formatter --max-line-length

Domyślnie: 120

Formater łączy niektóre tagi HTML i tagi szablonu w jeden wiersz tylko wtedy, gdy wiersz mieści się w tej długości. Gdy opcja nie jest ustawiona, djLint używa wartości max_line_length, którą .editorconfig przypisuje plikowi, jeśli taka jest.

max_line_length=100

name_endblocks

od wersji 1.45.0 formatter --name-endblocks

Domyślnie: false

Wpisuje nazwę bloku do zamykającego go {% endblock %}, jeśli blok zajmuje kilka wierszy. Tego właśnie wymaga T003.

name_endblocks=true

no_entity_formatting

od wersji 1.45.0 formatter --no-entity-formatting

Domyślnie: false

Nie zamienia odwołania do encji na znak, który ono oznacza, więc &copy; pozostaje w zapisanej postaci, zamiast stać się ©. Encje niosące składnię oraz encje niewidoczne i tak nigdy nie są zamieniane. H023 nadal zgłasza encje przy tej opcji; aby zachować encje, dodaj H023 do ignore.

no_entity_formatting=true

no_function_formatting

od wersji 1.30.2 formatter --no-function-formatting

Domyślnie: false

Nie formatuje argumentów wywołań funkcji wewnątrz {{ }}.

no_function_formatting=true

no_indent_inner_html

od wersji 1.45.0 formatter --no-indent-inner-html

Domyślnie: false

Nie wcina <head> i <body> wewnątrz <html>, czyli układa dokument tak jak wbudowany formater HTML w VS Code.

no_indent_inner_html=true

no_line_after_yaml

od wersji 1.29.0 formatter --no-line-after-yaml

Domyślnie: false

Nie dodaje pustego wiersza po front matter w YAML.

no_line_after_yaml=true

no_set_formatting

od wersji 1.30.2 formatter --no-set-formatting

Domyślnie: false

Nie formatuje zawartości tagów {% set %}.

no_set_formatting=true

per_file_ignores

od wersji 1.7.0 linter --per-file-ignores

Domyślnie: brak

Kody lintera do pominięcia w plikach, których ścieżka pasuje do wyrażenia regularnego. W pliku konfiguracyjnym klucz to per-file-ignores, z łącznikami.

[tool.djlint.per-file-ignores]
"file.html"= "H026,H025"
"file_two.html"="H001"

prefer_configuration

od wersji 1.45.0 formatter linter --prefer-configuration

Domyślnie: false

Pozwala, by plik wskazany przez --configuration miał pierwszeństwo przed własnym plikiem konfiguracyjnym projektu, który domyślnie wygrywa tam, gdzie oba ustawiają tę samą opcję. Tylko w wierszu poleceń, ponieważ decyduje o tym, jak wczytywane są same pliki konfiguracyjne.

Okno terminala
--prefer-configuration

preserve_blank_lines

od wersji 1.3.0 formatter --preserve-blank-lines

Domyślnie: false

Tam, gdzie to możliwe, zachowuje puste wiersze. Przydatne w szablonach innych niż HTML, w których puste wiersze są celowe.

preserve_blank_lines=true

preserve_class_newlines

od wersji 1.39.0 formatter --preserve-class-newlines

Domyślnie: false

Zachowuje podziały wierszy w atrybutach class zapisanych w kilku wierszach.

preserve_class_newlines=true

preserve_leading_space

od wersji 1.2.0 formatter --preserve-leading-space

Domyślnie: false

Tam, gdzie to możliwe, zachowuje spacje na początku wierszy tekstu. Przydatne w szablonach innych niż HTML, w których wcięcia tekstu są celowe.

preserve_leading_space=true

profile

od wersji 0.4.5 linter formatter --profile

Domyślnie: brak

Język szablonów. Od niego zależy, które reguły lintera są uruchamiane i jak formatowana jest składnia szablonów: na przykład w handlebars wewnątrz tagów {{#if}} nie ma spacji.

Bez profilu djLint formatuje składnię wszystkich języków szablonów tak jak all, a linter stosuje reguły html.

Opcje:

  • html
  • django
  • jinja
  • nunjucks (dla nunjucks i twig)
  • handlebars (dla handlebars i mustache)
  • liquid (shopify, jekyll, eleventy)
  • golang (szablony go; hugo, helm)
  • angular
  • tera (także dla zola; dla minijinja użyj jinja)
  • askama (szablony w stylu jinja w rust; wyrażenia rust nigdy nie są formatowane)
  • mako (wiersze sterujące i komentarze ## zostają bez zmian)
  • all (wszystkie języki szablonów naraz)
profile="django"

quiet

od wersji 0.0.9 formatter linter --quiet

Domyślnie: false

Nie wypisuje diffów, paska postępu ani podsumowania.

quiet=true

quote_style

od wersji 1.45.0 formatter linter --quote-style

Domyślnie: "double"

Cudzysłowy dla ciągów znaków wewnątrz tagów szablonu: double lub single. T002 wymaga tych samych cudzysłowów, a formater stosuje je w warunkach, takich jak {% if x == "a" %}, aby w jednym pliku ten sam ciąg znaków nie był zapisywany na dwa sposoby. Cudzysłowy atrybutów HTML pozostawia się regule H008.

quote_style="single"

require_pragma

od wersji 0.5.8 formatter linter --require-pragma

Domyślnie: false

Formatuje lub lintuje tylko pliki, które zaczynają się od komentarza djlint:on. Może to być komentarz HTML lub komentarz w języku szablonów ustawionym w profile, a bez profilu komentarz w dowolnym z nich.

<!-- djlint:on -->
{# djlint:on #}
{% comment %} djlint:on {% endcomment %}
{{ /* djlint:on */ }}
{{!-- djlint:on --}}
require_pragma=true

rules

od wersji 1.41.0 formatter linter --rules

Plik własnych reguł w formacie .djlint_rules.yaml, wczytywany zamiast pliku z katalogu głównego projektu.

Okno terminala
--rules ../shared/.djlint_rules.yaml

sarif

od wersji 1.46.0 formatter linter --sarif

Domyślnie: false

Wypisuje zgłoszenia jako dokument SARIF 2.1.0 dla skanowania kodu w GitHub i innych narzędzi. Zobacz GitHub Actions.

Okno terminala
--sarif

single_attribute_per_line

od wersji 1.40.0 formatter --single-attribute-per-line

Domyślnie: false

Gdy tag otwierający jest zawijany, umieszcza nazwę tagu, każdy atrybut i nawias zamykający w osobnych wierszach.

single_attribute_per_line=true

sort_attributes

od wersji 1.45.0 formatter --sort-attributes

Domyślnie: false

Sortuje atrybuty według nazwy, z id na pierwszym i class na drugim miejscu. Tag, którego atrybuty są objęte tagiem szablonu, zachowuje kolejność, w jakiej go zapisano, ponieważ przeniesienie atrybutu poza jego gałąź zmieniłoby stronę.

sort_attributes=true

sort_load_tags

od wersji 1.47.0 formatter --sort-load-tags

Domyślnie: false

Sortuje biblioteki w tagach {% load %} i usuwa te zapisane dwukrotnie, więc {% load static i18n %} staje się {% load i18n static %}. W {% load a b from library %} sortowane są nazwy przed from. Gdy dwie biblioteki definiują tag lub filtr o tej samej nazwie, wygrywa ta wczytana jako ostatnia, więc sortowanie może zmienić to, którego z nich używa szablon.

sort_load_tags=true

statistics

od wersji 1.16.0 linter --statistics

Domyślnie: false

Po lintowaniu wypisuje, ile razy znaleziono każdy kod.

Okno terminala
--statistics

stdin_filename

od wersji 1.43.0 formatter linter --stdin-filename

Domyślnie: "-"

Ścieżka, która oznacza stdin w komunikatach i przy dopasowywaniu exclude oraz per-file-ignores.

Okno terminala
--stdin-filename templates/index.html

use_gitignore

od wersji 0.5.9 linter formatter --use-gitignore

Domyślnie: false

Pomija także ścieżki wymienione w .gitignore w katalogu głównym projektu.

use_gitignore=true

version

od wersji 0.3.9 formatter linter --version

Wyświetla wersję i kończy działanie.

Okno terminala
--version

warn

od wersji 0.7.6 formatter linter --warn

Domyślnie: false

Kończy działanie z kodem 0 zamiast 1, gdy linter znajdzie błędy lub są pliki do przeformatowania.

Okno terminala
--warn