Yapılandırma
Yapılandırma projenizin pyproject.toml dosyasına, bir djlint.toml ya da .djlint.toml dosyasına veya bir .djlintrc dosyasına yazılır. Komut satırı seçenekleri yapılandırma dosyasını geçersiz kılar, ama bir bayrak bir seçeneği yalnızca açabilir, yani yapılandırma dosyasının açtığı bir anahtarı kapatamaz. --prefer-configuration ayarlanmadıkça projenin ayarları, --configuration ile verilen genel bir yapılandırma dosyasını geçersiz kılar.
djLint bu dosyaları denetlediği ilk yoldan (- için --stdin-filename klasöründen, bu seçenek yoksa geçerli dizinden) yukarı doğru arar. djlint.toml, .djlint.toml, .djlintrc, .djlint_rules.yaml ya da [tool.djlint] içeren bir pyproject.toml bulunan ilk klasörde durur ve bir deponun kökünü (.git klasörü ya da dosyası veya .hg klasörü olan klasörü) hiçbir zaman aşmaz. djLint ayarı olmayan bir pyproject.toml aramayı durdurmaz, bu yüzden bir monorepoda kendi pyproject.toml dosyası olan bir paket deponun ayarlarını alır. djLint yalnızca durduğu klasörü okur: pyproject.toml dosyasındaki [tool.djlint] (içinde bir ayar varsa), yoksa djlint.toml ya da .djlint.toml, o da yoksa .djlintrc; orada olup okumadığı dosyalar için de uyarır.
Komut satırı da yapılandırma da indent ya da max_line_length ayarlamıyorsa djLint, düzenleyicilerin yaptığı gibi indent_size ya da max_line_length değerini .editorconfig dosyalarından alır: her dosya bu değerleri kendi yoluna göre alır, en yakın .editorconfig kazanır ve üsttekiler eksikleri tamamlar; arama root = true içeren bir dosyada ya da proje kökünde biter.
pyproject.toml dosyası toml biçimindedir.
[tool.djlint]profile = "django"ignore = ["H014", "H015"]djlint.toml ve .djlint.toml dosyaları toml biçimindedir.
profile = "django"ignore = ["H014", "H015"].djlintrc dosyası json biçimindedir.
{ "profile": "django", "ignore": ["H014", "H015"] }ignore gibi birden çok değer alan seçenekler bir liste alır. "H014,H015" gibi virgülle ayrılmış bir metin de çalışır ve 1.41’den önceki djLint yalnızca bunu okur.
djLint 1.51 sürümünden itibaren tanımadığı bir ayar ya da kural kodu için uyarır ve en yakın bildiğini söyler.
Seçenekler
Bölüm başlığı “Seçenekler”Hiçbir şey bulunamadı. Başka bir arama deneyin.
allow_empty_input
Varsayılan: false
Verilen yollar hiçbir dosyayla eşleşmediğinde 2 yerine 0 ile çıkar. Dosyalar bulunup ardından exclude, extend_exclude, use_gitignore ya da require_pragma ile atlandıysa çıkış kodu zaten 0 olur.
allow_empty_input=trueallow_empty_input=true"allow_empty_input": true--allow-empty-inputblank_line_after_tag
Varsayılan: yok
Ardından boş satır gelecek şablon etiketleri, örneğin load ve extends. Art arda gelen bu etiketlerden oluşan bir grup, sonuncusundan sonra tek bir boş satır alır; bir bloğun sonuna boş satır eklenmez.
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
Varsayılan: yok
Öncesine boş satır gelecek şablon etiketleri, örneğin load ve extends. Art arda gelen bu etiketlerden oluşan bir grup, ilkinden önce tek bir boş satır alır; bir dosyanın ya da bloğun başına boş satır eklenmez.
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
Varsayılan: false
Bilinen void etiketleri eğik çizgiyle kapatır; böylece <img>, <img /> olur. Bunun tersini isteyen H018 bu seçenekle bildirilmez.
close_void_tags=trueclose_void_tags=true"close_void_tags": true--close-void-tagsconfiguration
Genel bir yapılandırma dosyası (pyproject.toml, djlint.toml ya da .djlintrc), örneğin ana klasörünüzdeki bir dosya. İkisi aynı seçeneği ayarladığında prefer_configuration açık değilse projenin kendi yapılandırma dosyası kazanır.
--configuration ~/.djlintrccustom_blocks
Varsayılan: yok
Girintilenecek özel şablon bloklarının adları, örneğin {% toc %}...{% endtoc %} için toc.
custom_blocks=["toc", "example"]custom_blocks=["toc", "example"]"custom_blocks": ["toc", "example"]--custom-blocks "toc,example"custom_html
Varsayılan: yok
Girintilenecek özel HTML etiketlerinin adları, örneğin mjml ya da simple-greeting. Bir ad, mj-\w+ gibi bir düzenli ifade olabilir.
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
Varsayılan: "__pypackages__,
Varsayılan listenin yerine atlanacak yollar. Her girdi, proje köküne veya denetlenen klasöre göre yoldaki klasör ya da dosya adlarının tamamıyla eşleştirilen bir düzenli ifadedir, örneğin vendor ya da templates/legacy; bu yüzden *.min.html, .*\.min\.html olarak yazılır.
exclude=[".venv", "venv", "build"]exclude=[".venv", "venv", "build"]"exclude": [".venv", "venv", "build"]--exclude ".venv,venv,build"extend_exclude
Varsayılan: yok
exclude listesine ya da exclude ayarlanmamışsa varsayılan listeye ek olarak atlanacak yollar; exclude seçeneğindekiler gibi düzenli ifadelerle yazılır.
extend_exclude=[".custom"]extend_exclude=[".custom"]"extend_exclude": [".custom"]--extend-exclude ".custom"extension
Varsayılan: "html"
Klasörlerde aranacak dosyaların uzantısı. Tek bir uzantı alır; adıyla verilen bir dosya, uzantısı ne olursa olsun denetlenir.
extension="html.dj"extension="html.dj""extension": "html.dj"--extension "html.dj"# or-e "html.dj"files
Varsayılan: yok
Komut satırındakilerin yerine denetlenecek yollar; bu durumda komut satırındaki kaynak, stdin kullanılıyormuş gibi - olmalıdır. --stdin-filename ile - her durumda stdin anlamına gelir.
[tool.djlint]files=["index.html"]files=["index.html"]"files": [ "index.html"]index.htmlformat_attribute_js_json
Varsayılan: false
onclick ve x-data gibi özniteliklerdeki, yani format_attribute_js_json_pattern ile belirtilenlerdeki JavaScript ve JSON’u da biçimlendirir. format_attribute_js_json_min_props değerinden daha az özelliğe sahip bir nesne tek satırda kalır.
format_attribute_js_json=trueformat_attribute_js_json=true"format_attribute_js_json": true--format-attribute-js-jsonformat_attribute_js_json_min_props
Varsayılan: 2
Bir nesneyi yalnızca en az bu kadar özelliği varsa biçimlendirir. Daha az özelliği olan bir nesne tek satırda kalır.
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
Varsayılan: "^(?:on[a-z]+|
JavaScript ya da JSON olarak biçimlendirilecek özniteliklerin adları için regex. Varsayılan değer on* olay işleyicilerini ve Alpine, Vue, Angular ile Aurelia bağlamalarını kapsar.
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
Varsayılan: false
Etiket özniteliklerinin içindeki şablon sözdizimini biçimlendirir.
format_attribute_template_tags=trueformat_attribute_template_tags=true"format_attribute_template_tags": true--format-attribute-template-tagsformat_css
Varsayılan: false
<style> etiketlerinin içeriğini de css-beautify ile biçimlendirir. Bunların içindeki şablon sözdizimi tam olarak desteklenmez.
<style> etiketlerinin içindeki girintiyi css tablosundaki indent_size ya da komut satırındaki --indent-css belirler; varsayılan değer 4’tür. Tablo diğer css-beautify seçeneklerini de kabul eder.
[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
Varsayılan: false
<script> etiketlerindeki JavaScript ve JSON’u da js-beautify ile biçimlendirir. type değeri JavaScript ya da JSON olmayan bir betik, örneğin text/template içindeki istemci tarafı bir şablon, olduğu gibi bırakılır. Bunların içindeki şablon sözdizimi tam olarak desteklenmez.
<script> etiketlerinin içindeki girintiyi js tablosundaki indent_size ya da komut satırındaki --indent-js belirler; varsayılan değer 4’tür. Tablo diğer js-beautify seçeneklerini de kabul eder.
[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
Varsayılan: yok
Sonuçları GitHub Actions ek açıklamaları olarak yazdırır. GitHub Actions içinde varsayılan olarak açıktır, --no-github-output onu kapatır. Bkz. GitHub Actions.
--github-outputignore
Varsayılan: yok
Atlanacak linter kodları.
ignore=["H014", "H015"]ignore=["H014", "H015"]"ignore": ["H014", "H015"]--ignore "H014,H015"ignore_blocks
Varsayılan: yok
İçeriğini girintilemeyen şablon blokları. Alt öğeleri bloğun kardeşi olarak ele alınır ve buna göre girintilenir.
ignore_blocks=["raw", "example"]ignore_blocks=["raw", "example"]"ignore_blocks": ["raw", "example"]--ignore-blocks "raw,example"ignore_case
Varsayılan: false
Bilinen HTML etiketlerinin büyük/küçük harf yazımını düzeltmez. Bu seçenekle H009 ve H010 bildirilmez.
[tool.djlint]ignore_case=trueignore_case=true"ignore_case": true--ignore-caseinclude
Varsayılan: yok
Açılacak linter kodları; varsayılan olarak kapalı olanlar ve profilin dışarıda bıraktıkları da buna dahildir.
include=["H014", "H015"]include=["H014", "H015"]"include": ["H014", "H015"]--include "H014,H015"indent
Varsayılan: 4
Girinti düzeyi başına boşluk sayısı. Ayarlanmadığında djLint, varsa .editorconfig dosyasının o dosya için verdiği indent_size değerini kullanır.
indent=3indent=3"indent": 3--indent 3keep_br_inline
Varsayılan: false
<br> etiketine kendi satırını vermek yerine onu böldüğü metnin satırında tutar. Önceki içeriğin altında bir çizgi olarak görüntülenen <hr> bundan etkilenmez.
keep_br_inline=truekeep_br_inline=true"keep_br_inline": true--keep-br-inlineline_break_after_multiline_tag
Varsayılan: false
Bir etiketin öznitelikleri birden çok satıra yayıldığında içeriğini yeni bir satırda başlatır.
line_break_after_multiline_tag=trueline_break_after_multiline_tag=true"line_break_after_multiline_tag": true--line-break-after-multiline-taglinter_output_format
Varsayılan: "{code} {line} {message} {match}"
Her lint mesajının düzeni; {filename}, {line}, {end}, {code}, {message} ve {match} ile oluşturulur. {filename} yoksa çıktı dosyaya göre gruplanır ve her grup bir başlık alır.
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
Varsayılan: 70
Bir etiketin öznitelikleri bu uzunluğu aştığında biçimlendirici onları birden çok satıra dağıtır.
max_attribute_length=10max_attribute_length=10"max_attribute_length": 10--max-attribute-length 10max_blank_lines
Varsayılan: 0
Art arda en fazla bu kadar boş satır bırakır; 0 değeri boş satırları kaldırır. preserve_blank_lines açıkken bu seçeneğin etkisi olmaz.
max_blank_lines=5max_blank_lines=5"max_blank_lines": 5--max-blank-lines 5max_line_length
Varsayılan: 120
Biçimlendirici bazı HTML ve şablon etiketlerini yalnızca satır bu uzunluğa sığıyorsa tek satırda birleştirir. Ayarlanmadığında djLint, varsa .editorconfig dosyasının o dosya için verdiği max_line_length değerini kullanır.
max_line_length=100max_line_length=100"max_line_length": 100--max-line-length 100name_endblocks
Varsayılan: false
Blok birden çok satıra yayılarak yazılmışsa bloğun adını onu kapatan {% endblock %} etiketine yazar. T003 kuralının istediği de budur.
name_endblocks=truename_endblocks=true"name_endblocks": true--name-endblocksno_entity_formatting
Varsayılan: false
Bir varlık başvurusunu adlandırdığı karakter olarak yeniden yazmaz; böylece ©, © olmak yerine yazıldığı gibi bırakılır. Sözdizimi taşıyan varlıklar ve görünmez olanlar her iki durumda da hiçbir zaman yeniden yazılmaz. Bu seçenekle H023 bir varlığı yine de bildirir; varlıkları korumak için ignore listesine H023 ekleyin.
no_entity_formatting=trueno_entity_formatting=true"no_entity_formatting": true--no-entity-formattingno_function_formatting
Varsayılan: false
{{ }} içindeki işlev çağrılarının argümanlarını biçimlendirmez.
no_function_formatting=trueno_function_formatting=true"no_function_formatting": true--no-function-formattingno_indent_inner_html
Varsayılan: false
<html> içindeki <head> ve <body> öğelerini girintilemez; VS Code’un yerleşik HTML biçimlendiricisi de bir belgeyi bu şekilde düzenler.
no_indent_inner_html=trueno_indent_inner_html=true"no_indent_inner_html": true--no-indent-inner-htmlno_line_after_yaml
Varsayılan: false
YAML ön bilgisinden (front matter) sonra boş satır eklemez.
no_line_after_yaml=trueno_line_after_yaml=true"no_line_after_yaml": true--no-line-after-yamlno_set_formatting
Varsayılan: false
{% set %} etiketlerinin içeriğini biçimlendirmez.
no_set_formatting=trueno_set_formatting=true"no_set_formatting": true--no-set-formattingper_file_ignores
Varsayılan: yok
Yolu bir regex ile eşleşen dosyalarda atlanacak linter kodları. Yapılandırma dosyasında anahtar tireli olarak per-file-ignores yazılır.
[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
Varsayılan: false
--configuration ile belirtilen dosyanın projenin kendi yapılandırma dosyasını geçersiz kılmasını sağlar; ikisi aynı seçeneği ayarladığında varsayılan olarak projenin dosyası kazanır. Yapılandırma dosyalarının nasıl okunacağını belirlediği için yalnızca komut satırında kullanılabilir.
--prefer-configurationpreserve_blank_lines
Varsayılan: false
Mümkün olduğunda boş satırları korur. Boş satırların bilinçli olduğu, HTML dışındaki şablonlar için kullanışlıdır.
preserve_blank_lines=truepreserve_blank_lines=true"preserve_blank_lines": true--preserve-blank-linespreserve_class_newlines
Varsayılan: false
Birden çok satıra yayılarak yazılmış class özniteliklerindeki satır sonlarını korur.
preserve_class_newlines=truepreserve_class_newlines=true"preserve_class_newlines": true--preserve-class-newlinespreserve_leading_space
Varsayılan: false
Mümkün olduğunda metin satırlarının başındaki boşlukları korur. Metin girintisinin bilinçli olduğu, HTML dışındaki şablonlar için kullanışlıdır.
preserve_leading_space=truepreserve_leading_space=true"preserve_leading_space": true--preserve-leading-spaceprofile
Varsayılan: yok
Şablon dili. Hangi linter kurallarının çalışacağını ve şablon sözdiziminin nasıl biçimlendirileceğini belirler: örneğin handlebars profilinde {{#if}} etiketlerinin içinde boşluk bulunmaz.
Profil ayarlanmadığında djLint, all gibi tüm şablon dillerinin söz dizimini biçimlendirir, linter ise html kurallarını kullanır.
Seçenekler:
- html
- django
- jinja
- nunjucks (nunjucks ve twig için)
- handlebars (handlebars ve mustache için)
- liquid (shopify, jekyll, eleventy)
- golang (go şablonları; hugo, helm)
- angular
- tera (zola için de; minijinja için jinja kullanın)
- askama (rust’ta jinja tarzı şablonlar; rust ifadeleri hiçbir zaman yeniden biçimlendirilmez)
- mako (kontrol satırları ve
##yorumları olduğu gibi kalır) - all (tüm şablon dilleri bir arada)
profile="django"profile="django""profile": "django"--profile "django"quiet
Varsayılan: false
Diff’leri, ilerleme çubuğunu ve özeti yazdırmaz.
quiet=truequiet=true"quiet": true--quietquote_style
Varsayılan: "double"
Şablon etiketlerinin içindeki dizeler için tırnaklar: double ya da single. T002 aynı tırnakları ister ve biçimlendirici bunları {% if x == "a" %} gibi koşullarda da kullanır; böylece bir dosyada aynı dize iki farklı şekilde yazılmaz. HTML özniteliklerinin tırnakları H008 kuralına bırakılır.
quote_style="single"quote_style="single""quote_style": "single"--quote-style singlerequire_pragma
Varsayılan: false
Yalnızca djlint:on yorumuyla başlayan dosyaları biçimlendirir ya da denetler. Yorum, bir HTML yorumu ya da profile ile belirtilen şablon dilinde bir yorum olabilir; profil yoksa şablon dillerinden herhangi birinde olabilir.
<!-- djlint:on -->{# djlint:on #}{% comment %} djlint:on {% endcomment %}{{ /* djlint:on */ }}{{!-- djlint:on --}}require_pragma=truerequire_pragma=true"require_pragma": true--require-pragmarules
Proje kökündeki dosyanın yerine okunan, .djlint_rules.yaml biçiminde bir özel kural dosyası.
--rules ../shared/.djlint_rules.yamlsarif
Varsayılan: false
Bulguları GitHub code scanning ve diğer araçlar için bir SARIF 2.1.0 belgesi olarak yazdırır. Bkz. GitHub Actions.
--sarifsingle_attribute_per_line
Varsayılan: false
Bir açılış etiketi sarıldığında etiket adını, her özniteliği ve kapanış ayracını ayrı satırlara yerleştirir.
single_attribute_per_line=truesingle_attribute_per_line=true"single_attribute_per_line": true--single-attribute-per-linesort_attributes
Varsayılan: false
Öznitelikleri ada göre sıralar; id birinci, class ikinci sıraya gelir. Öznitelikleri bir şablon etiketiyle koşula bağlanmış bir etiket yazıldığı sırada kalır, çünkü bir özniteliği dalının dışına taşımak sayfayı değiştirir.
sort_attributes=truesort_attributes=true"sort_attributes": true--sort-attributessort_load_tags
Varsayılan: false
{% load %} etiketlerindeki kütüphaneleri sıralar ve iki kez yazılanları kaldırır; böylece {% load static i18n %}, {% load i18n static %} olur. {% load a b from library %} içinde from öncesindeki adlar sıralanır. İki kütüphane aynı adla bir etiket ya da filtre tanımladığında son yüklenen kazanır; bu yüzden sıralama, şablonun hangisini kullandığını değiştirebilir.
sort_load_tags=truesort_load_tags=true"sort_load_tags": true--sort-load-tagsstatistics
Varsayılan: false
Lint denetiminden sonra her kodun kaç kez bulunduğunu yazdırır.
--statisticsstdin_filename
Varsayılan: "-"
Mesajlarda ve exclude ile per-file-ignores eşleştirilirken stdin’i temsil eden yol.
--stdin-filename templates/index.htmluse_gitignore
Varsayılan: false
Proje kökündeki .gitignore dosyasında listelenen yolları da atlar.
use_gitignore=trueuse_gitignore=true"use_gitignore": true--use-gitignoreversion
Sürümü gösterir ve çıkar.
--versionwarn
Varsayılan: false
Linter hata bulduğunda ya da yeniden biçimlendirilecek dosyalar olduğunda 1 yerine 0 ile çıkar.
--warn