Integrations
There are several editor integrations build for djLint.
∞ Pre-Commit
djLint can be used as a pre-commit hook.
The repo provides multiple pre-configured hooks for specific djLint profiles (it just pre-sets the --profile
argument and tells pre-commit which file extensions to look for):
djlint-django
for Django templates:
This will look for files matching templates/**.html
and set --profile=django
.djlint-jinja
This will look for files matching *.j2
and set --profile=jinja
.djlint-nunjucks
This will look for files matching *.njk
and set --profile=nunjucks
.djlint-handlebars
This will look for files matching *.hbs
and set --profile=handlebars
.djlint-golang
This will look for files matching *.tmpl
and set --profile=golang
.
Note that these predefined hooks are sometimes too conservative in the inputs they accept (your templates may be using a different extension) so pre-commit explicitly allows you to override any of these pre-defined options. See the pre-commit docs for additional configuration
∞ Default Django example
repos:
- repo: https://github.com/Riverside-Healthcare/djLint
rev: v1.19.13
hooks:
- id: djlint-django
∞ Handlebars with .html extension instead of .hbs
repos:
- repo: https://github.com/Riverside-Healthcare/djLint
rev: v1.19.13
hooks:
- id: djlint-handlebars
files: "\\.html"
types_or: ['html']
You can use the files
or exclude
parameters to constrain each hook to its own directory, allowing you to support multiple template languages within the same repo.
∞ SublimeText Linter
djLint can be used as a SublimeText Linter plugin. It can be installed via package-control.
cmd + shift + p
- Install SublimeLinter
- Install SublimeLinter-contrib-djlint
Ensure djLint is installed in your global python, or on your PATH
.
∞ Visual Studio Code
∞ neovim
djLint can use used as formatter in neovim using the null-ls
plugin.
∞ coc.nvim
∞ null-ls.nvim
∞ MegaLinter
djlint is natively embedded within the 100+ linters of MegaLinter
To install it, just run npx mega-linter-runner --install
and follow instructions
Edit this page Updated Jan 9, 2023