Přeskočit na obsah

Konfigurace

Konfigurace se zapisuje do souboru pyproject.toml vašeho projektu, do djlint.toml nebo .djlint.toml, nebo do .djlintrc. Možnosti příkazového řádku mají přednost před konfiguračním souborem, ale přepínač může možnost jen zapnout, takže nevypne volbu, kterou zapíná konfigurační soubor. Nastavení projektu má přednost před globálním konfiguračním souborem zadaným pomocí --configuration, pokud není nastaveno --prefer-configuration.

djLint tyto soubory hledá směrem nahoru od první cesty, kterou kontroluje (u - od složky --stdin-filename, bez něj od aktuálního adresáře). Zastaví se u první složky, která obsahuje soubor djlint.toml, .djlint.toml, .djlintrc, .djlint_rules.yaml nebo pyproject.toml s [tool.djlint], a nikdy nejde výš než kořen repozitáře (složka se složkou nebo souborem .git nebo se složkou .hg). Soubor pyproject.toml bez nastavení djLintu hledání nezastaví, takže balíček v monorepu s vlastním pyproject.toml dostane nastavení repozitáře. djLint čte jen složku, u které se zastavil: [tool.djlint] v jejím pyproject.toml, pokud tato tabulka něco nastavuje, jinak její djlint.toml nebo .djlint.toml, jinak její .djlintrc, a upozorní na soubory, které tam leží, ale nečte je.

Pokud příkazový řádek ani konfigurace nenastavují indent nebo max_line_length, djLint vezme indent_size nebo max_line_length ze souborů .editorconfig, stejně jako editory: každý soubor je dostane podle své vlastní cesty, nejbližší .editorconfig má přednost a ty výše doplní zbytek, až po soubor s root = true nebo kořen projektu.

Soubor pyproject.toml je ve formátu toml.

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

Soubory djlint.toml a .djlint.toml jsou ve formátu toml.

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

Soubor .djlintrc je ve formátu json.

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

Volby s více hodnotami, například ignore, berou seznam. Funguje i řetězec oddělený čárkami, například "H014,H015", který potřebuje djLint starší než 1.41.

Od verze 1.51 djLint upozorní na nastavení nebo kód pravidla, které nezná, a nabídne nejbližší známé.

allow_empty_input

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

Výchozí: false

Skončit s kódem 0 místo 2, když zadaným cestám neodpovídají vůbec žádné soubory. Soubory, které byly nalezeny a pak přeskočeny kvůli exclude, extend_exclude, use_gitignore nebo require_pragma, končí s kódem 0 už teď.

allow_empty_input=true

blank_line_after_tag

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

Výchozí: žádná

Šablonové značky, za které se přidá prázdný řádek, například load a extends. Skupina takových značek za sebou dostane jeden prázdný řádek za poslední z nich a na konec bloku se nepřidá žádný.

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

blank_line_before_tag

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

Výchozí: žádná

Šablonové značky, před které se přidá prázdný řádek, například load a extends. Skupina takových značek za sebou dostane jeden prázdný řádek před první z nich a na začátek souboru nebo bloku se nepřidá žádný.

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

close_void_tags

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

Výchozí: false

Uzavírat známé nepárové značky lomítkem, takže z <img> se stane <img />. H018, které požaduje opak, se s touto možností nehlásí.

close_void_tags=true

configuration

od verze 1.13.0 formatter linter --configuration

Globální konfigurační soubor, pyproject.toml, djlint.toml nebo .djlintrc, například ve vaší domovské složce. Vlastní konfigurační soubor projektu vyhrává tam, kde oba nastavují stejnou možnost, pokud není zapnuté prefer_configuration.

Terminál
--configuration ~/.djlintrc

custom_blocks

od verze 0.3.5 formatter --custom-blocks

Výchozí: žádná

Názvy vlastních šablonových bloků k odsazení, například toc pro {% toc %}...{% endtoc %}.

custom_blocks=["toc", "example"]

custom_html

od verze 0.7.0 formatter --custom-html

Výchozí: žádná

Názvy vlastních HTML značek k odsazení, například mjml nebo simple-greeting. Název může být regulární výraz, třeba mj-\w+.

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

exclude

od verze 0.4.0 linter formatter --exclude

Výchozí: "__pypackages__,_build,_site,.bzr,.direnv,.eggs,.git,.git-rewrite,.hg,.nox,.svn,.tox,.venv,build,dist,htmlcov,node_modules,site-packages,venv"

Cesty, které se přeskočí, místo výchozího seznamu. Každá položka je regulární výraz, který se porovnává s celými názvy složek nebo souborů v cestě relativní ke kořeni projektu nebo ke kontrolované složce, například vendor nebo templates/legacy, takže *.min.html se zapíše jako .*\.min\.html.

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

extend_exclude

od verze 0.4.0 linter formatter --extend-exclude

Výchozí: žádná

Cesty, které se přeskočí navíc k exclude, nebo k výchozímu seznamu, když exclude není nastaveno, jako regulární výrazy stejně jako u exclude.

extend_exclude=[".custom"]

extension

od verze 0.0.5 linter formatter --extension

Výchozí: "html"

Přípona souborů, které se hledají ve složkách. Bere jednu příponu; soubor zadaný názvem se zkontroluje bez ohledu na svou příponu.

extension="html.dj"

files

od verze 1.14.0 linter formatter

Výchozí: žádná

Cesty ke kontrole místo těch z příkazového řádku, kde pak musí být -, jako při použití stdin. S --stdin-filename znamená - v každém případě stdin.

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

format_attribute_js_json

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

Výchozí: false

Formátovat i JavaScript a JSON v atributech jako onclick a x-data, tedy v těch, které určuje format_attribute_js_json_pattern. Objekt s menším počtem vlastností, než určuje format_attribute_js_json_min_props, zůstane na jednom řádku.

format_attribute_js_json=true

format_attribute_js_json_min_props

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

Výchozí: 2

Formátovat objekt, jen když má alespoň tolik vlastností. Objekt s menším počtem vlastností zůstane na jednom řádku.

format_attribute_js_json_min_props=3

format_attribute_js_json_pattern

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

Výchozí: "^(?: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))$"

Regulární výraz pro názvy atributů, které se mají formátovat jako JavaScript nebo JSON. Výchozí vzor zachytí obsluhy událostí on* a vazby Alpine, Vue, Angularu a Aurelie.

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

format_attribute_template_tags

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

Výchozí: false

Formátovat šablonovou syntaxi uvnitř atributů značek.

format_attribute_template_tags=true

format_css

od verze 1.9.0 formatter --format-css

Výchozí: false

Formátovat pomocí css-beautify i obsah značek <style>. Šablonová syntaxe uvnitř nich není plně podporována.

Odsazení uvnitř značek <style> nastavuje indent_size v tabulce css nebo --indent-css na příkazovém řádku, výchozí hodnota je 4. Tabulka přijímá i další možnosti css-beautify.

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

format_js

od verze 1.9.0 formatter --format-js

Výchozí: false

Formátovat pomocí js-beautify i JavaScript a JSON ve značkách <script>. Skript, jehož type není JavaScript ani JSON, například šablona na straně klienta v text/template, zůstane beze změny. Šablonová syntaxe uvnitř nich není plně podporována.

Odsazení uvnitř značek <script> nastavuje indent_size v tabulce js nebo --indent-js na příkazovém řádku, výchozí hodnota je 4. Tabulka přijímá i další možnosti js-beautify.

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

github_output

od verze 1.37.0 formatter linter --github-output

Výchozí: žádná

Vypsat výsledky jako anotace GitHub Actions. Uvnitř GitHub Actions je to ve výchozím nastavení zapnuté a --no-github-output to vypne. Viz GitHub Actions.

Terminál
--github-output

ignore

od verze 0.1.5 linter --ignore

Výchozí: žádná

Kódy linteru, které se přeskočí.

ignore=["H014", "H015"]

ignore_blocks

od verze 1.24.0 formatter --ignore-blocks

Výchozí: žádná

Šablonové bloky, které neodsazují svůj obsah. Jejich potomci se považují za sourozence bloku a podle toho se odsadí.

ignore_blocks=["raw", "example"]

ignore_case

od verze 1.23.0 formatter linter --ignore-case

Výchozí: false

Neopravovat velikost písmen známých HTML značek. H009 a H010 se s touto možností nehlásí.

[tool.djlint]
ignore_case=true

include

od verze 1.20.0 linter --include

Výchozí: žádná

Kódy linteru, které se zapnou, i když jsou ve výchozím nastavení vypnuté nebo je profil vynechává.

include=["H014", "H015"]

indent

od verze 0.3.5 formatter --indent

Výchozí: 4

Počet mezer na úroveň odsazení. Když není nastaveno, djLint převezme indent_size, které souboru přiřazuje .editorconfig, pokud nějaké je.

indent=3

keep_br_inline

od verze 1.45.0 formatter --keep-br-inline

Výchozí: false

Ponechat <br> na řádku textu, který zalamuje, a nedávat mu vlastní řádek. Na <hr>, které se vykresluje jako čára pod předchozím obsahem, to nemá vliv.

keep_br_inline=true

line_break_after_multiline_tag

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

Výchozí: false

Když jsou atributy značky rozložené na více řádků, začít její obsah na novém řádku.

line_break_after_multiline_tag=true

linter_output_format

od verze 0.6.7 linter --linter-output-format

Výchozí: "{code} {line} {message} {match}"

Rozvržení každé zprávy linteru, sestavené z {filename}, {line}, {end}, {code}, {message} a {match}. Bez {filename} se výstup seskupí podle souborů a každá skupina dostane záhlaví.

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

max_attribute_length

od verze 0.5.8 formatter --max-attribute-length

Výchozí: 70

Když jsou atributy značky delší než tato hodnota, formátovač je rozloží na více řádků.

max_attribute_length=10

max_blank_lines

od verze 1.31.0 formatter --max-blank-lines

Výchozí: 0

Ponechat nejvýše tolik prázdných řádků za sebou, takže 0 je odstraní. S volbou preserve_blank_lines nemá žádný účinek.

max_blank_lines=5

max_line_length

od verze 0.5.7 formatter --max-line-length

Výchozí: 120

Formátovač spojí některé HTML a šablonové značky na jeden řádek, jen když se řádek vejde do této délky. Když není nastaveno, djLint převezme max_line_length, které souboru přiřazuje .editorconfig, pokud nějaké je.

max_line_length=100

name_endblocks

od verze 1.45.0 formatter --name-endblocks

Výchozí: false

Zapsat název bloku do {% endblock %}, který ho uzavírá, pokud je blok zapsaný přes více řádků. Právě to vyžaduje T003.

name_endblocks=true

no_entity_formatting

od verze 1.45.0 formatter --no-entity-formatting

Výchozí: false

Nepřepisovat znakovou entitu na znak, který označuje, takže &copy; zůstane tak, jak je zapsané, a nezmění se na ©. Entity, které nesou syntaxi, a neviditelné entity se nepřepisují v žádném případě. H023 entitu i s touto možností stále hlásí; chcete-li entity zachovat, přidejte H023 do ignore.

no_entity_formatting=true

no_function_formatting

od verze 1.30.2 formatter --no-function-formatting

Výchozí: false

Neformátovat argumenty volání funkcí uvnitř {{ }}.

no_function_formatting=true

no_indent_inner_html

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

Výchozí: false

Neodsazovat <head> a <body> uvnitř <html>, což odpovídá tomu, jak dokument rozvrhne integrovaný HTML formátovač VS Code.

no_indent_inner_html=true

no_line_after_yaml

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

Výchozí: false

Nepřidávat za YAML front matter prázdný řádek.

no_line_after_yaml=true

no_set_formatting

od verze 1.30.2 formatter --no-set-formatting

Výchozí: false

Neformátovat obsah značek {% set %}.

no_set_formatting=true

per_file_ignores

od verze 1.7.0 linter --per-file-ignores

Výchozí: žádná

Kódy linteru, které se přeskočí v souborech, jejichž cesta odpovídá regulárnímu výrazu. V konfiguračním souboru je klíč per-file-ignores, se spojovníky.

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

prefer_configuration

od verze 1.45.0 formatter linter --prefer-configuration

Výchozí: false

Umožnit souboru zadanému v --configuration přepsat vlastní konfigurační soubor projektu, který ve výchozím nastavení vyhrává tam, kde oba nastavují stejnou možnost. Jen pro příkazový řádek, protože rozhoduje o tom, jak se čtou samotné konfigurační soubory.

Terminál
--prefer-configuration

preserve_blank_lines

od verze 1.3.0 formatter --preserve-blank-lines

Výchozí: false

Zachovat prázdné řádky, kde je to možné. Užitečné pro šablony jiné než HTML, kde jsou prázdné řádky záměrné.

preserve_blank_lines=true

preserve_class_newlines

od verze 1.39.0 formatter --preserve-class-newlines

Výchozí: false

Zachovat zalomení řádků v atributech class zapsaných přes více řádků.

preserve_class_newlines=true

preserve_leading_space

od verze 1.2.0 formatter --preserve-leading-space

Výchozí: false

Zachovat úvodní mezery řádků textu, kde je to možné. Užitečné pro šablony jiné než HTML, kde je odsazení textu záměrné.

preserve_leading_space=true

profile

od verze 0.4.5 linter formatter --profile

Výchozí: žádná

Šablonovací jazyk. Určuje, která pravidla linteru se spustí a jak se formátuje šablonová syntaxe: například v handlebars nejsou uvnitř značek {{#if}} mezery.

Bez profilu djLint formátuje syntaxi všech šablonovacích jazyků jako all a linter používá pravidla html.

Možnosti:

  • html
  • django
  • jinja
  • nunjucks (pro nunjucks a twig)
  • handlebars (pro handlebars a mustache)
  • liquid (shopify, jekyll, eleventy)
  • golang (šablony go; hugo, helm)
  • angular
  • tera (také pro zola; pro minijinja použijte jinja)
  • askama (šablony ve stylu jinja v rustu; výrazy v rustu se nikdy nepřeformátovávají)
  • mako (řídicí řádky a komentáře ## zůstanou beze změny)
  • all (všechny šablonovací jazyky najednou)
profile="django"

quiet

od verze 0.0.9 formatter linter --quiet

Výchozí: false

Nevypisovat diffy, ukazatel průběhu ani souhrn.

quiet=true

quote_style

od verze 1.45.0 formatter linter --quote-style

Výchozí: "double"

Uvozovky pro řetězce uvnitř šablonových značek, buď double, nebo single. T002 vyžaduje tytéž uvozovky a formátovač je používá v podmínkách, například {% if x == "a" %}, aby jeden soubor nezapisoval stejný řetězec oběma způsoby. Uvozovky HTML atributů má na starosti H008.

quote_style="single"

require_pragma

od verze 0.5.8 formatter linter --require-pragma

Výchozí: false

Formátovat nebo lintovat jen soubory, které začínají komentářem djlint:on. Může to být HTML komentář nebo komentář v šablonovacím jazyce určeném nastavením profile, a bez profilu komentář v kterémkoli z nich.

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

rules

od verze 1.41.0 formatter linter --rules

Soubor vlastních pravidel ve formátu .djlint_rules.yaml, který se čte místo souboru v kořeni projektu.

Terminál
--rules ../shared/.djlint_rules.yaml

sarif

od verze 1.46.0 formatter linter --sarif

Výchozí: false

Vypsat nálezy jako dokument SARIF 2.1.0 pro code scanning na GitHubu a další nástroje. Viz GitHub Actions.

Terminál
--sarif

single_attribute_per_line

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

Výchozí: false

Když se otevírací značka zalamuje, umístit název značky, každý atribut i uzavírací závorku na samostatné řádky.

single_attribute_per_line=true

sort_attributes

od verze 1.45.0 formatter --sort-attributes

Výchozí: false

Seřadit atributy podle názvu, s id na prvním a class na druhém místě. Značka, jejíž atributy jsou podmíněné šablonovou značkou, si ponechá pořadí, ve kterém byla zapsána, protože přesunutí atributu z jeho větve by změnilo stránku.

sort_attributes=true

sort_load_tags

od verze 1.47.0 formatter --sort-load-tags

Výchozí: false

Seřadit knihovny ve značkách {% load %} a vypustit ty, které jsou zapsané dvakrát, takže z {% load static i18n %} se stane {% load i18n static %}. V {% load a b from library %} se seřadí názvy před from. Pokud dvě knihovny definují značku nebo filtr se stejným názvem, vyhrává ta načtená jako poslední, takže řazení může změnit, kterou z nich šablona použije.

sort_load_tags=true

statistics

od verze 1.16.0 linter --statistics

Výchozí: false

Po lintování vypsat, kolikrát se který kód našel.

Terminál
--statistics

stdin_filename

od verze 1.43.0 formatter linter --stdin-filename

Výchozí: "-"

Cesta, která zastupuje stdin ve zprávách a při porovnání s exclude a per-file-ignores.

Terminál
--stdin-filename templates/index.html

use_gitignore

od verze 0.5.9 linter formatter --use-gitignore

Výchozí: false

Přeskočit také cesty, které uvádí .gitignore v kořeni projektu.

use_gitignore=true

version

od verze 0.3.9 formatter linter --version

Zobrazit verzi a skončit.

Terminál
--version

warn

od verze 0.7.6 formatter linter --warn

Výchozí: false

Skončit s kódem 0 místo 1, když linter najde chyby nebo jsou soubory k přeformátování.

Terminál
--warn