Integrace
Ať používáte jakýkoli editor, nainstalujte djLint tam, kde ho editor najde, ideálně do virtuálního prostředí projektu, a editor spouštějte z něj, nebo ho nasměrujte na djlint z tohoto prostředí. Editor pak spouští verzi, kterou má váš projekt zafixovanou, se stejnými výsledky jako váš hook pre-commit nebo CI.
Pokud projekt instaluje djLint přes npm, jeho příkaz je v projektu node_modules/.bin/djlint, na Windows node_modules\.bin\djlint.cmd. Kde editor níže spouští djlint, zadejte mu tuto cestu. Rozšíření pro VS Code a Zed ho najdou sama.
Visual Studio Code
Sekce “Visual Studio Code”Nainstalujte rozšíření djLint z Visual Studio Marketplace. Cursor, Windsurf, VSCodium a další editory postavené na VS Code instalují stejné rozšíření z Open VSX. Najde djLint ve vašem prostředí, jinak použije přibalenou verzi, a pokud ho váš djLint podporuje, používá jazykový server.
Jeho README popisuje nastavení rozšíření a to, který djLint spouští.
Zed
Sekce “Zed”Rozšíření djLint spouští jazykový server v HTML a v jazycích šablonových rozšíření, například Django, Jinja a Twig. V registru rozšíření Zedu zatím není, proto ho nainstalujte jako vývojové rozšíření (dev extension):
-
Nainstalujte Rust přes rustup, Zed s ním rozšíření sestavuje a sám si přidá cíl
wasm32-wasip2. S Rustem odjinud, například z Homebrew nebo Nixu, ho přidejte sami. -
Naklonujte rozšíření:
Terminál git clone https://github.com/djlint/djlint-zed -
V Zedu otevřete paletu příkazů (
cmd-shift-pna macOS, jindectrl-shift-p), spusťte zed: install dev extension a vyberte naklonovanou složkudjlint-zed.
Aktualizace: ve složce spusťte git pull a potom zed: rebuild dev extension.
Potřebuje djLint 1.49 nebo novější v PATH nebo nainstalovaný v projektu přes npm, nebo uv, které djLint spustí bez instalace. Jeho README ukazuje, jak ho nastavit jako formátovač jazyka, a popisuje jeho nastavení.
Neovim
Sekce “Neovim”Některým příponám šablon Neovim žádný filetype nepřiřadí. Ať použijete kteroukoli možnost níže, nejdřív je zaregistrujte:
vim.filetype.add({ extension = { gohtml = "gotmpl", gotmpl = "gotmpl", handlebars = "handlebars", j2 = "jinja", jinja2 = "jinja", mako = "mako", njk = "nunjucks", },})Vestavěný klient LSP (doporučeno)
Sekce “Vestavěný klient LSP (doporučeno)”Neovim 0.11 nebo novější umí komunikovat s jazykovým serverem djLint přímo, bez pluginu. Získáte tak nálezy už během psaní, s podtrženými úseky, a formátování pomocí vim.lsp.buf.format():
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")Chcete-li formátovat při ukládání, přidejte do stejné konfigurace:
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,})Viz Nastavení.
conform.nvim a nvim-lint
Sekce “conform.nvim a nvim-lint”conform.nvim formátuje a nvim-lint lintuje tak, že djLint spouštějí jako příkaz. Nálezy nemají podtržený úsek a objeví se, jen když nvim-lint požádáte o lintování. Profil se bere z konfigurace projektu, stejně jako na příkazové řádce. Tento příklad potřebuje djLint 1.49 nebo novější.
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
Sekce “none-ls”coc.nvim
Sekce “coc.nvim”IDE od JetBrains
Sekce “IDE od JetBrains”V PyCharmu a dalších IDE postavených na IntelliJ použijte bezplatný plugin LSP4IJ:
-
Nainstalujte LSP4IJ z Marketplace.
-
Otevřete nástrojové okno LSP Consoles a přidejte nový jazykový server.
-
Na kartě Server nastavte název na
djLinta příkaz nadjlint --lsp, a pokuddjlintz virtuálního prostředí projektu není v PATH, uveďte jeho úplnou cestu. -
Na kartě Mappings přidejte vzory názvů souborů vašich šablon. Když konfigurace projektu nemá žádný profil, vybere ho ID jazyka u vzoru:
Vzory ID jazyka *.html,*.htmhtml, v Djanguhtmldjango*.jinja,*.jinja2,*.j2jinja*.njk,*.twignunjucks*.hbs,*.handlebars,*.mustachehandlebars*.liquidliquid*.gotmpl,*.gohtmlgotmpl*.teratera*.makomako -
Na kartě Configuration můžete zadat nastavení jako JSON pod klíčem
djlint.
Nálezy se zobrazují v editoru a Reformat Code může pro namapované soubory používat server.
Sublime Text
Sekce “Sublime Text”LSP (doporučeno)
Sekce “LSP (doporučeno)”Balíček LSP spouští jazykový server, který poskytuje nálezy už během psaní a formátování.
Spusťte Preferences: LSP Server Configurations a přidejte:
{ "djlint": { "enabled": true, "command": ["djlint", "--lsp"], "selector": "text.html" } }SublimeLinter
Sekce “SublimeLinter”Nainstalujte SublimeLinter a SublimeLinter-contrib-djlint přes Package Control. djLint musí být v PATH, kterou vidí Sublime Text.
Helix
Sekce “Helix”Helix umí spouštět jazykový server ze souboru languages.toml. Seznam language-servers nahradí ten, který má Helix pro daný jazyk, proto za djlint ponechte jeho vlastní servery:
[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 sám žádný soubor jako htmldjango neotevře. V projektu s Djangem přidejte k této položce file-types = ["html"] v souboru .helix/languages.toml projektu.
Emacs
Sekce “Emacs”Eglot, který je součástí Emacsu 29 a novějšího:
(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")))))Pak v šabloně spusťte M-x eglot. Příkaz eglot-format-buffer ji naformátuje. html-mode, mhtml-mode a web-mode žádný šablonovací jazyk neurčují, proto se v nich profil bere z konfigurace projektu.
Jazykový server
Sekce “Jazykový server”djlint --lsp spustí djLint jako jazykový server přes stdio. Zůstává spuštěný, takže editor dostává nálezy už během psaní a formátuje dokument, aniž by pokaždé spouštěl nový proces.
Hlásí nálezy a formátuje celé dokumenty. Nepotřebuje žádné další balíčky. Spustit ho stejným příkazem může i jakýkoli jiný editor, který podporuje LSP.
Nastavení
Sekce “Nastavení”Server čte konfiguraci projektu stejně jako příkazový řádek, od složky každého souboru směrem nahoru. Nastavení z editoru mají před ní přednost, ale stejně jako na příkazovém řádku mohou možnost jen zapnout nebo nastavit hodnotu: false nevypne to, co projekt zapíná. Mají názvy možností příkazového řádku, s podtržítky nebo v camelCase, a pro hodnoty oddělené čárkami lze použít seznamy:
vim.lsp.config("djlint", { settings = { djlint = { profile = "django", ignore = { "H013", "H016" } } },})Server si oddíl djlint vyžádá přes workspace/configuration. Editor, který neumí odpovědět, může stejné klíče poslat v initializationOptions.
Dvě nastavení nemají odpovídající možnost příkazového řádku:
use_editor_indentation: Formátovat s velikostí tabulátoru z editoru, a ne podleindent.python_rules: Nastavte nafalse, chcete-li přeskočit vlastní pravidla spython_module, čímž zabráníte spuštění kódu projektu.
djLint vezme profile z první z těchto možností, která ho obsahuje:
- Nastavení editoru.
- Konfigurace projektu.
- Jazyk dokumentu:
htmldjangonapříklad spustí profildjango.
Pokud žádná z nich profil nemá, spustí se bez profilu, stejně jako na příkazovém řádku. Nejjednodušší volbou je profile v konfiguraci projektu: funguje v každém editoru a není potřeba nastavovat žádné ID jazyka.
Co dělá
Sekce “Co dělá”- Nálezy přicházejí po krátké pauze v psaní. Editor s pull diagnostikou si o ně řekne, jakémukoli jinému je server pošle sám.
exclude,extend_excludeause_gitignoreplatí pro otevřené dokumenty. Vyloučený dokument nemá žádné nálezy a neformátuje se.- Konfiguraci znovu načte, když se změní
pyproject.toml,djlint.toml,.djlint.toml,.djlintrc,.djlint_rules.yaml,.editorconfignebo.gitignore, pokud editor umí sledovat soubory, a jinak při otevření nebo uložení dokumentu. Soubory zadané vconfigurationneborulesse znovu načtou při otevření nebo uložení dokumentu. Změna kódu vpython_modulevlastního pravidla vyžaduje restart. - Pomalé pravidlo zdrží vše, co přijde po něm, protože server dělá vždy jen jednu věc najednou.
GitHub Actions
Sekce “GitHub Actions”Ve workflow GitHub Actions hlásí djLint každý nález jako anotaci, takže se zobrazí přímo v diffu pull requestu. Není potřeba nic konfigurovat: djLint workflow rozpozná a výstup přepne automaticky.
- run: pip install djlint- run: djlint . --lint --profile djangoPomocí --no-github-output získáte místo toho běžný výstup do konzole, pomocí --github-output vynutíte anotace i mimo Actions.
Anotace patří k jednomu pull requestu. Chcete-li mít nálezy na kartě Security repozitáře, s historií napříč spuštěními, zapište je jako SARIF a soubor nahrajte:
- run: djlint . --lint --sarif > djlint.sarif continue-on-error: true- uses: github/codeql-action/upload-sarif@v4 with: sarif_file: djlint.sarifKrok nahrání potřebuje oprávnění security-events: write na úrovni jobu nebo workflow.
--sarif zapíše na stdout dokument SARIF 2.1.0 a nic jiného, takže ho lze přesměrovat jako výše. Každé zapnuté pravidlo je uvedené s odkazem na svou dokumentaci, každý nález nese svůj řádek a sloupec a s --check se soubor, který by se přeformátoval, hlásí pod pravidlem formatting.
pre-commit
Sekce “pre-commit”djLint lze používat jako hook pre-commit, a to jako linter i jako formátovač.
Každý z těchto profilů má hook, který lintuje (jsou uvedené níže), a hook, který formátuje, se stejným názvem s reformat: djlint-reformat-django k djlint-django. Nastavují --profile a soubory, které pre-commit předává. angular vlastní hooky nemá: nastavte hooku djlint nebo djlint-reformat args: [--profile=angular].
| Hook | Profil | Soubory |
|---|---|---|
djlint |
žádný | .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 |
Pro šablony s jinými příponami přepište ve své konfiguraci files, a pokud ho hook nastavuje, také types_or, protože pre-commit vyžaduje shodu obou. Viz dokumentaci pre-commit.
Výchozí příklad pro Django
Sekce “Výchozí příklad pro Django”repos: - repo: https://github.com/djlint/djLint rev: v1.54.0 hooks: - id: djlint-reformat-django - id: djlint-djangoHandlebars s příponou .html místo .hbs
Sekce “Handlebars s příponou .html místo .hbs”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"]Pomocí parametrů files nebo exclude můžete každý hook omezit na jeho vlastní adresář, a podporovat tak v jednom repozitáři více šablonovacích jazyků.
MegaLinter
Sekce “MegaLinter”MegaLinter obsahuje djLint. Nastavíte ho příkazem npx mega-linter-runner --install a jeho možnosti najdete na stránce o djLint.