İçeriğe geç

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.

allow_empty_input

eklendiği sürüm: 1.44.0 formatter linter --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=true

blank_line_after_tag

eklendiği sürüm: 0.4.2 formatter --blank-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_before_tag

eklendiği sürüm: 1.8.0 formatter --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"]

close_void_tags

eklendiği sürüm: 1.26.0 formatter linter --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=true

configuration

eklendiği sürüm: 1.13.0 formatter linter --configuration

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.

Terminal window
--configuration ~/.djlintrc

custom_blocks

eklendiği sürüm: 0.3.5 formatter --custom-blocks

Varsayılan: yok

Girintilenecek özel şablon bloklarının adları, örneğin {% toc %}...{% endtoc %} için toc.

custom_blocks=["toc", "example"]

custom_html

eklendiği sürüm: 0.7.0 formatter --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+']

exclude

eklendiği sürüm: 0.4.0 linter formatter --exclude

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

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"]

extend_exclude

eklendiği sürüm: 0.4.0 linter formatter --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"]

extension

eklendiği sürüm: 0.0.5 linter formatter --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"

files

eklendiği sürüm: 1.14.0 linter formatter

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"]

format_attribute_js_json

eklendiği sürüm: 1.37.0 formatter --format-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=true

format_attribute_js_json_min_props

eklendiği sürüm: 1.37.0 formatter --format-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=3

format_attribute_js_json_pattern

eklendiği sürüm: 1.37.0 formatter --format-attribute-js-json-pattern

Varsayılan: "^(?: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))$"

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_template_tags

eklendiği sürüm: 0.6.7 formatter --format-attribute-template-tags

Varsayılan: false

Etiket özniteliklerinin içindeki şablon sözdizimini biçimlendirir.

format_attribute_template_tags=true

format_css

eklendiği sürüm: 1.9.0 formatter --format-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=5

format_js

eklendiği sürüm: 1.9.0 formatter --format-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=5

github_output

eklendiği sürüm: 1.37.0 formatter linter --github-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.

Terminal window
--github-output

ignore

eklendiği sürüm: 0.1.5 linter --ignore

Varsayılan: yok

Atlanacak linter kodları.

ignore=["H014", "H015"]

ignore_blocks

eklendiği sürüm: 1.24.0 formatter --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_case

eklendiği sürüm: 1.23.0 formatter linter --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=true

include

eklendiği sürüm: 1.20.0 linter --include

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"]

indent

eklendiği sürüm: 0.3.5 formatter --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=3

keep_br_inline

eklendiği sürüm: 1.45.0 formatter --keep-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=true

line_break_after_multiline_tag

eklendiği sürüm: 1.27.0 formatter --line-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=true

linter_output_format

eklendiği sürüm: 0.6.7 linter --linter-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}"

max_attribute_length

eklendiği sürüm: 0.5.8 formatter --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=10

max_blank_lines

eklendiği sürüm: 1.31.0 formatter --max-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=5

max_line_length

eklendiği sürüm: 0.5.7 formatter --max-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=100

name_endblocks

eklendiği sürüm: 1.45.0 formatter --name-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=true

no_entity_formatting

eklendiği sürüm: 1.45.0 formatter --no-entity-formatting

Varsayılan: false

Bir varlık başvurusunu adlandırdığı karakter olarak yeniden yazmaz; böylece &copy;, © 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=true

no_function_formatting

eklendiği sürüm: 1.30.2 formatter --no-function-formatting

Varsayılan: false

{{ }} içindeki işlev çağrılarının argümanlarını biçimlendirmez.

no_function_formatting=true

no_indent_inner_html

eklendiği sürüm: 1.45.0 formatter --no-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=true

no_line_after_yaml

eklendiği sürüm: 1.29.0 formatter --no-line-after-yaml

Varsayılan: false

YAML ön bilgisinden (front matter) sonra boş satır eklemez.

no_line_after_yaml=true

no_set_formatting

eklendiği sürüm: 1.30.2 formatter --no-set-formatting

Varsayılan: false

{% set %} etiketlerinin içeriğini biçimlendirmez.

no_set_formatting=true

per_file_ignores

eklendiği sürüm: 1.7.0 linter --per-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"

prefer_configuration

eklendiği sürüm: 1.45.0 formatter linter --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.

Terminal window
--prefer-configuration

preserve_blank_lines

eklendiği sürüm: 1.3.0 formatter --preserve-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=true

preserve_class_newlines

eklendiği sürüm: 1.39.0 formatter --preserve-class-newlines

Varsayılan: false

Birden çok satıra yayılarak yazılmış class özniteliklerindeki satır sonlarını korur.

preserve_class_newlines=true

preserve_leading_space

eklendiği sürüm: 1.2.0 formatter --preserve-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=true

profile

eklendiği sürüm: 0.4.5 linter formatter --profile

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"

quiet

eklendiği sürüm: 0.0.9 formatter linter --quiet

Varsayılan: false

Diff’leri, ilerleme çubuğunu ve özeti yazdırmaz.

quiet=true

quote_style

eklendiği sürüm: 1.45.0 formatter linter --quote-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"

require_pragma

eklendiği sürüm: 0.5.8 formatter linter --require-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=true

rules

eklendiği sürüm: 1.41.0 formatter linter --rules

Proje kökündeki dosyanın yerine okunan, .djlint_rules.yaml biçiminde bir özel kural dosyası.

Terminal window
--rules ../shared/.djlint_rules.yaml

sarif

eklendiği sürüm: 1.46.0 formatter linter --sarif

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.

Terminal window
--sarif

single_attribute_per_line

eklendiği sürüm: 1.40.0 formatter --single-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=true

sort_attributes

eklendiği sürüm: 1.45.0 formatter --sort-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=true

sort_load_tags

eklendiği sürüm: 1.47.0 formatter --sort-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=true

statistics

eklendiği sürüm: 1.16.0 linter --statistics

Varsayılan: false

Lint denetiminden sonra her kodun kaç kez bulunduğunu yazdırır.

Terminal window
--statistics

stdin_filename

eklendiği sürüm: 1.43.0 formatter linter --stdin-filename

Varsayılan: "-"

Mesajlarda ve exclude ile per-file-ignores eşleştirilirken stdin’i temsil eden yol.

Terminal window
--stdin-filename templates/index.html

use_gitignore

eklendiği sürüm: 0.5.9 linter formatter --use-gitignore

Varsayılan: false

Proje kökündeki .gitignore dosyasında listelenen yolları da atlar.

use_gitignore=true

version

eklendiği sürüm: 0.3.9 formatter linter --version

Sürümü gösterir ve çıkar.

Terminal window
--version

warn

eklendiği sürüm: 0.7.6 formatter linter --warn

Varsayılan: false

Linter hata bulduğunda ya da yeniden biçimlendirilecek dosyalar olduğunda 1 yerine 0 ile çıkar.

Terminal window
--warn