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é.
Možnosti
Sekce “Možnosti”Nic nenalezeno. Zkuste hledat jinak.
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=trueallow_empty_input=true"allow_empty_input": true--allow-empty-inputblank_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_after_tag=["load", "extends", "include"]"blank_line_after_tag": ["load", "extends", "include"]--blank-line-after-tag "load,extends,include"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"]blank_line_before_tag=["load", "extends", "include"]"blank_line_before_tag": ["load", "extends", "include"]--blank-line-before-tag "load,extends,include"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=trueclose_void_tags=true"close_void_tags": true--close-void-tagsconfiguration
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.
--configuration ~/.djlintrccustom_blocks
Výchozí: žádná
Názvy vlastních šablonových bloků k odsazení, například toc pro {% toc %}...{% endtoc %}.
custom_blocks=["toc", "example"]custom_blocks=["toc", "example"]"custom_blocks": ["toc", "example"]--custom-blocks "toc,example"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+']custom_html=["mjml", "simple-greeting", 'mj-\w+']"custom_html": ["mjml", "simple-greeting", "mj-\\w+"]--custom-html "mjml,simple-greeting,mj-\w+"exclude
Výchozí: "__pypackages__,
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"]exclude=[".venv", "venv", "build"]"exclude": [".venv", "venv", "build"]--exclude ".venv,venv,build"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"]extend_exclude=[".custom"]"extend_exclude": [".custom"]--extend-exclude ".custom"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"extension="html.dj""extension": "html.dj"--extension "html.dj"# or-e "html.dj"files
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"]files=["index.html"]"files": [ "index.html"]index.htmlformat_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=trueformat_attribute_js_json=true"format_attribute_js_json": true--format-attribute-js-jsonformat_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=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
Výchozí: "^(?:on[a-z]+|
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_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
Výchozí: false
Formátovat šablonovou syntaxi uvnitř atributů značek.
format_attribute_template_tags=trueformat_attribute_template_tags=true"format_attribute_template_tags": true--format-attribute-template-tagsformat_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=5format_css=true
[css]indent_size=5"format_css": true,"css": { "indent_size": 5 }--format-css --indent-css 5format_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=5format_js=true
[js]indent_size=5"format_js": true,"js": { "indent_size": 5 }--format-js --indent-js 5github_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.
--github-outputignore
Výchozí: žádná
Kódy linteru, které se přeskočí.
ignore=["H014", "H015"]ignore=["H014", "H015"]"ignore": ["H014", "H015"]--ignore "H014,H015"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_blocks=["raw", "example"]"ignore_blocks": ["raw", "example"]--ignore-blocks "raw,example"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=trueignore_case=true"ignore_case": true--ignore-caseinclude
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"]include=["H014", "H015"]"include": ["H014", "H015"]--include "H014,H015"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=3indent=3"indent": 3--indent 3keep_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=truekeep_br_inline=true"keep_br_inline": true--keep-br-inlineline_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=trueline_break_after_multiline_tag=true"line_break_after_multiline_tag": true--line-break-after-multiline-taglinter_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}"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
Výchozí: 70
Když jsou atributy značky delší než tato hodnota, formátovač je rozloží na více řádků.
max_attribute_length=10max_attribute_length=10"max_attribute_length": 10--max-attribute-length 10max_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=5max_blank_lines=5"max_blank_lines": 5--max-blank-lines 5max_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=100max_line_length=100"max_line_length": 100--max-line-length 100name_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=truename_endblocks=true"name_endblocks": true--name-endblocksno_entity_formatting
Výchozí: false
Nepřepisovat znakovou entitu na znak, který označuje, takže © 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=trueno_entity_formatting=true"no_entity_formatting": true--no-entity-formattingno_function_formatting
Výchozí: false
Neformátovat argumenty volání funkcí uvnitř {{ }}.
no_function_formatting=trueno_function_formatting=true"no_function_formatting": true--no-function-formattingno_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=trueno_indent_inner_html=true"no_indent_inner_html": true--no-indent-inner-htmlno_line_after_yaml
Výchozí: false
Nepřidávat za YAML front matter prázdný řádek.
no_line_after_yaml=trueno_line_after_yaml=true"no_line_after_yaml": true--no-line-after-yamlno_set_formatting
Výchozí: false
Neformátovat obsah značek {% set %}.
no_set_formatting=trueno_set_formatting=true"no_set_formatting": true--no-set-formattingper_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"[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
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.
--prefer-configurationpreserve_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=truepreserve_blank_lines=true"preserve_blank_lines": true--preserve-blank-linespreserve_class_newlines
Výchozí: false
Zachovat zalomení řádků v atributech class zapsaných přes více řádků.
preserve_class_newlines=truepreserve_class_newlines=true"preserve_class_newlines": true--preserve-class-newlinespreserve_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=truepreserve_leading_space=true"preserve_leading_space": true--preserve-leading-spaceprofile
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"profile="django""profile": "django"--profile "django"quiet
Výchozí: false
Nevypisovat diffy, ukazatel průběhu ani souhrn.
quiet=truequiet=true"quiet": true--quietquote_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"quote_style="single""quote_style": "single"--quote-style singlerequire_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=truerequire_pragma=true"require_pragma": true--require-pragmarules
Soubor vlastních pravidel ve formátu .djlint_rules.yaml, který se čte místo souboru v kořeni projektu.
--rules ../shared/.djlint_rules.yamlsarif
Výchozí: false
Vypsat nálezy jako dokument SARIF 2.1.0 pro code scanning na GitHubu a další nástroje. Viz GitHub Actions.
--sarifsingle_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=truesingle_attribute_per_line=true"single_attribute_per_line": true--single-attribute-per-linesort_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=truesort_attributes=true"sort_attributes": true--sort-attributessort_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=truesort_load_tags=true"sort_load_tags": true--sort-load-tagsstatistics
Výchozí: false
Po lintování vypsat, kolikrát se který kód našel.
--statisticsstdin_filename
Výchozí: "-"
Cesta, která zastupuje stdin ve zprávách a při porovnání s exclude a per-file-ignores.
--stdin-filename templates/index.htmluse_gitignore
Výchozí: false
Přeskočit také cesty, které uvádí .gitignore v kořeni projektu.
use_gitignore=trueuse_gitignore=true"use_gitignore": true--use-gitignoreversion
Zobrazit verzi a skončit.
--versionwarn
Výchozí: false
Skončit s kódem 0 místo 1, když linter najde chyby nebo jsou soubory k přeformátování.
--warn