Entegrasyonlar
Hangi düzenleyiciyi kullanırsanız kullanın, djLint’i düzenleyicinin bulabileceği bir yere, tercihen projenin sanal ortamına kurun ve düzenleyiciyi oradan başlatın ya da düzenleyiciyi o ortamdaki djlint komutuna yönlendirin. Böylece düzenleyici, projenizin sabitlediği sürümü çalıştırır ve pre-commit kancanızla ya da CI ile aynı sonuçları verir.
Proje djLint’i npm ile kuruyorsa komutu projede node_modules/.bin/djlint, Windows’ta ise node_modules\.bin\djlint.cmd olur. Aşağıdaki düzenleyicilerde djlint çalıştırılan yerlerde bu yolu verin. VS Code ve Zed uzantıları onu kendileri bulur.
Visual Studio Code
Bölüm başlığı “Visual Studio Code”djLint uzantısını Visual Studio Marketplace’ten kurun. Cursor, Windsurf, VSCodium ve VS Code tabanlı diğer editörler aynı uzantıyı Open VSX’ten kurar. Uzantı djLint’i ortamınızda bulur, bulamazsa kendisiyle birlikte gelen sürüme geri döner ve djLint sürümünüzde dil sunucusu varsa onu kullanır.
Uzantının README dosyası, ayarlarını ve hangi djLint’i çalıştırdığını anlatır.
djLint uzantısı, dil sunucusunu HTML’de ve Django, Jinja, Twig gibi şablon uzantılarının dillerinde çalıştırır. Henüz Zed’in uzantı kayıt defterinde olmadığından onu geliştirme uzantısı olarak kurun:
-
Rust’ı rustup ile kurun: Zed uzantıyı onunla derler ve
wasm32-wasip2hedefini kendisi ekler. Rust’ı Homebrew ya da Nix gibi başka bir yoldan kurduysanız bu hedefi kendiniz ekleyin. -
Uzantıyı klonlayın:
Terminal window git clone https://github.com/djlint/djlint-zed -
Zed’de komut paletini açın (macOS’ta
cmd-shift-p, diğerlerindectrl-shift-p), zed: install dev extension komutunu çalıştırın ve klonlanandjlint-zedklasörünü seçin.
Güncellemek için o klasörde git pull, ardından zed: rebuild dev extension çalıştırın.
PATH’te ya da projede npm ile kurulu djLint 1.49 veya daha yenisi ya da djLint’i kurulum olmadan çalıştıran uv gerekir. Uzantının README dosyası, onu bir dilin biçimlendiricisi olarak nasıl ayarlayacağınızı gösterir ve ayarlarını anlatır.
Neovim
Bölüm başlığı “Neovim”Neovim bazı şablon uzantılarına dosya türü atamaz. Aşağıdaki seçeneklerden hangisini kullanırsanız kullanın, önce bunları kaydedin:
vim.filetype.add({ extension = { gohtml = "gotmpl", gotmpl = "gotmpl", handlebars = "handlebars", j2 = "jinja", jinja2 = "jinja", mako = "mako", njk = "nunjucks", },})Yerleşik LSP istemcisi (önerilen)
Bölüm başlığı “Yerleşik LSP istemcisi (önerilen)”Neovim 0.11 ve üzeri, herhangi bir eklenti olmadan djLint’in dil sunucusuyla doğrudan konuşabilir. Bu sayede bulgular, altı çizili aralıklarla birlikte siz yazarken gelir ve biçimlendirme için vim.lsp.buf.format() kullanılabilir:
vim.lsp.config("djlint", { cmd = { "djlint", "--lsp" }, filetypes = { "html", "htmldjango", "htmlangular", "jinja", "jinja.html", "nunjucks", "twig", "handlebars", "mustache", "liquid", "gotmpl", "tera", "mako", }, root_markers = { "pyproject.toml", "djlint.toml", ".djlint.toml", ".djlintrc", ".git" },})vim.lsp.enable("djlint")Kaydederken biçimlendirmek için aynı yapılandırmaya şunu ekleyin:
local group = vim.api.nvim_create_augroup("djlint_format", {})vim.api.nvim_create_autocmd("LspAttach", { callback = function(args) if vim.lsp.get_client_by_id(args.data.client_id).name ~= "djlint" then return end vim.api.nvim_clear_autocmds({ group = group, buffer = args.buf }) vim.api.nvim_create_autocmd("BufWritePre", { group = group, buffer = args.buf, callback = function() vim.lsp.buf.format({ bufnr = args.buf, name = "djlint" }) end, }) end,})Bkz. Ayarlar.
conform.nvim ve nvim-lint
Bölüm başlığı “conform.nvim ve nvim-lint”conform.nvim biçimlendirir, nvim-lint ise lint denetimi yapar; ikisi de djLint’i bir komut olarak çalıştırır. Bulguların altı çizili bir aralığı olmaz ve yalnızca nvim-lint’ten denetim yapmasını istediğinizde gelirler. Profil, komut satırında olduğu gibi projenin yapılandırmasından gelir. Bu örnek djLint 1.49 veya daha yenisini gerektirir.
local formatters, linters = {}, {}for _, filetype in ipairs({ "html", "htmldjango", "htmlangular", "jinja", "jinja.html", "nunjucks", "twig", "handlebars", "mustache", "liquid", "gotmpl", "tera", "mako",}) do formatters[filetype] = { "djlint" } linters[filetype] = { "djlint" }endrequire("conform").setup({ formatters_by_ft = formatters, formatters = { djlint = { prepend_args = { "--stdin-filename", "$FILENAME" } } },})local lint = require("lint")lint.linters_by_ft = lintersvim.list_extend(lint.linters.djlint.args, { "--stdin-filename", function() return vim.api.nvim_buf_get_name(0) end,})none-ls
Bölüm başlığı “none-ls”coc.nvim
Bölüm başlığı “coc.nvim”JetBrains IDE’leri
Bölüm başlığı “JetBrains IDE’leri”PyCharm’da ve IntelliJ tabanlı diğer IDE’lerde ücretsiz LSP4IJ eklentisini kullanın:
-
LSP4IJ’yi Marketplace’ten kurun.
-
LSP Consoles araç penceresini açın ve yeni bir dil sunucusu ekleyin.
-
Server sekmesinde adı
djLint, komutudjlint --lspolarak ayarlayın; PATH üzerinde değilse projenin sanal ortamındakidjlintkomutunun tam yolunu kullanın. -
Mappings sekmesinde şablonlarınızın dosya adı kalıplarını ekleyin. Projenin yapılandırmasında bir profil yoksa profili her kalıbın dil kimliği seçer:
Kalıplar Dil kimliği *.html,*.htmhtml, Django’dahtmldjango*.jinja,*.jinja2,*.j2jinja*.njk,*.twignunjucks*.hbs,*.handlebars,*.mustachehandlebars*.liquidliquid*.gotmpl,*.gohtmlgotmpl*.teratera*.makomako -
Configuration sekmesinde ayarları JSON olarak, bir
djlintanahtarı altında belirleyebilirsiniz.
Bulgular düzenleyicide görünür ve Reformat Code, eşlenen dosyalar için sunucuyu kullanabilir.
Sublime Text
Bölüm başlığı “Sublime Text”LSP (önerilen)
Bölüm başlığı “LSP (önerilen)”LSP paketi dil sunucusunu çalıştırır; bu da siz yazarken bulgular ve biçimlendirme sağlar.
Preferences: LSP Server Configurations komutunu çalıştırın ve şunu ekleyin:
{ "djlint": { "enabled": true, "command": ["djlint", "--lsp"], "selector": "text.html" } }SublimeLinter
Bölüm başlığı “SublimeLinter”SublimeLinter’ı ve SublimeLinter-contrib-djlint paketini Package Control ile kurun. djLint, Sublime Text’in gördüğü PATH üzerinde olmalıdır.
Helix, dil sunucusunu languages.toml dosyasından çalıştırabilir. Bir language-servers listesi, Helix’in o dil için kullandığı listenin yerini alır; bu yüzden Helix’in kendi sunucularını djlint ardından koruyun:
[language-server.djlint]command = "djlint"args = ["--lsp"]
[[language]]name = "html"language-servers = ["djlint", "vscode-html-language-server", "superhtml"]
[[language]]name = "htmldjango"language-servers = ["djlint", "djlsp", "vscode-html-language-server", "superhtml"]
[[language]]name = "gotmpl"language-servers = ["djlint", "gopls"]
[[language]]name = "jinja"language-servers = ["djlint"]
[[language]]name = "nunjucks"language-servers = ["djlint"]
[[language]]name = "twig"language-servers = ["djlint"]
[[language]]name = "tera"language-servers = ["djlint"]Helix hiçbir dosyayı kendiliğinden htmldjango olarak açmaz. Bir Django projesinde, projenin .helix/languages.toml dosyasında bu girdiye file-types = ["html"] ekleyin.
Emacs 29 ve üzeriyle birlikte gelen Eglot ile:
(with-eval-after-load 'eglot (dolist (mode '(html-mode mhtml-mode web-mode jinja2-mode twig-mode handlebars-mode mustache-mode)) (add-to-list 'eglot-server-programs `(,mode . ("djlint" "--lsp")))))Ardından bir şablonda M-x eglot çalıştırın. eglot-format-buffer şablonu biçimlendirir. html-mode, mhtml-mode ve web-mode bir şablon dili belirtmez; bu modlarda profil projenin yapılandırmasından gelir.
Dil sunucusu
Bölüm başlığı “Dil sunucusu”djlint --lsp, djLint’i stdio üzerinden bir dil sunucusu olarak çalıştırır. Sunucu çalışmaya devam eder; böylece düzenleyici, siz yazarken bulguları alır ve her seferinde yeni bir süreç başlatmadan belgeyi biçimlendirir.
Bulguları bildirir ve belgelerin tamamını biçimlendirir. Ek paket gerektirmez. LSP konuşan başka herhangi bir düzenleyici de aynı komutla çalıştırabilir.
Ayarlar
Bölüm başlığı “Ayarlar”Sunucu, projenin yapılandırmasını komut satırının yaptığı gibi her dosyanın klasöründen yukarı doğru okur. Düzenleyiciden gelen ayarlar bunun önüne geçer, ancak komut satırında olduğu gibi yalnızca bir seçeneği açabilir ya da bir değer belirleyebilir: false, projenin açtığı bir şeyi kapatmaz. Ayarlar komut satırı seçeneklerinin adlarını, alt çizgili ya da camelCase biçiminde alır; virgülle ayrılmış değerler için listeler kullanılabilir:
vim.lsp.config("djlint", { settings = { djlint = { profile = "django", ignore = { "H013", "H016" } } },})Sunucu djlint bölümünü workspace/configuration ile ister. Buna yanıt veremeyen bir düzenleyici aynı anahtarları initializationOptions içinde gönderebilir.
İki ayarın komut satırı seçeneği yoktur:
use_editor_indentation:indentyerine düzenleyicinin sekme boyutuyla biçimlendirir.python_rules:python_moduleiçeren özel kuralları atlamak içinfalseyapın; bu, projenin kodunun çalışmasını önler.
djLint profile değerini, aşağıdakilerden bir profil içeren ilkinden alır:
- Düzenleyicinin ayarları.
- Projenin yapılandırması.
- Belgenin dili: örneğin
htmldjango,djangoprofilini çalıştırır.
Hiçbiri yoksa komut satırında olduğu gibi profilsiz çalışır. Projenin yapılandırmasındaki bir profile en basit seçimdir: her düzenleyicide çalışır ve ayarlanacak bir dil kimliği gerektirmez.
Neler yapar
Bölüm başlığı “Neler yapar”- Bulgular, yazmaya kısa bir ara verdikten sonra gelir. Pull diagnostics destekleyen bir düzenleyici bulguları kendisi ister, diğerlerine ise bulgular gönderilir.
exclude,extend_excludeveuse_gitignoreaçık belgelere uygulanır. Hariç tutulan bir belgenin bulgusu olmaz ve biçimlendirilmez.pyproject.toml,djlint.toml,.djlint.toml,.djlintrc,.djlint_rules.yaml,.editorconfigya da.gitignoredeğiştiğinde, düzenleyici dosyaları izleyebiliyorsa yapılandırmayı yeniden yükler; izleyemiyorsa bir belge açıldığında ya da kaydedildiğinde yükler.configurationya darulesile belirtilen dosyalar, bir belge açıldığında ya da kaydedildiğinde yeniden okunur. Özel bir kuralınpython_modulekodundaki bir değişiklik yeniden başlatma gerektirir.- Sunucu her seferinde tek bir iş yaptığından, yavaş bir kural kendisinden sonra gelenleri bekletir.
GitHub Actions
Bölüm başlığı “GitHub Actions”Bir GitHub Actions iş akışında djLint her bulguyu bir ek açıklama (annotation) olarak bildirir; böylece bulgu, pull request’in diff’inde satır içinde görünür. Yapılandırma gerekmez: djLint iş akışını algılar ve çıktıyı otomatik olarak değiştirir.
- run: pip install djlint- run: djlint . --lint --profile djangoBunun yerine düz konsol çıktısını almak için --no-github-output, Actions dışında ek açıklamaları zorlamak için --github-output kullanın.
Ek açıklamalar tek bir pull request’e aittir. Bulguları, çalıştırmalar arası geçmişiyle birlikte deponun Security sekmesinde tutmak için onları SARIF olarak yazın ve dosyayı yükleyin:
- run: djlint . --lint --sarif > djlint.sarif continue-on-error: true- uses: github/codeql-action/upload-sarif@v4 with: sarif_file: djlint.sarifYükleme adımı, job’da ya da iş akışında security-events: write iznine ihtiyaç duyar.
--sarif, stdout’a bir SARIF 2.1.0 belgesi yazar ve başka hiçbir şey yazmaz; bu yüzden yukarıdaki gibi yönlendirilebilir. Etkin her kural, belgelerine giden bir bağlantıyla listelenir, her bulgu satırını ve sütununu taşır ve --check ile yeniden biçimlendirilecek bir dosya formatting kuralı altında bildirilir.
pre-commit
Bölüm başlığı “pre-commit”djLint, hem linter hem de biçimlendirici olarak bir pre-commit kancası şeklinde kullanılabilir.
Bu profillerin her birinin burada listelenen, lint denetimi yapan bir kancası ve biçimlendiren, aynı adı reformat ile taşıyan bir kancası vardır: djlint-django için djlint-reformat-django. Kancalar --profile değerini ve pre-commit’in ileteceği dosyaları ayarlar. angular profilinin kendine ait kancası yoktur: djlint ya da djlint-reformat kancasına args: [--profile=angular] verin.
| Kanca | Profil | Dosyalar |
|---|---|---|
djlint |
yok | .html, .htm, .xhtml |
djlint-django |
django | .html, .htm, .xhtml |
djlint-jinja |
jinja | .j2, .jinja, .jinja2 |
djlint-nunjucks |
nunjucks | .njk |
djlint-handlebars |
handlebars | .hbs, .handlebars, .mustache |
djlint-liquid |
liquid | .html, .htm, .xhtml, .liquid |
djlint-golang |
golang | .gotmpl |
djlint-tera |
tera | .html, .htm, .xhtml |
djlint-askama |
askama | .html, .htm, .xhtml |
djlint-mako |
mako | .html, .htm, .xhtml |
Başka uzantılı şablonlar için yapılandırmanızda files değerini, kanca ayarlıyorsa types_or değerini de geçersiz kılın, çünkü pre-commit ikisinin de eşleşmesini ister. Ayrıntılar için pre-commit belgelerine bakın.
Varsayılan Django örneği
Bölüm başlığı “Varsayılan Django örneği”repos: - repo: https://github.com/djlint/djLint rev: v1.54.0 hooks: - id: djlint-reformat-django - id: djlint-django.hbs yerine .html uzantılı Handlebars
Bölüm başlığı “.hbs yerine .html uzantılı Handlebars”repos: - repo: https://github.com/djlint/djLint rev: v1.54.0 hooks: - id: djlint-reformat-handlebars files: "\\.html" types_or: ["html"] - id: djlint-handlebars files: "\\.html" types_or: ["html"]Her kancayı kendi dizinine sınırlamak için files ya da exclude parametrelerini kullanabilirsiniz; böylece aynı depoda birden çok şablon dilini destekleyebilirsiniz.
MegaLinter
Bölüm başlığı “MegaLinter”MegaLinter djLint’i içerir. Kurmak için npx mega-linter-runner --install komutunu çalıştırın, seçenekler için djLint sayfasına bakın.