Per iniziare
Installazione
Sezione intitolata “Installazione”djLint è su PyPI, dove richiede Python 3.11 o successivo, e su npm, che porta con sé il proprio Python. In un progetto Python, aggiungilo con uv o pip. In un progetto JavaScript, come un’app Angular, un sito Eleventy o un tema Shopify, con npm.
Con uv, aggiungilo al progetto come dipendenza di sviluppo:
uv add --dev djlintOppure installalo come strumento autonomo:
uv tool install djlintpip install djlintIl pacchetto npm porta con sé il proprio Python, quindi gli basta Node.js 16.9 o più recente. Ci sono build per Linux su x64, Arm64, ppc64le, s390x e riscv64, macOS su x64 e Arm64 e Windows su x64, x86 e Arm64. Su Linux con musl, come Alpine, funziona su x64 e Arm64. Aggiungilo al progetto come dipendenza di sviluppo:
npm i -D djlintOppure installalo globalmente:
npm i -g djlintCon pipx:
pipx install djlintCon la formula Homebrew mantenuta dalla community, su macOS o Linux:
brew install djlintPer eseguire djLint nel tuo editor o a ogni commit, consulta Integrazioni e pre-commit.
Primo avvio
Sezione intitolata “Primo avvio”Passa a djLint la cartella dei template e imposta --profile sul tuo linguaggio di template. Il profilo decide quali regole del linter vengono eseguite e come viene formattata la sintassi dei template. Per un progetto Django:
Analizza i template (è la modalità predefinita, quindi puoi omettere --lint):
djlint templates --lint --profile=djangoGuarda cosa cambierebbe la formattazione. Con --check djLint mostra un diff e lascia i file come sono:
djlint templates --check --profile=djangoFormatta i file sul posto:
djlint templates --reformat --profile=djangoL’opzione profile elenca tutti i profili. Ogni linguaggio di template ha anche una pagina sua, per esempio Django, Jinja o Handlebars, che mostra come impostare il profilo in un file di configurazione, così non devi passarlo ogni volta.
Se hai aggiunto djLint al progetto con uv add --dev, si trova nell’ambiente del progetto: anteponi uv run ai comandi, ad esempio uv run djlint templates --lint --profile=django. Con npm i -D, anteponi invece npx, ad esempio npx djlint templates --lint --profile=django.
Percorso o stdin
Sezione intitolata “Percorso o stdin”djLint funziona con un percorso o con stdin.
Esecuzione con un percorso:
djlint /path/to/templates --lintOppure con un file specifico:
djlint /path/to/this.mustache --lintOppure con stdin:
echo "<div></div>" | djlint -Stdin si può usare anche per riformattare il codice. L’output conterrà solo il codice formattato, senza messaggi.
echo "<div></div>" | djlint - --reformatOutput:
<div></div>Quando legge da stdin, djLint non ha un percorso reale da confrontare con per-file-ignores o da mostrare nei messaggi, quindi usa - per impostazione predefinita. Passa --stdin-filename per indicare a djLint il percorso reale del contenuto ricevuto tramite pipe, ad esempio quando un’integrazione con l’editor gli passa il contenuto di un file al salvataggio.
echo "<div></div>" | djlint - --stdin-filename templates/index.htmlCodici di uscita
Sezione intitolata “Codici di uscita”| Codice | Significato |
|---|---|
0 |
Tutto ciò che djLint doveva controllare è pulito, oppure ogni file trovato è stato escluso dalla configurazione. |
1 |
djLint ha trovato errori di lint o file da riformattare. Con --warn vengono segnalati come avvisi e il codice di uscita è invece 0. |
2 |
djLint non ha controllato ciò che gli hai chiesto: i percorsi non corrispondevano a nessun file, un file non si poteva leggere (non UTF-8, o senza permessi), la riga di comando o la configurazione non erano valide, oppure djLint si è interrotto con un errore. |
Solo il codice 1 significa che djLint ha esaminato i tuoi template e ciò che ha trovato non gli è piaciuto, così una pipeline può distinguere un controllo fallito da un’esecuzione che non ha controllato nulla, come una con un percorso sbagliato o un --extension che non corrisponde più.
I file che djLint ha trovato e poi escluso di proposito, tramite exclude, extend_exclude, use_gitignore o require_pragma, non sono un errore, ed è questo che permette a exclude di funzionare con pre-commit. Se per la tua pipeline è normale un percorso senza template, disattiva il codice 2 con allow_empty_input:
djlint /path/to/templates --lint --allow-empty-inputUso da riga di comando
Sezione intitolata “Uso da riga di comando”Usage: djlint [OPTIONS] SRC ...
djLint · HTML template linter and formatter.
Modes: --lint Lint the files. This is the default when neither --reformat nor --check is given. --reformat Format the files in place. --check Show what formatting would change, without changing the files. --lsp Run as a language server over stdio, for editors.
Files: -e, --extension EXT Extension of the files to look for in folders. [default: html] --exclude PATHS Regexes of the paths to skip, comma-separated, in place of the default list. --extend-exclude PATHS Regexes of the paths to skip on top of the exclude list, comma-separated. --use-gitignore Also skip the paths that the .gitignore in the project root lists. --require-pragma Only format or lint files whose first line is a djlint:on comment. --stdin-filename PATH Path that stands for stdin in messages, excludes and per-file ignores. [default: -] --allow-empty-input Exit with 0 instead of 2 when the given paths match no files.
Configuration: --profile NAME Template language: html, django, jinja, nunjucks, handlebars, liquid, golang, angular, tera, askama, mako or all. It decides which linter rules run and how template syntax is formatted. Without one, formatting follows all and the linter runs the rules of html. --configuration FILE Global config file: a pyproject.toml, djlint.toml or .djlintrc. The project's own config file wins where both set an option. --prefer-configuration Let the --configuration file win over the project's own config file.
Linter: -i, --ignore CODES Linter codes to skip, comma-separated, for example H014,H017. --include CODES Linter codes to turn on, comma-separated, for example H017. Works for rules that are off by default and for rules the profile leaves out. --per-file-ignores <PATTERN CODES>... Skip linter codes in the files whose path matches a regex. Can be repeated. --rules FILE Custom linter rules, in the .djlint_rules.yaml format.
Output: --quiet Do not print diffs, the progress bar or the summary. --warn Exit with 0 instead of 1 when there are lint errors or files to reformat. --statistics After linting, print how many times each code was found. --linter-output-format FORMAT Layout of each lint message, from {filename}, {line}, {end}, {code}, {message} and {match}. [default: {code} {line} {message} {match}] --github-output / --no-github-output Print results as GitHub Actions annotations. On by default inside GitHub Actions. --sarif Print findings as a SARIF 2.1.0 JSON document, for GitHub code scanning and other tools.
Layout: --indent N Spaces per indent level. [default: 4, or indent_size from .editorconfig] --max-line-length N Join tags onto one line only when the line fits within this length. [default: 120, or max_line_length from .editorconfig] --max-attribute-length N Spread a tag's attributes over lines once they are longer than this. [default: 70] --single-attribute-per-line When an opening tag wraps, put each attribute on its own line. --line-break-after-multiline-tag When a tag's attributes are spread over lines, start its content on a new line. --no-indent-inner-html Do not indent <head> and <body> inside <html>. --keep-br-inline Keep <br> on the line of the text it breaks. --custom-blocks TAGS Names of the custom template blocks to indent, comma-separated, for example toc. --custom-html TAGS Names of the custom HTML tags to indent, comma-separated, for example mjml. --ignore-blocks TAGS Template blocks that do not indent their contents, comma-separated. --blank-line-after-tag TAGS Template tags to follow with a blank line, comma-separated, for example load,extends. --blank-line-before-tag TAGS Template tags to precede with a blank line, comma-separated, for example load,extends. --max-blank-lines N Keep at most this many blank lines in a row. Has no effect with --preserve-blank-lines. [default: 0] --preserve-blank-lines Keep blank lines where possible. --preserve-leading-space Keep the leading spaces of text lines where possible. --no-line-after-yaml Do not add a blank line after YAML front matter.
Rewrites: --close-void-tags Close void tags with a slash, so <img> becomes <img />. --ignore-case Do not fix the case of known HTML tags. --sort-attributes Sort attributes by name, with id first and class second. --sort-load-tags Sort the libraries in {% load %} tags and drop repeated ones. --name-endblocks Name the block in its {% endblock %} when the block spans lines. --quote-style [double|single] Quotes for strings inside template tags. [default: double] --no-entity-formatting Do not rewrite entity references such as © as the characters they name. --no-function-formatting Do not format the arguments of function calls inside {{ }}. --no-set-formatting Do not format the contents of {% set %} tags. --preserve-class-newlines Keep the line breaks in class attributes written across lines. --format-attribute-template-tags Format template syntax inside tag attributes.
CSS and JavaScript: --format-css Also format the contents of <style> tags, with css-beautify. --indent-css N Indent width inside <style> tags, for --format-css. [default: 4] --format-js Also format JavaScript and JSON in <script> tags, with js-beautify. --indent-js N Indent width inside <script> tags, for --format-js. [default: 4] --format-attribute-js-json Also format JavaScript and JSON in attributes such as onclick and x-data. --format-attribute-js-json-pattern REGEX Regex for the names of the attributes to format as JavaScript or JSON. [default: on* event handlers and Alpine, Vue, Angular and Aurelia bindings] --format-attribute-js-json-min-props N Format an object only when it has at least this many properties. [default: 2]
Other: --version Show the version and exit. -h, --help Show this message and exit.