Salta ai contenuti

Configurazione

La configurazione va nel pyproject.toml del progetto, in un djlint.toml o .djlint.toml, oppure in un .djlintrc. Le opzioni della riga di comando hanno la precedenza sul file di configurazione, ma un flag può solo attivare un’opzione, quindi non può disattivare un’opzione che il file di configurazione attiva. Le impostazioni del progetto hanno la precedenza su un file di configurazione globale indicato con --configuration, a meno che non sia impostato --prefer-configuration.

djLint cerca questi file risalendo dal primo percorso che controlla (con -, dalla cartella di --stdin-filename, o dalla directory corrente se manca). Si ferma alla prima cartella che contiene un djlint.toml, un .djlint.toml, un .djlintrc, un .djlint_rules.yaml o un pyproject.toml con [tool.djlint], e non va mai oltre la radice di un repository (una cartella con una cartella o un file .git, o una cartella .hg). Un pyproject.toml senza impostazioni di djLint non la ferma, quindi un pacchetto di un monorepo con il proprio pyproject.toml riceve le impostazioni del repository. djLint legge solo la cartella in cui si ferma: [tool.djlint] nel suo pyproject.toml se la tabella imposta qualcosa, altrimenti il suo djlint.toml o .djlint.toml, altrimenti il suo .djlintrc, e avvisa di quelli presenti lì che non legge.

Quando né la riga di comando né la configurazione impostano indent o max_line_length, djLint prende indent_size o max_line_length dai file .editorconfig, come fanno gli editor: ogni file li riceve in base al proprio percorso, vince il .editorconfig più vicino e quelli sopra completano il resto, fino a uno con root = true o alla radice del progetto.

Il formato di pyproject.toml è toml.

[tool.djlint]
profile = "django"
ignore = ["H014", "H015"]

Il formato di djlint.toml e .djlint.toml è toml.

profile = "django"
ignore = ["H014", "H015"]

Il formato di .djlintrc è json.

{ "profile": "django", "ignore": ["H014", "H015"] }

Le opzioni con più valori, come ignore, accettano una lista. Va bene anche una stringa separata da virgole, come "H014,H015", che è quella che serve a djLint prima della 1.41.

Dalla versione 1.51, djLint avvisa di un’impostazione o di un codice di regola che non conosce e indica il più vicino che conosce.

allow_empty_input

dalla 1.44.0 formatter linter --allow-empty-input

Predefinito: false

Esce con 0 invece di 2 quando i percorsi indicati non corrispondono ad alcun file. I file trovati e poi esclusi da exclude, extend_exclude, use_gitignore o require_pragma escono già con 0.

allow_empty_input=true

blank_line_after_tag

dalla 0.4.2 formatter --blank-line-after-tag

Predefinito: nessuno

Tag di template da far seguire da una riga vuota, come load ed extends. Un gruppo di questi tag consecutivi ne riceve una dopo l’ultimo, e non ne viene aggiunta nessuna alla fine di un blocco.

blank_line_after_tag=["load", "extends", "include"]

blank_line_before_tag

dalla 1.8.0 formatter --blank-line-before-tag

Predefinito: nessuno

Tag di template da far precedere da una riga vuota, come load ed extends. Un gruppo di questi tag consecutivi ne riceve una prima del primo, e non ne viene aggiunta nessuna all’inizio di un file o di un blocco.

blank_line_before_tag=["load", "extends", "include"]

close_void_tags

dalla 1.26.0 formatter linter --close-void-tags

Predefinito: false

Chiude con una barra i tag void noti, così <img> diventa <img />. Con questa opzione non viene segnalata H018, che chiede il contrario.

close_void_tags=true

configuration

dalla 1.13.0 formatter linter --configuration

Un file di configurazione globale, un pyproject.toml, djlint.toml o .djlintrc, ad esempio uno nella tua cartella home. Il file di configurazione del progetto prevale quando entrambi impostano un’opzione, a meno che non sia attivo prefer_configuration.

Finestra del terminale
--configuration ~/.djlintrc

custom_blocks

dalla 0.3.5 formatter --custom-blocks

Predefinito: nessuno

Nomi dei blocchi di template personalizzati da indentare, ad esempio toc per {% toc %}...{% endtoc %}.

custom_blocks=["toc", "example"]

custom_html

dalla 0.7.0 formatter --custom-html

Predefinito: nessuno

Nomi dei tag HTML personalizzati da indentare, ad esempio mjml o simple-greeting. Un nome può essere un’espressione regolare, come mj-\w+.

custom_html=["mjml", "simple-greeting", 'mj-\w+']

exclude

dalla 0.4.0 linter formatter --exclude

Predefinito: "__pypackages__,_build,_site,.bzr,.direnv,.eggs,.git,.git-rewrite,.hg,.nox,.svn,.tox,.venv,build,dist,htmlcov,node_modules,site-packages,venv"

Percorsi da saltare, al posto dell’elenco predefinito. Ogni voce è un’espressione regolare confrontata con nomi interi di cartelle o file nel percorso relativo alla radice del progetto o alla cartella controllata, come vendor o templates/legacy, quindi *.min.html si scrive .*\.min\.html.

exclude=[".venv", "venv", "build"]

extend_exclude

dalla 0.4.0 linter formatter --extend-exclude

Predefinito: nessuno

Percorsi da saltare in aggiunta a exclude, o all’elenco predefinito se exclude non è impostato, come espressioni regolari simili a quelle di exclude.

extend_exclude=[".custom"]

extension

dalla 0.0.5 linter formatter --extension

Predefinito: "html"

Estensione dei file da cercare nelle cartelle. Accetta una sola estensione; un file indicato per nome viene controllato qualunque sia la sua estensione.

extension="html.dj"

files

dalla 1.14.0 linter formatter

Predefinito: nessuno

Percorsi da controllare al posto di quelli sulla riga di comando, dove in questo caso va indicato -, come per stdin. Con --stdin-filename, - indica comunque stdin.

[tool.djlint]
files=["index.html"]

format_attribute_js_json

dalla 1.37.0 formatter --format-attribute-js-json

Predefinito: false

Formatta anche JavaScript e JSON negli attributi come onclick e x-data, quelli indicati da format_attribute_js_json_pattern. Un oggetto con meno proprietà di format_attribute_js_json_min_props resta su una sola riga.

format_attribute_js_json=true

format_attribute_js_json_min_props

dalla 1.37.0 formatter --format-attribute-js-json-min-props

Predefinito: 2

Formatta un oggetto solo se ha almeno questo numero di proprietà. Uno con meno proprietà resta su una sola riga.

format_attribute_js_json_min_props=3

format_attribute_js_json_pattern

dalla 1.37.0 formatter --format-attribute-js-json-pattern

Predefinito: "^(?:on[a-z]+|x-[a-z\\-]+|@[a-z\\-]+|:[a-z\\-]+|v-[a-z\\-]+|\\([a-z\\-]+\\)|\\[[a-z\\-]+\\]|\\*ng[A-Z][a-zA-Z]*|[a-z\\-]+\\.(bind|delegate|call|trigger))$"

Regex per i nomi degli attributi da formattare come JavaScript o JSON. Quella predefinita copre i gestori di eventi on* e i binding di Alpine, Vue, Angular e Aurelia.

format_attribute_js_json_pattern="^(on[a-z]+|data-[a-z-]+|x-[a-z-]+)$"

format_attribute_template_tags

dalla 0.6.7 formatter --format-attribute-template-tags

Predefinito: false

Formatta la sintassi di template all’interno degli attributi dei tag.

format_attribute_template_tags=true

format_css

dalla 1.9.0 formatter --format-css

Predefinito: false

Formatta anche il contenuto dei tag <style>, con css-beautify. La sintassi di template al loro interno non è pienamente supportata.

indent_size nella tabella css, oppure --indent-css sulla riga di comando, imposta l’indentazione all’interno dei tag <style>, 4 per impostazione predefinita. La tabella accetta anche le altre opzioni di css-beautify.

[tool.djlint]
format_css=true
[tool.djlint.css]
indent_size=5

format_js

dalla 1.9.0 formatter --format-js

Predefinito: false

Formatta anche JavaScript e JSON nei tag <script>, con js-beautify. Uno script il cui type non è né JavaScript né JSON, come un template lato client in text/template, resta com’è. La sintassi di template al loro interno non è pienamente supportata.

indent_size nella tabella js, oppure --indent-js sulla riga di comando, imposta l’indentazione all’interno dei tag <script>, 4 per impostazione predefinita. La tabella accetta anche le altre opzioni di js-beautify.

[tool.djlint]
format_js=true
[tool.djlint.js]
indent_size=5

github_output

dalla 1.37.0 formatter linter --github-output

Predefinito: nessuno

Stampa i risultati come annotazioni di GitHub Actions. È attivo per impostazione predefinita all’interno di GitHub Actions e --no-github-output lo disattiva. Vedi GitHub Actions.

Finestra del terminale
--github-output

ignore

dalla 0.1.5 linter --ignore

Predefinito: nessuno

Codici del linter da saltare.

ignore=["H014", "H015"]

ignore_blocks

dalla 1.24.0 formatter --ignore-blocks

Predefinito: nessuno

Blocchi di template che non indentano il proprio contenuto. I figli vengono trattati come fratelli del blocco e indentati di conseguenza.

ignore_blocks=["raw", "example"]

ignore_case

dalla 1.23.0 formatter linter --ignore-case

Predefinito: false

Non corregge maiuscole e minuscole dei tag HTML noti. Con questa opzione H009 e H010 non vengono segnalate.

[tool.djlint]
ignore_case=true

include

dalla 1.20.0 linter --include

Predefinito: nessuno

Codici del linter da attivare, anche se disattivati per impostazione predefinita o esclusi dal profilo.

include=["H014", "H015"]

indent

dalla 0.3.5 formatter --indent

Predefinito: 4

Spazi per livello di indentazione. Se non è impostato, djLint prende l’indent_size che .editorconfig assegna al file, se presente.

indent=3

keep_br_inline

dalla 1.45.0 formatter --keep-br-inline

Predefinito: false

Mantiene <br> sulla riga del testo che interrompe, invece di metterlo su una riga a sé. <hr>, che viene reso come una linea sotto il contenuto che lo precede, non è interessato.

keep_br_inline=true

line_break_after_multiline_tag

dalla 1.27.0 formatter --line-break-after-multiline-tag

Predefinito: false

Quando gli attributi di un tag sono distribuiti su più righe, inizia il suo contenuto su una nuova riga.

line_break_after_multiline_tag=true

linter_output_format

dalla 0.6.7 linter --linter-output-format

Predefinito: "{code} {line} {message} {match}"

La disposizione di ogni messaggio del linter, composta da {filename}, {line}, {end}, {code}, {message} e {match}. Senza {filename}, l’output viene raggruppato per file e ogni gruppo riceve un’intestazione.

linter_output_format="{filename}:{line}: {code} {message} {match}"

max_attribute_length

dalla 0.5.8 formatter --max-attribute-length

Predefinito: 70

Quando gli attributi di un tag superano questa lunghezza, il formattatore li distribuisce su più righe.

max_attribute_length=10

max_blank_lines

dalla 1.31.0 formatter --max-blank-lines

Predefinito: 0

Mantiene al massimo questo numero di righe vuote consecutive, quindi 0 le rimuove. Non ha effetto con preserve_blank_lines.

max_blank_lines=5

max_line_length

dalla 0.5.7 formatter --max-line-length

Predefinito: 120

Il formattatore unisce alcuni tag HTML e di template su una sola riga solo se la riga rientra in questa lunghezza. Se non è impostato, djLint prende il max_line_length che .editorconfig assegna al file, se presente.

max_line_length=100

name_endblocks

dalla 1.45.0 formatter --name-endblocks

Predefinito: false

Scrive il nome del blocco nell’{% endblock %} che lo chiude, quando il blocco è scritto su più righe. È ciò che richiede T003.

name_endblocks=true

no_entity_formatting

dalla 1.45.0 formatter --no-entity-formatting

Predefinito: false

Non riscrive un riferimento a entità come il carattere che indica, quindi &copy; resta com’è scritto invece di diventare ©. Le entità con un ruolo sintattico e quelle invisibili non vengono mai riscritte in nessun caso. Con questa opzione H023 continua a segnalare le entità; aggiungi H023 a ignore per mantenere le entità.

no_entity_formatting=true

no_function_formatting

dalla 1.30.2 formatter --no-function-formatting

Predefinito: false

Non formatta gli argomenti delle chiamate di funzione all’interno di {{ }}.

no_function_formatting=true

no_indent_inner_html

dalla 1.45.0 formatter --no-indent-inner-html

Predefinito: false

Non indenta <head> e <body> all’interno di <html>, che è il modo in cui il formattatore HTML integrato di VS Code dispone un documento.

no_indent_inner_html=true

no_line_after_yaml

dalla 1.29.0 formatter --no-line-after-yaml

Predefinito: false

Non aggiunge una riga vuota dopo il front matter YAML.

no_line_after_yaml=true

no_set_formatting

dalla 1.30.2 formatter --no-set-formatting

Predefinito: false

Non formatta il contenuto dei tag {% set %}.

no_set_formatting=true

per_file_ignores

dalla 1.7.0 linter --per-file-ignores

Predefinito: nessuno

Codici del linter da saltare nei file il cui percorso corrisponde a un’espressione regolare. In un file di configurazione la chiave è per-file-ignores, con i trattini.

[tool.djlint.per-file-ignores]
"file.html"= "H026,H025"
"file_two.html"="H001"

prefer_configuration

dalla 1.45.0 formatter linter --prefer-configuration

Predefinito: false

Fa sì che il file indicato da --configuration abbia la precedenza sul file di configurazione del progetto, che per impostazione predefinita prevale quando entrambi impostano la stessa opzione. Solo da riga di comando, perché decide come vengono letti i file di configurazione stessi.

Finestra del terminale
--prefer-configuration

preserve_blank_lines

dalla 1.3.0 formatter --preserve-blank-lines

Predefinito: false

Conserva, dove possibile, le righe vuote. Utile per i template non HTML, in cui le righe vuote sono intenzionali.

preserve_blank_lines=true

preserve_class_newlines

dalla 1.39.0 formatter --preserve-class-newlines

Predefinito: false

Conserva gli a capo negli attributi class scritti su più righe.

preserve_class_newlines=true

preserve_leading_space

dalla 1.2.0 formatter --preserve-leading-space

Predefinito: false

Conserva, dove possibile, gli spazi iniziali delle righe di testo. Utile per i template non HTML, in cui l’indentazione del testo è intenzionale.

preserve_leading_space=true

profile

dalla 0.4.5 linter formatter --profile

Predefinito: nessuno

Il linguaggio di template. Decide quali regole del linter vengono eseguite e come viene formattata la sintassi di template: in handlebars, ad esempio, non ci sono spazi all’interno dei tag {{#if}}.

Senza profilo, djLint formatta la sintassi di tutti i linguaggi di template, come fa all, e il linter usa le regole di html.

Opzioni:

  • html
  • django
  • jinja
  • nunjucks (per nunjucks e twig)
  • handlebars (per handlebars e mustache)
  • liquid (shopify, jekyll, eleventy)
  • golang (template go; hugo, helm)
  • angular
  • tera (anche per zola; usa jinja per minijinja)
  • askama (template in stile jinja in rust; le espressioni rust non vengono mai riformattate)
  • mako (le righe di controllo e i commenti ## restano come sono)
  • all (tutti i linguaggi di template insieme)
profile="django"

quiet

dalla 0.0.9 formatter linter --quiet

Predefinito: false

Non stampa i diff, la barra di avanzamento né il riepilogo.

quiet=true

quote_style

dalla 1.45.0 formatter linter --quote-style

Predefinito: "double"

Virgolette da usare per le stringhe all’interno dei tag di template: double o single. T002 richiede le stesse virgolette e il formattatore le usa nelle condizioni come {% if x == "a" %}, così in uno stesso file la stessa stringa non viene scritta in due modi. Le virgolette degli attributi HTML sono lasciate a H008.

quote_style="single"

require_pragma

dalla 0.5.8 formatter linter --require-pragma

Predefinito: false

Formatta o analizza solo i file che iniziano con un commento djlint:on. Può essere un commento HTML o un commento nel linguaggio di template indicato da profile e, senza profilo, in uno qualsiasi di essi.

<!-- djlint:on -->
{# djlint:on #}
{% comment %} djlint:on {% endcomment %}
{{ /* djlint:on */ }}
{{!-- djlint:on --}}
require_pragma=true

rules

dalla 1.41.0 formatter linter --rules

Un file di regole personalizzate nel formato .djlint_rules.yaml, letto al posto di quello nella radice del progetto.

Finestra del terminale
--rules ../shared/.djlint_rules.yaml

sarif

dalla 1.46.0 formatter linter --sarif

Predefinito: false

Stampa le segnalazioni come documento SARIF 2.1.0, per il code scanning di GitHub e altri strumenti. Vedi GitHub Actions.

Finestra del terminale
--sarif

single_attribute_per_line

dalla 1.40.0 formatter --single-attribute-per-line

Predefinito: false

Quando un tag di apertura va a capo, mette il nome del tag, ogni attributo e la parentesi di chiusura su righe separate.

single_attribute_per_line=true

sort_attributes

dalla 1.45.0 formatter --sort-attributes

Predefinito: false

Ordina gli attributi per nome, con id per primo e class per secondo. Un tag i cui attributi sono condizionati da un tag di template mantiene l’ordine in cui è stato scritto, perché spostarne uno fuori dal suo ramo cambierebbe la pagina.

sort_attributes=true

sort_load_tags

dalla 1.47.0 formatter --sort-load-tags

Predefinito: false

Ordina le librerie nei tag {% load %} ed elimina quelle scritte due volte, così {% load static i18n %} diventa {% load i18n static %}. In {% load a b from library %} vengono ordinati i nomi prima di from. Quando due librerie definiscono un tag o un filtro con lo stesso nome, prevale quella caricata per ultima, quindi l’ordinamento può cambiare quale dei due usa il template.

sort_load_tags=true

statistics

dalla 1.16.0 linter --statistics

Predefinito: false

Dopo il lint, stampa quante volte è stato trovato ogni codice.

Finestra del terminale
--statistics

stdin_filename

dalla 1.43.0 formatter linter --stdin-filename

Predefinito: "-"

Percorso che rappresenta stdin nei messaggi e nel confronto con exclude e per-file-ignores.

Finestra del terminale
--stdin-filename templates/index.html

use_gitignore

dalla 0.5.9 linter formatter --use-gitignore

Predefinito: false

Salta anche i percorsi elencati nel .gitignore della radice del progetto.

use_gitignore=true

version

dalla 0.3.9 formatter linter --version

Mostra la versione ed esce.

Finestra del terminale
--version

warn

dalla 0.7.6 formatter linter --warn

Predefinito: false

Esce con 0 invece di 1 quando ci sono errori del linter o file da riformattare.

Finestra del terminale
--warn