통합
어떤 에디터를 쓰든 djLint는 에디터가 찾을 수 있는 곳, 가급적 프로젝트의 가상 환경에 설치하고, 에디터를 그 환경에서 시작하거나 에디터가 그 환경의 djlint를 가리키도록 하세요. 그러면 에디터가 프로젝트에 고정된 버전을 실행하므로 pre-commit 훅이나 CI와 같은 결과를 얻을 수 있습니다.
프로젝트에서 djLint를 npm으로 설치한다면, 명령은 프로젝트 안의 node_modules/.bin/djlint이고 Windows에서는 node_modules\.bin\djlint.cmd입니다. 아래 에디터에서 djlint를 실행하는 곳에 이 경로를 지정하세요. VS Code와 Zed 확장은 알아서 찾습니다.
Visual Studio Code
섹션 제목: “Visual Studio Code”Visual Studio Marketplace에서 djLint 확장을 설치하세요. Cursor, Windsurf, VSCodium 등 VS Code 기반 편집기에서는 같은 확장을 Open VSX에서 설치합니다. 이 확장은 환경에서 djLint를 찾고, 찾지 못하면 번들된 djLint를 사용하며, djLint가 언어 서버를 지원하면 언어 서버를 사용합니다.
설정과 어떤 djLint를 실행하는지는 README에서 설명합니다.
Zed
섹션 제목: “Zed”djLint 확장은 HTML과 Django, Jinja, Twig 같은 템플릿 확장의 언어에서 언어 서버를 실행합니다. 아직 Zed 확장 레지스트리에 없으므로 개발 확장으로 설치하세요.
-
rustup으로 Rust를 설치합니다. Zed는 Rust로 확장을 빌드하고
wasm32-wasip2타깃도 직접 추가합니다. Homebrew나 Nix 등 다른 방법으로 설치한 Rust라면 이 타깃을 직접 추가하세요. -
확장을 클론합니다:
터미널 창 git clone https://github.com/djlint/djlint-zed -
Zed에서 명령 팔레트를 열고(macOS는
cmd-shift-p, 그 밖에는ctrl-shift-p) zed: install dev extension을 실행한 뒤 클론한djlint-zed폴더를 고릅니다.
업데이트하려면 그 폴더에서 git pull을 실행한 다음 zed: rebuild dev extension을 실행하세요.
PATH에 있거나 프로젝트에 npm으로 설치한 djLint 1.49 이상이 있거나, djLint를 설치 없이 실행하는 uv가 있어야 합니다. 언어의 포매터로 지정하는 방법과 설정은 README에서 설명합니다.
Neovim
섹션 제목: “Neovim”Neovim은 일부 템플릿 확장자에 파일 타입을 지정하지 않습니다. 아래 어떤 방법을 쓰든 먼저 등록하세요.
vim.filetype.add({ extension = { gohtml = "gotmpl", gotmpl = "gotmpl", handlebars = "handlebars", j2 = "jinja", jinja2 = "jinja", mako = "mako", njk = "nunjucks", },})내장 LSP 클라이언트(권장)
섹션 제목: “내장 LSP 클라이언트(권장)”Neovim 0.11 이상은 플러그인 없이 djLint의 언어 서버와 직접 통신할 수 있습니다. 입력하는 동안 범위에 밑줄이 그어진 검사 결과를 받을 수 있고, 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")저장할 때 포맷하려면 같은 구성에 다음을 추가합니다.
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,})설정을 참고하세요.
conform.nvim과 nvim-lint
섹션 제목: “conform.nvim과 nvim-lint”conform.nvim은 포맷을, nvim-lint는 린트를 맡으며, 둘 다 djLint를 명령으로 실행합니다. 검사 결과에 밑줄이 그어진 범위가 없고, nvim-lint에 린트를 요청할 때만 결과가 나타납니다. 프로필은 명령줄에서처럼 프로젝트 구성에서 정해집니다. 이 예시에는 djLint 1.49 이상이 필요합니다.
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
섹션 제목: “none-ls”coc.nvim
섹션 제목: “coc.nvim”JetBrains IDE
섹션 제목: “JetBrains IDE”PyCharm을 비롯한 IntelliJ 기반 IDE에서는 무료 플러그인인 LSP4IJ를 사용하세요.
-
Marketplace에서 LSP4IJ를 설치합니다.
-
LSP Consoles 도구 창을 열고 새 언어 서버를 추가합니다.
-
Server 탭에서 이름을
djLint로, 명령을djlint --lsp로 설정합니다. PATH에 없다면 프로젝트 가상 환경에 있는djlint의 전체 경로를 사용합니다. -
Mappings 탭에서 템플릿의 파일 이름 패턴을 추가합니다. 프로젝트 구성에 프로필이 없다면 패턴마다 지정한 언어 ID로 프로필이 선택됩니다.
패턴 언어 ID *.html,*.htmhtml, Django에서는htmldjango*.jinja,*.jinja2,*.j2jinja*.njk,*.twignunjucks*.hbs,*.handlebars,*.mustachehandlebars*.liquidliquid*.gotmpl,*.gohtmlgotmpl*.teratera*.makomako -
Configuration 탭에서
djlint키 아래에 JSON으로 설정을 지정할 수 있습니다.
검사 결과가 에디터에 표시되고, 매핑된 파일에서는 Reformat Code가 이 서버를 사용할 수 있습니다.
Sublime Text
섹션 제목: “Sublime Text”LSP(권장)
섹션 제목: “LSP(권장)”LSP 패키지는 언어 서버를 실행해 입력하는 동안 검사 결과를 보여 주고 포맷 기능을 제공합니다.
Preferences: LSP Server Configurations를 실행하고 다음을 추가합니다.
{ "djlint": { "enabled": true, "command": ["djlint", "--lsp"], "selector": "text.html" } }SublimeLinter
섹션 제목: “SublimeLinter”Package Control로 SublimeLinter와 SublimeLinter-contrib-djlint를 설치합니다. djLint는 Sublime Text가 보는 PATH에 있어야 합니다.
Helix
섹션 제목: “Helix”Helix는 languages.toml에서 언어 서버를 실행할 수 있습니다. language-servers 목록은 Helix가 그 언어에 가진 목록을 대체하므로, djlint 뒤에 Helix의 기존 서버를 그대로 두세요.
[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는 스스로 어떤 파일도 htmldjango로 열지 않습니다. Django 프로젝트에서는 프로젝트의 .helix/languages.toml에서 이 항목에 file-types = ["html"]을 추가하세요.
Emacs
섹션 제목: “Emacs”Emacs 29 이상에 포함된 Eglot에서는 다음과 같이 합니다.
(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")))))그런 다음 템플릿에서 M-x eglot을 실행합니다. eglot-format-buffer로 템플릿을 포맷할 수 있습니다. html-mode, mhtml-mode, web-mode는 템플릿 언어를 알려 주지 않으므로, 이 모드에서는 프로필이 프로젝트 구성에서 정해집니다.
언어 서버
섹션 제목: “언어 서버”djlint --lsp는 djLint를 stdio로 통신하는 언어 서버로 실행합니다. 서버가 계속 실행되므로, 에디터는 입력하는 동안 검사 결과를 받고 매번 프로세스를 시작하지 않고도 문서를 포맷할 수 있습니다.
서버는 검사 결과를 보고하고 문서 전체를 포맷합니다. 추가 패키지는 필요하지 않습니다. LSP를 지원하는 다른 에디터라면 어디서든 같은 명령으로 실행할 수 있습니다.
서버는 명령줄과 마찬가지로 각 파일의 폴더에서 위쪽으로 프로젝트의 구성을 읽습니다. 에디터의 설정이 구성보다 우선하지만, 명령줄에서처럼 옵션을 켜거나 값을 지정하는 것만 가능합니다. false로는 프로젝트가 켠 옵션을 끌 수 없습니다. 설정 이름은 명령줄 옵션의 이름을 밑줄 표기나 camelCase로 쓰며, 쉼표로 구분하는 값에는 리스트를 쓸 수 있습니다.
vim.lsp.config("djlint", { settings = { djlint = { profile = "django", ignore = { "H013", "H016" } } },})서버는 workspace/configuration으로 djlint 섹션을 요청합니다. 이 요청에 응답할 수 없는 에디터는 같은 키를 initializationOptions로 보낼 수 있습니다.
다음 두 설정에는 대응하는 명령줄 옵션이 없습니다.
use_editor_indentation:indent대신 에디터의 탭 크기로 포맷합니다.python_rules:false로 설정하면python_module이 있는 사용자 정의 규칙을 건너뛰므로, 프로젝트의 코드가 실행되지 않습니다.
djLint는 다음 중 profile이 지정된 첫 번째 항목에서 그 값을 가져옵니다.
- 에디터의 설정
- 프로젝트의 구성
- 문서의 언어. 예를 들어
htmldjango는django프로필로 실행합니다.
셋 다 없으면 명령줄에서처럼 프로필 없이 실행합니다. 프로젝트 구성에 profile을 지정하는 것이 가장 간단합니다. 언어 ID를 설정할 필요 없이 모든 에디터에서 동작하기 때문입니다.
동작 방식
섹션 제목: “동작 방식”- 검사 결과는 입력을 잠시 멈춘 뒤에 나타납니다. 풀 진단(pull diagnostics)을 지원하는 에디터는 결과를 요청하고, 그 밖의 에디터에는 결과를 푸시합니다.
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”GitHub Actions 워크플로에서 djLint는 각 검사 결과를 주석(annotation)으로 보고하므로, 풀 리퀘스트의 diff에 인라인으로 표시됩니다. 따로 구성할 필요는 없습니다. 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는 SARIF 2.1.0 문서만 stdout에 쓰므로 위와 같이 리디렉션할 수 있습니다. 활성화된 모든 규칙이 문서 링크와 함께 나열되고, 각 검사 결과에는 줄과 열이 담기며, --check를 함께 쓰면 다시 포맷될 파일이 formatting 규칙으로 보고됩니다.
pre-commit
섹션 제목: “pre-commit”djLint는 pre-commit 훅으로 린터와 포맷터 모두에 사용할 수 있습니다.
아래 표의 프로필에는 각각 표에 나열한 린트용 훅과, 같은 이름에 reformat이 붙은 포맷용 훅이 있습니다. 예를 들어 djlint-django의 포맷용 훅은 djlint-reformat-django입니다. 이 훅들은 --profile과 pre-commit이 넘겨줄 파일을 지정합니다. angular에는 전용 훅이 없으므로 djlint나 djlint-reformat에 args: [--profile=angular]를 지정하세요.
| 훅 | 프로필 | 파일 |
|---|---|---|
djlint |
없음 | .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 |
다른 확장자를 쓰는 템플릿이라면 구성에서 files를 재정의하고, 훅이 types_or를 지정한 경우에는 그것도 재정의하세요. pre-commit은 두 조건이 모두 맞아야 파일을 넘기기 때문입니다. 자세한 내용은 pre-commit 문서를 참고하세요.
기본 Django 예시
섹션 제목: “기본 Django 예시”repos: - repo: https://github.com/djlint/djLint rev: v1.54.0 hooks: - id: djlint-reformat-django - id: djlint-django.hbs 대신 .html 확장자를 쓰는 Handlebars
섹션 제목: “.hbs 대신 .html 확장자를 쓰는 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"]files나 exclude 파라미터로 훅마다 대상 디렉터리를 제한하면, 한 저장소에서 여러 템플릿 언어를 지원할 수 있습니다.
MegaLinter
섹션 제목: “MegaLinter”MegaLinter에는 djLint가 포함되어 있습니다. npx mega-linter-runner --install을 실행해 설정하고, 옵션은 MegaLinter의 djLint 페이지를 참고하세요.