Интеграции
Для djLint существует несколько интеграций с редакторами.
Какой бы редактор вы ни использовали, установите djLint туда, где редактор сможет его найти, лучше всего в виртуальное окружение проекта, и запускайте редактор из этого окружения или укажите ему djlint из него. Тогда редактор будет запускать версию, зафиксированную в проекте, и результаты совпадут с результатами хука pre-commit или CI.
Visual Studio Code
Установите расширение djLint из Visual Studio Marketplace. Cursor, Windsurf, VSCodium и другие редакторы на основе VS Code ставят то же расширение из Open VSX. Оно ищет djLint в вашем окружении и, если не находит, использует встроенный. Если ваша версия djLint поддерживает языковой сервер, расширение работает через него.
Его код находится на GitHub.
Neovim
В Neovim djLint можно использовать как линтер и как форматер.
Встроенный LSP-клиент (рекомендуется)
Neovim 0.11 и новее может работать с языковым сервером djLint напрямую, без плагинов. Так замечания появляются прямо во время набора, с подчёркиванием проблемных фрагментов, а форматирование выполняет vim.lsp.buf.format():
vim.lsp.config("djlint", {
cmd = { "djlint", "--lsp" },
filetypes = { "html", "htmldjango", "jinja", "jinja.html", "handlebars", "liquid", "gotmpl" },
root_markers = { "pyproject.toml", "djlint.toml", ".djlint.toml", ".djlintrc", ".git" },
})
vim.lsp.enable("djlint")
Чтобы форматировать при сохранении, добавьте в ту же конфигурацию:
vim.api.nvim_create_autocmd("BufWritePre", {
pattern = {
"*.html", "*.jinja", "*.jinja2", "*.j2",
"*.hbs", "*.handlebars", "*.liquid", "*.gotmpl",
},
callback = function(args)
vim.lsp.buf.format({ bufnr = args.buf, name = "djlint" })
end,
})
См. раздел Настройки.
conform.nvim и nvim-lint
conform.nvim форматирует, а nvim-lint проверяет код, запуская djLint как команду. Замечания приходят без подчёркивания фрагментов и только тогда, когда вы запускаете проверку в nvim-lint.
require("conform").setup({ formatters_by_ft = { htmldjango = { "djlint" } } })
require("lint").linters_by_ft = { htmldjango = { "djlint" } }
none-ls
efm-langserver
- Установите efm-langserver и djLint через Mason командой
:MasonInstall efm djlint - Добавьте
htmldjangoвfiletypes. - Создайте конфигурацию форматирования:
local djlint = {
formatCommand = "djlint --reformat --quiet --warn -",
formatStdin = true,
}
- Свяжите язык с форматером:
htmldjango = { djlint }.
Пример конфигурации:
local djlint = {
formatCommand = "djlint --reformat --quiet --warn -",
formatStdin = true,
}
require("lspconfig").efm.setup({
filetypes = { "htmldjango" },
init_options = { documentFormatting = true },
settings = {
rootMarkers = { ".git/" },
languages = {
htmldjango = { djlint },
},
},
})
coc.nvim
IDE от JetBrains
В PyCharm и других IDE на базе IntelliJ используйте бесплатный плагин LSP4IJ:
- Установите LSP4IJ из Marketplace.
- Откройте окно инструментов LSP Consoles и добавьте новый языковой сервер.
- На вкладке Server укажите имя
djLintи командуdjlint --lsp, с полным путём кdjlintв виртуальном окружении проекта, если его нет в PATH. - На вкладке Mappings добавьте маску имён файлов ваших шаблонов, например
*.html. Если в конфигурации проекта не задан профиль, для проекта на Django укажите идентификатор языкаhtmldjango, чтобы был выбран нужный профиль. - На вкладке Configuration можно задать настройки в формате JSON, в ключе
djlint.
Замечания появляются в редакторе, а Reformat Code может использовать сервер для сопоставленных файлов.
Sublime Text
LSP (рекомендуется)
Пакет LSP запускает языковой сервер, который показывает замечания во время набора и форматирует код.
Выполните Preferences: LSP Server Configurations и добавьте:
{ "djlint": { "enabled": true, "command": ["djlint", "--lsp"], "selector": "text.html" } }
SublimeLinter
djLint можно использовать как плагин линтера для SublimeText. Его можно установить через package-control.
cmd + shift + p- Установите SublimeLinter
- Установите SublimeLinter-contrib-djlint
Убедитесь, что djLint установлен в глобальный Python или доступен в PATH.
Helix
Helix может запускать языковой сервер, настроенный в languages.toml:
[language-server.djlint]
command = "djlint"
args = ["--lsp"]
[[language]]
name = "html"
language-servers = ["djlint", "vscode-html-language-server"]
Emacs
Eglot, входящий в состав Emacs 29 и новее:
(with-eval-after-load 'eglot
(add-to-list 'eglot-server-programs
'((html-mode web-mode) . ("djlint" "--lsp"))))
Затем выполните M-x eglot в шаблоне. eglot-format-buffer отформатирует его.
Языковой сервер
djlint --lsp запускает djLint как языковой сервер, работающий через stdio. Сервер работает постоянно, поэтому редактор получает замечания во время набора и форматирует документ, не запуская каждый раз новый процесс.
Сервер сообщает о замечаниях и форматирует документы целиком. Дополнительные пакеты ему не нужны. Любой другой редактор с поддержкой LSP может запустить его той же командой.
Настройки
Сервер читает конфигурацию проекта так же, как командная строка: от папки каждого файла вверх. Настройки из редактора важнее неё, но, как и в командной строке, они могут только включить параметр или задать значение: false не отключит то, что включено в проекте. Их имена совпадают с именами параметров командной строки, с подчёркиваниями или в camelCase, а вместо значений через запятую можно передавать списки:
vim.lsp.config("djlint", {
settings = { djlint = { profile = "django", ignore = { "H013", "H016" } } },
})
Сервер запрашивает раздел djlint через workspace/configuration. Редактор, который не умеет на это отвечать, может передать те же ключи в initializationOptions.
У двух настроек нет соответствующего параметра командной строки:
use_editor_indentation: форматировать с размером табуляции из редактора, а не сindent.python_rules: установитеfalse, чтобы пропускать пользовательские правила сpython_module; так код проекта не будет запускаться.
djLint берёт profile из первого источника, где он задан:
- Настройки редактора.
- Конфигурация проекта.
- Язык документа: например, для
htmldjangoиспользуется профильdjango.
Если профиль нигде не задан, djLint работает без профиля, как и в командной строке. Проще всего задать profile в конфигурации проекта: это работает в любом редакторе, и не нужно настраивать идентификатор языка.
Как работает сервер
- Замечания появляются после короткой паузы в наборе. Редактор, поддерживающий pull-диагностику, запрашивает их сам, а любому другому сервер присылает их.
exclude,extend_excludeиuse_gitignoreдействуют и на открытые документы. У исключённого документа нет замечаний, и он не форматируется.- Сервер перечитывает конфигурацию при изменении
pyproject.toml,djlint.toml,.djlint.toml,.djlintrc,.djlint_rules.yaml,.editorconfigили.gitignore, если редактор умеет отслеживать файлы, а иначе — при открытии или сохранении документа. Файлы, указанные вconfigurationилиrules, перечитываются при открытии или сохранении документа. После изменения кода вpython_moduleпользовательского правила нужен перезапуск. - Медленное правило задерживает всё, что идёт после него, потому что сервер выполняет задачи по одной.
GitHub Actions
В рабочем процессе GitHub Actions djLint выводит каждое замечание как аннотацию, поэтому оно отображается прямо среди изменений пул-реквеста. Настраивать ничего не нужно: djLint сам распознаёт рабочий процесс и переключает формат вывода.
- run: pip install djlint
- run: djlint . --lint --profile django
Чтобы вместо этого получить обычный консольный вывод, используйте --no-github-output, а чтобы принудительно выводить аннотации вне Actions — --github-output.
Аннотации относятся к одному пул-реквесту. Чтобы хранить замечания на вкладке Security репозитория, с историей по всем запускам, запишите их в формате SARIF и загрузите файл:
- run: djlint . --lint --sarif > djlint.sarif
continue-on-error: true
- uses: github/codeql-action/upload-sarif@v4
with:
sarif_file: djlint.sarif
Шагу загрузки нужно разрешение security-events: write на уровне задания или рабочего процесса.
--sarif выводит в stdout документ SARIF 2.1.0 и больше ничего, поэтому вывод можно перенаправить, как показано выше. Каждое включённое правило перечисляется со ссылкой на свою документацию, у каждого замечания указаны строка и столбец, а с --check файл, который был бы переформатирован, попадает в отчёт под правилом formatting. Тот же формат читают Azure DevOps, GitLab и большинство редакторов.
Pre-Commit
djLint можно использовать как хук pre-commit и для проверки, и для форматирования.
В репозитории есть несколько готовых хуков для отдельных профилей djLint (они лишь заранее задают аргумент --profile и сообщают pre-commit, файлы с какими расширениями искать):
djlintдля проверки иdjlint-reformatдля форматирования
Ищут файлы по маске*.html, не задавая--profile.djlint-djangoиdjlint-reformat-django
Ищут файлы по маске*.htmlи задают--profile=django.djlint-jinjaиdjlint-reformat-jinja
Ищут файлы по маскам*.j2,*.jinjaили*.jinja2и задают--profile=jinja.djlint-nunjucksиdjlint-reformat-nunjucks
Ищут файлы по маске*.njkи задают--profile=nunjucks.djlint-handlebarsиdjlint-reformat-handlebars
Ищут файлы по маске*.hbsи задают--profile=handlebars.djlint-liquidиdjlint-reformat-liquid
Ищут файлы по маске*.htmlи задают--profile=liquid.djlint-golangиdjlint-reformat-golang
Ищут файлы по маске*.gotmplи задают--profile=golang.djlint-teraиdjlint-reformat-tera
Ищут файлы по маске*.htmlи задают--profile=tera.djlint-askamaиdjlint-reformat-askama
Ищут файлы по маске*.htmlи задают--profile=askama.djlint-makoиdjlint-reformat-mako
Ищут файлы по маске*.htmlи задают--profile=mako.
Учтите, что эти готовые хуки иногда слишком строги к тому, какие файлы принимают (у ваших шаблонов может быть другое расширение), поэтому pre-commit явно позволяет переопределить любые из этих заранее заданных параметров. Подробнее о настройке см. в документации pre-commit.
Стандартный пример для Django
repos:
- repo: https://github.com/djlint/djLint
rev: v1.50.4
hooks:
- id: djlint-reformat-django
- id: djlint-django
Handlebars с расширением .html вместо .hbs
repos:
- repo: https://github.com/djlint/djLint
rev: v1.50.4
hooks:
- id: djlint-reformat-handlebars
files: "\\.html"
types_or: ["html"]
- id: djlint-handlebars
files: "\\.html"
types_or: ["html"]
С помощью параметров files или exclude можно ограничить каждый хук своим каталогом и так поддерживать несколько языков шаблонов в одном репозитории.
MegaLinter
djlint входит в число более чем 100 линтеров, встроенных в MegaLinter
Чтобы установить его, просто выполните npx mega-linter-runner --install и следуйте инструкциям