Configuration

La configuration se fait soit à travers le fichier pyproject.toml de votre projet, soit à travers un fichier .djlintrc. Les arguments de la ligne de commande remplaceront toujours les paramètres du fichier pyproject.toml. Les paramètres locaux du projet prévaudront toujours sur les fichiers de configuration globaux.

Le format du fichier pyproject.toml est toml.

[tool.djlint]
<options de configuration>

Le format du fichier djlintrc est json.

{
  "option": "valeur"
}

Options


blank_line_after_tag

formatter

Ajout d’une ligne vide supplémentaire après les groupes de balises {% <tag> ... %}.

blank_line_after_tag="load,extends,include"
"blank_line_after_tag": "load,extends,include"
--blank-line-after-tag "load,extends,include"

blank_line_before_tag

formatter

Ajoute une ligne blanche supplémentaire avant les groupes de balises {% <tag> ... %}. Les lignes vides ne seront jamais ajoutées au début du fichier ou entre des balises similaires.

blank_line_before_tag="load,extends,include"
"blank_line_before_tag": "load,extends,include"
--blank-line-before-tag "load,extends,include"

close_void_tags

formatter

Fermer les étiquettes vides.

close_void_tags=true
"close_void_tags": true
--close-void-tags

custom_blocks

formatter

Sert à indenter les blocs de code personnalisés. Par exemple {% toc %}...{% endtoc %}

custom_blocks="toc,example"
"custom_blocks": "toc,example"
--custom-blocks "toc,example"

custom_html

formatter

Permet d’indenter les balises HTML personnalisées. Par exemple, <mjml> ou <simple-greeting> ou <mj-\\w+>.

custom_html="mjml,simple-greeting,mj-\w+"
"custom_html": "mjml,simple-greeting,mj-\w+"
--custom_html "mjml,simple-greeting,mj-\\w+"

exclude

linterformatter

Remplacer les chemins d’exclusion par défaut.

exclude=".venv,venv,.tox,.eggs,..."
"exclude": ".venv,venv,.tox,.eggs,..."
--exclude ".venv,venv,.tox,.eggs,..."

extend_exclude

linterformatter

Ajouter des chemins supplémentaires à l’exclusion par défaut.

extend_exclude=".custom"
"extend_exclude": ".custom"
--extend-exclude ".custom"

extension

linterformatter

Permet de trouver uniquement les fichiers ayant une extension spécifique.

extension="html.dj"
"extension": "html.dj"
--extension "html.dj"
# or
-e "html.dj"

files

linterformatter

Une liste de chemins à utiliser comme source de djlint. Lorsque cette option est spécifiée, la source de la ligne de commande doit être - comme si vous utilisiez stdin.

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

format_attribute_template_tags

formatter

Le formateur tentera de formater la syntaxe des modèles à l’intérieur des attributs des balises. Désactivé par défaut.

format_attribute_template_tags=true
"format_attribute_template_tags": true
--format-attribute-template-tags

format_css

formatter

Formate le contenu des balises script en utilisant css-beautify. Voir css-beautify pour toutes les options de configuration. La syntaxe des modèles n’est pas [entièrement prise en charge] (https://github.com/beautify-web/js-beautify/issues) dans pris en charge.

[tool.djlint]
format_css=true

[tool.djlint.css]
indent_size=5
"format_css": true
"css": {
        "indent_size": 5
    }
--format-css --indent-css 5

format_js

formatter

Formate le contenu des balises script en utilisant js-beautify. Voir js-beautify pour toutes les options de configuration. La syntaxe des modèles n’est pas [entièrement prise en charge] (https://github.com/beautify-web/js-beautify/issues) dans pris en charge.

[tool.djlint]
format_js=true

[tool.djlint.js]
indent_size=5
"format_js": true
"js": {
        "indent_size": 5
    }
--format-js --indent-js 5

ignore

linter

Ignore les codes de linter.

ignore="H014,H015"
"ignore": "H014,H015"
--ignore "H014,H015"

ignore_blocks

formatter

Permet d’ignorer l’indentation des enfants des balises de modèle. Les enfants seront traités comme des frères et sœurs et indentés en conséquence.

ignore_blocks="raw,example"
"ignore_blocks": "raw,example"
--ignore-blocks "raw,example"

ignore_case

formatter

N’essayez pas de corriger la casse des balises html connues.

[tool.djlint]
ignore_case=true
"ignore_case": true
--ignore_case

include

linter

Inclure les codes des liners.

include="H014,H015"
"include": "H014,H015"
--include "H014,H015"

indent

formatter

Permet de modifier l’indentation du code. La valeur par défaut est 4 (quatre espaces).

indent=3
"indent": "3"
--indent 3

line_break_after_multiline_tag

formatter

Ne pas condenser le contenu des balises multilignes dans la ligne du dernier attribut.

line_break_after_multiline_tag=true
"line_break_after_multiline_tag": "true"
--line-break-after-multiline-tag

linter_output_format

linter

Personnalise l’ordre du message de sortie. Défaut=“{code} {ligne} {message} {match}”. Si {filename} n’est pas inclus dans le message, alors la sortie sera groupée par fichier et un en-tête sera automatiquement ajouté à chaque groupe.

Optional variables:

  • {filename}
  • {line}
  • {code}
  • {message}
  • {match}

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

max_attribute_length

formatter

Le formateur tentera d’envelopper les attributs de la balise si la longueur de l’attribut dépasse cette valeur.

max_attribute_length=10
"max_attribute_length": "10"
--max-attribute-length 10

max_blank_lines

formatter

Consolider les lignes vierges en les ramenant à x lignes. La valeur par défaut est 0, ce qui signifie que les lignes vierges seront supprimées.

max_blank_lines=5
"max_blank_lines": 5
--max_blank_lines 5

max_line_length

formatter

Le formateur essaiera de mettre certaines balises html et template sur une seule ligne au lieu de les envelopper si la longueur de la ligne ne dépasse pas cette valeur.

max_line_length=120
"max_line_length": "120"
--max_line_length 120

no_function_formatting

formatter

Ne pas tenter de formater le contenu de la fonction. ** Si vous utilisez cette option, veuillez ouvrir un problème gh en expliquant ce qui vous a poussé à l’utiliser.

no_function_formatting=true
"no_function_formatting": true
--no-function-formatting

no_line_after_yaml

formatter

N’ajoutez pas de ligne vierge après la matière première yaml.

no_line_after_yaml=true
"no_line_after_yaml": true
--no-line-after-yaml

no_set_formatting

formatter

Ne pas tenter de formater le contenu du jeu. ** Si vous utilisez cette option, veuillez ouvrir un problème gh en expliquant ce qui vous a poussé à l’utiliser

no_set_formatting=true
"no_set_formatting": true
--no-set-formatting

per_file_ignores

linter

Ignorer les règles de linter sur une base par fichier.

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

preserve_blank_lines

formatter

Préserve les blancs lorsque cela est possible. Idéal pour les fichiers de modèles non-html où les lignes vides sont intentionnelles.

preserve_blank_lines=true
"preserve_blank_lines": true
--preserve_blank_lines

preserve_leading_space

formatter

Préserve l’espace de tête du texte, dans la mesure du possible. Idéal pour les fichiers de modèles non-html où l’indentation du texte est intentionnelle.

preserve_leading_space=true
"preserve_leading_space": true
--preserve_leading_space

profile

linterformatter

Définissez un profil pour la langue du modèle. Le profil activera les règles de linter qui s’appliquent à votre langage de modèle, et peut également changer le reformatage. Par exemple, dans handlebars, il n’y a pas d’espaces dans les balises {{#if}}.

Options:

  • html (default)
  • django
  • jinja
  • nunjucks (for nunjucks and twig)
  • handlebars (for handlebars and mustache)
  • golang
  • angular

profile="django"
"profile": "django"
--profile "django"

quiet

formatterlinter

N’imprimez pas de différences lors du reformatage.

--quiet

require_pragma

formatter

Ne formatez ou ne limez que les fichiers qui commencent par un commentaire contenant uniquement le texte ‘djlint:on’. Le commentaire peut être un commentaire HTML ou un commentaire dans le langage de modèle défini par le paramètre de profil. Si aucun profil n’est spécifié, un commentaire dans l’un des langages de modèle est accepté.

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

require_pragma=true
"require_pragma": true
--require_pragma

use_gitignore

linterformatter

Ajouter les exclusions .gitignore à l’exclusion par défaut.

use_gitignore=true
"use_gitignore": true
--use_gitignore

version

formatterlinter

Afficher la version et quitter.

--version

warn

formatterlinter

Renvoyer les erreurs sous forme d’avertissements.

--warn
Modifier cette page Actualisé Oct 31, 2024