2.9 KiB
| description | title | keywords |
|---|---|---|
| Integrate djLint with your favorite editor. Auto format your templates with Pre-Commit. Lint with SublimeText. | Integrations | template linter, template formatter, djLint, HTML, templates, formatter, linter, integrations |
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):
::: content
djlint-djangofor Django templates: This will look for files matchingtemplates/**.htmland set--profile=django.djlint-jinjaThis will look for files matching*.j2and set--profile=jinja.djlint-nunjucksThis will look for files matching*.njkand set--profile=nunjucks.djlint-handlebarsThis will look for files matching*.hbsand set--profile=handlebars.djlint-golangThis will look for files matching*.tmpland 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: 0.5.10 # grab latest tag from GitHub
hooks:
- id: djlint-django
Handlebars with .html extension instead of .hbs
repos:
- repo: https://github.com/Riverside-Healthcare/djLint
rev: 0.5.10 # grab latest tag from GitHub
hooks:
- id: djlint-handlebars
files: "\\.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.
::: content
cmd + shift + p- Install SublimeLinter
- Install SublimeLinter-contrib-djlint :::
Ensure djLint is installed in your global python, or on your PATH.
Visual Studio Code
::: content
neovim
djLint can use used as formatter in neovim using the null-ls plugin.
::: content
coc.nvim
::: content
- npm package :::