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.
Nic nie znaleziono. Spróbuj wyszukać coś innego.
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=trueallow_empty_input=true"allow_empty_input": true--allow-empty-inputblank_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_after_tag=["load", "extends", "include"]"blank_line_after_tag": ["load", "extends", "include"]--blank-line-after-tag "load,extends,include"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"]blank_line_before_tag=["load", "extends", "include"]"blank_line_before_tag": ["load", "extends", "include"]--blank-line-before-tag "load,extends,include"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=trueclose_void_tags=true"close_void_tags": true--close-void-tagsconfiguration
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.
--configuration ~/.djlintrccustom_blocks
Domyślnie: brak
Nazwy własnych bloków szablonu do wcinania, na przykład toc dla {% toc %}...{% endtoc %}.
custom_blocks=["toc", "example"]custom_blocks=["toc", "example"]"custom_blocks": ["toc", "example"]--custom-blocks "toc,example"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+']custom_html=["mjml", "simple-greeting", 'mj-\w+']"custom_html": ["mjml", "simple-greeting", "mj-\\w+"]--custom-html "mjml,simple-greeting,mj-\w+"exclude
Domyślnie: "__pypackages__,
Ś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"]exclude=[".venv", "venv", "build"]"exclude": [".venv", "venv", "build"]--exclude ".venv,venv,build"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"]extend_exclude=[".custom"]"extend_exclude": [".custom"]--extend-exclude ".custom"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"extension="html.dj""extension": "html.dj"--extension "html.dj"# or-e "html.dj"files
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"]files=["index.html"]"files": [ "index.html"]index.htmlformat_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=trueformat_attribute_js_json=true"format_attribute_js_json": true--format-attribute-js-jsonformat_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=3format_attribute_js_json_min_props=3"format_attribute_js_json_min_props": 3--format-attribute-js-json-min-props 3format_attribute_js_json_pattern
Domyślnie: "^(?:on[a-z]+|
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_js_json_pattern="^(on[a-z]+|data-[a-z-]+|x-[a-z-]+)$""format_attribute_js_json_pattern": "^(on[a-z]+|data-[a-z-]+|x-[a-z-]+)$"--format-attribute-js-json-pattern "^(on[a-z]+|data-[a-z-]+|x-[a-z-]+)$"format_attribute_template_tags
Domyślnie: false
Formatuje składnię szablonu wewnątrz atrybutów tagów.
format_attribute_template_tags=trueformat_attribute_template_tags=true"format_attribute_template_tags": true--format-attribute-template-tagsformat_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=5format_css=true
[css]indent_size=5"format_css": true,"css": { "indent_size": 5 }--format-css --indent-css 5format_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=5format_js=true
[js]indent_size=5"format_js": true,"js": { "indent_size": 5 }--format-js --indent-js 5github_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.
--github-outputignore
Domyślnie: brak
Kody lintera do pominięcia.
ignore=["H014", "H015"]ignore=["H014", "H015"]"ignore": ["H014", "H015"]--ignore "H014,H015"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_blocks=["raw", "example"]"ignore_blocks": ["raw", "example"]--ignore-blocks "raw,example"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=trueignore_case=true"ignore_case": true--ignore-caseinclude
Domyślnie: brak
Kody lintera do włączenia, także domyślnie wyłączone lub pominięte przez profil.
include=["H014", "H015"]include=["H014", "H015"]"include": ["H014", "H015"]--include "H014,H015"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=3indent=3"indent": 3--indent 3keep_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=truekeep_br_inline=true"keep_br_inline": true--keep-br-inlineline_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=trueline_break_after_multiline_tag=true"line_break_after_multiline_tag": true--line-break-after-multiline-taglinter_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}"linter_output_format="{filename}:{line}: {code} {message} {match}""linter_output_format": "{filename}:{line}: {code} {message} {match}"--linter-output-format "{filename}:{line}: {code} {message} {match}"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=10max_attribute_length=10"max_attribute_length": 10--max-attribute-length 10max_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=5max_blank_lines=5"max_blank_lines": 5--max-blank-lines 5max_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=100max_line_length=100"max_line_length": 100--max-line-length 100name_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=truename_endblocks=true"name_endblocks": true--name-endblocksno_entity_formatting
Domyślnie: false
Nie zamienia odwołania do encji na znak, który ono oznacza, więc © 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=trueno_entity_formatting=true"no_entity_formatting": true--no-entity-formattingno_function_formatting
Domyślnie: false
Nie formatuje argumentów wywołań funkcji wewnątrz {{ }}.
no_function_formatting=trueno_function_formatting=true"no_function_formatting": true--no-function-formattingno_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=trueno_indent_inner_html=true"no_indent_inner_html": true--no-indent-inner-htmlno_line_after_yaml
Domyślnie: false
Nie dodaje pustego wiersza po front matter w YAML.
no_line_after_yaml=trueno_line_after_yaml=true"no_line_after_yaml": true--no-line-after-yamlno_set_formatting
Domyślnie: false
Nie formatuje zawartości tagów {% set %}.
no_set_formatting=trueno_set_formatting=true"no_set_formatting": true--no-set-formattingper_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"[per-file-ignores]"file.html"= "H026,H025""file_two.html"="H001""per-file-ignores": { "file.html": "H026,H025", "file_two.html":"H001" }--per-file-ignores "file.html" "H026,H025" --per-file-ignores "file_two.html" "H001"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.
--prefer-configurationpreserve_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=truepreserve_blank_lines=true"preserve_blank_lines": true--preserve-blank-linespreserve_class_newlines
Domyślnie: false
Zachowuje podziały wierszy w atrybutach class zapisanych w kilku wierszach.
preserve_class_newlines=truepreserve_class_newlines=true"preserve_class_newlines": true--preserve-class-newlinespreserve_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=truepreserve_leading_space=true"preserve_leading_space": true--preserve-leading-spaceprofile
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"profile="django""profile": "django"--profile "django"quiet
Domyślnie: false
Nie wypisuje diffów, paska postępu ani podsumowania.
quiet=truequiet=true"quiet": true--quietquote_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"quote_style="single""quote_style": "single"--quote-style singlerequire_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=truerequire_pragma=true"require_pragma": true--require-pragmarules
Plik własnych reguł w formacie .djlint_rules.yaml, wczytywany zamiast pliku z katalogu głównego projektu.
--rules ../shared/.djlint_rules.yamlsarif
Domyślnie: false
Wypisuje zgłoszenia jako dokument SARIF 2.1.0 dla skanowania kodu w GitHub i innych narzędzi. Zobacz GitHub Actions.
--sarifsingle_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=truesingle_attribute_per_line=true"single_attribute_per_line": true--single-attribute-per-linesort_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=truesort_attributes=true"sort_attributes": true--sort-attributessort_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=truesort_load_tags=true"sort_load_tags": true--sort-load-tagsstatistics
Domyślnie: false
Po lintowaniu wypisuje, ile razy znaleziono każdy kod.
--statisticsstdin_filename
Domyślnie: "-"
Ścieżka, która oznacza stdin w komunikatach i przy dopasowywaniu exclude oraz per-file-ignores.
--stdin-filename templates/index.htmluse_gitignore
Domyślnie: false
Pomija także ścieżki wymienione w .gitignore w katalogu głównym projektu.
use_gitignore=trueuse_gitignore=true"use_gitignore": true--use-gitignoreversion
Wyświetla wersję i kończy działanie.
--versionwarn
Domyślnie: false
Kończy działanie z kodem 0 zamiast 1, gdy linter znajdzie błędy lub są pliki do przeformatowania.
--warn