Configuración
La configuración va en el pyproject.toml de tu proyecto, en un djlint.toml o .djlint.toml, o en un .djlintrc. Las opciones de la línea de comandos prevalecen sobre el archivo de configuración, pero una opción solo puede activar algo, así que no puede desactivar un interruptor que activa el archivo de configuración. Los ajustes del proyecto prevalecen sobre un archivo de configuración global indicado con --configuration, salvo que se use --prefer-configuration.
djLint busca estos archivos hacia arriba a partir de la primera ruta que revisa (con -, desde la carpeta de --stdin-filename, o desde el directorio actual si no se indica). Se detiene en la primera carpeta que contiene un djlint.toml, un .djlint.toml, un .djlintrc, un .djlint_rules.yaml o un pyproject.toml con [tool.djlint], y nunca pasa de la raíz de un repositorio (una carpeta con una carpeta o un archivo .git, o una carpeta .hg). Un pyproject.toml sin ajustes de djLint no la detiene, así que un paquete de un monorepo con su propio pyproject.toml recibe los ajustes del repositorio. djLint solo lee la carpeta donde se detiene: [tool.djlint] en su pyproject.toml si esa tabla define algo; si no, su djlint.toml o .djlint.toml; si no, su .djlintrc, y avisa de los que hay ahí y no lee.
Cuando ni la línea de comandos ni la configuración fijan indent o max_line_length, djLint toma indent_size o max_line_length de los archivos .editorconfig, como hacen los editores: cada archivo los recibe según su propia ruta, gana el .editorconfig más cercano y los de más arriba completan lo que falta, hasta uno con root = true o la raíz del proyecto.
El formato de pyproject.toml es toml.
[tool.djlint]profile = "django"ignore = ["H014", "H015"]El formato de djlint.toml y .djlint.toml es toml.
profile = "django"ignore = ["H014", "H015"]El formato de .djlintrc es json.
{ "profile": "django", "ignore": ["H014", "H015"] }Las opciones con varios valores, como ignore, aceptan una lista. También vale una cadena separada por comas, como "H014,H015", que es lo que necesita djLint antes de la 1.41.
Desde la versión 1.51, djLint avisa de un ajuste o un código de regla que no conoce y propone el más parecido que sí conoce.
Opciones
Sección titulada «Opciones»No se encontró nada. Prueba con otra búsqueda.
allow_empty_input
Valor predeterminado: false
Sale con 0 en lugar de 2 cuando las rutas indicadas no coinciden con ningún archivo. Los archivos que se encontraron y luego se omitieron por exclude, extend_exclude, use_gitignore o require_pragma ya salen con 0.
allow_empty_input=trueallow_empty_input=true"allow_empty_input": true--allow-empty-inputblank_line_after_tag
Valor predeterminado: ninguno
Etiquetas de plantilla tras las que se añade una línea en blanco, como load y extends. Un grupo de ellas seguidas recibe una después de la última, y nunca se añade al final de un bloque.
blank_line_after_tag=["load", "extends", "include"]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
Valor predeterminado: ninguno
Etiquetas de plantilla antes de las que se añade una línea en blanco, como load y extends. Un grupo de ellas seguidas recibe una antes de la primera, y nunca se añade al principio de un archivo o de un bloque.
blank_line_before_tag=["load", "extends", "include"]blank_line_before_tag=["load", "extends", "include"]"blank_line_before_tag": ["load", "extends", "include"]--blank-line-before-tag "load,extends,include"close_void_tags
Valor predeterminado: false
Cierra con una barra las etiquetas vacías conocidas, de modo que <img> se convierte en <img />. H018, que pide lo contrario, no se notifica con esta opción.
close_void_tags=trueclose_void_tags=true"close_void_tags": true--close-void-tagsconfiguration
Un archivo de configuración global, un pyproject.toml, djlint.toml o .djlintrc, como uno en tu carpeta personal. El propio archivo de configuración del proyecto gana cuando ambos definen una opción, salvo que prefer_configuration esté activado.
--configuration ~/.djlintrccustom_blocks
Valor predeterminado: ninguno
Nombres de los bloques de plantilla personalizados que se indentan, por ejemplo toc para {% toc %}...{% endtoc %}.
custom_blocks=["toc", "example"]custom_blocks=["toc", "example"]"custom_blocks": ["toc", "example"]--custom-blocks "toc,example"custom_html
Valor predeterminado: ninguno
Nombres de las etiquetas HTML personalizadas que se indentan, por ejemplo mjml o simple-greeting. Un nombre puede ser una expresión regular, como mj-\w+.
custom_html=["mjml", "simple-greeting", 'mj-\w+']custom_html=["mjml", "simple-greeting", 'mj-\w+']"custom_html": ["mjml", "simple-greeting", "mj-\\w+"]--custom-html "mjml,simple-greeting,mj-\w+"exclude
Valor predeterminado: "__pypackages__,
Rutas que se omiten, en lugar de la lista por defecto. Cada entrada es una expresión regular que se compara con nombres completos de carpetas o archivos en la ruta relativa a la raíz del proyecto o a la carpeta que se revisa, como vendor o templates/legacy, así que *.min.html se escribe .*\.min\.html.
exclude=[".venv", "venv", "build"]exclude=[".venv", "venv", "build"]"exclude": [".venv", "venv", "build"]--exclude ".venv,venv,build"extend_exclude
Valor predeterminado: ninguno
Rutas que se omiten además de exclude, o de la lista por defecto si exclude no está definido, como expresiones regulares iguales a las de exclude.
extend_exclude=[".custom"]extend_exclude=[".custom"]"extend_exclude": [".custom"]--extend-exclude ".custom"extension
Valor predeterminado: "html"
Extensión de los archivos que se buscan en las carpetas. Admite una sola extensión; un archivo indicado por su nombre se comprueba sea cual sea su extensión.
extension="html.dj"extension="html.dj""extension": "html.dj"--extension "html.dj"# or-e "html.dj"files
Valor predeterminado: ninguno
Rutas que se comprueban en lugar de las de la línea de comandos, en cuyo caso la línea de comandos debe llevar -, como para stdin. Con --stdin-filename, - significa stdin en cualquier caso.
[tool.djlint]files=["index.html"]files=["index.html"]"files": [ "index.html"]index.htmlformat_attribute_js_json
Valor predeterminado: false
Formatea también el JavaScript y el JSON de atributos como onclick y x-data, los que indica format_attribute_js_json_pattern. Un objeto con menos propiedades que format_attribute_js_json_min_props se queda en una sola línea.
format_attribute_js_json=trueformat_attribute_js_json=true"format_attribute_js_json": true--format-attribute-js-jsonformat_attribute_js_json_min_props
Valor predeterminado: 2
Formatea un objeto solo si tiene al menos este número de propiedades. Uno con menos se queda en una sola línea.
format_attribute_js_json_min_props=3format_attribute_js_json_min_props=3"format_attribute_js_json_min_props": 3--format-attribute-js-json-min-props 3format_attribute_js_json_pattern
Valor predeterminado: "^(?:on[a-z]+|
Expresión regular para los nombres de los atributos que se formatean como JavaScript o JSON. La expresión por defecto abarca los manejadores de eventos on* y los bindings de Alpine, Vue, Angular y Aurelia.
format_attribute_js_json_pattern="^(on[a-z]+|data-[a-z-]+|x-[a-z-]+)$"format_attribute_js_json_pattern="^(on[a-z]+|data-[a-z-]+|x-[a-z-]+)$""format_attribute_js_json_pattern": "^(on[a-z]+|data-[a-z-]+|x-[a-z-]+)$"--format-attribute-js-json-pattern "^(on[a-z]+|data-[a-z-]+|x-[a-z-]+)$"format_attribute_template_tags
Valor predeterminado: false
Formatea la sintaxis de plantilla dentro de los atributos de las etiquetas.
format_attribute_template_tags=trueformat_attribute_template_tags=true"format_attribute_template_tags": true--format-attribute-template-tagsformat_css
Valor predeterminado: false
Formatea también el contenido de las etiquetas <style>, con css-beautify. La sintaxis de plantilla dentro de ellas no es totalmente compatible.
indent_size en la tabla css, o --indent-css en la línea de comandos, define la indentación dentro de las etiquetas <style>, 4 por defecto. La tabla también admite las demás opciones de css-beautify.
[tool.djlint]format_css=true
[tool.djlint.css]indent_size=5format_css=true
[css]indent_size=5"format_css": true,"css": { "indent_size": 5 }--format-css --indent-css 5format_js
Valor predeterminado: false
Formatea también el JavaScript y el JSON de las etiquetas <script>, con js-beautify. Un script cuyo type no es JavaScript ni JSON, como una plantilla del lado del cliente en text/template, se deja tal cual. La sintaxis de plantilla dentro de ellas no es totalmente compatible.
indent_size en la tabla js, o --indent-js en la línea de comandos, define la indentación dentro de las etiquetas <script>, 4 por defecto. La tabla también admite las demás opciones de js-beautify.
[tool.djlint]format_js=true
[tool.djlint.js]indent_size=5format_js=true
[js]indent_size=5"format_js": true,"js": { "indent_size": 5 }--format-js --indent-js 5github_output
Valor predeterminado: ninguno
Imprime los resultados como anotaciones de GitHub Actions. Está activado por defecto dentro de GitHub Actions, y --no-github-output lo desactiva. Consulta GitHub Actions.
--github-outputignore
Valor predeterminado: ninguno
Códigos del linter que se omiten.
ignore=["H014", "H015"]ignore=["H014", "H015"]"ignore": ["H014", "H015"]--ignore "H014,H015"ignore_blocks
Valor predeterminado: ninguno
Bloques de plantilla que no añaden indentación a su contenido. Sus hijos se tratan como hermanos del bloque y se indentan en consecuencia.
ignore_blocks=["raw", "example"]ignore_blocks=["raw", "example"]"ignore_blocks": ["raw", "example"]--ignore-blocks "raw,example"ignore_case
Valor predeterminado: false
No corrige las mayúsculas y minúsculas de las etiquetas HTML conocidas. H009 y H010 no se notifican con esta opción.
[tool.djlint]ignore_case=trueignore_case=true"ignore_case": true--ignore-caseinclude
Valor predeterminado: ninguno
Códigos del linter que se activan, aunque estén desactivados por defecto o el perfil los deje fuera.
include=["H014", "H015"]include=["H014", "H015"]"include": ["H014", "H015"]--include "H014,H015"indent
Valor predeterminado: 4
Espacios por nivel de indentación. Si no se define, djLint toma el indent_size que .editorconfig asigna al archivo, si lo hay.
indent=3indent=3"indent": 3--indent 3keep_br_inline
Valor predeterminado: false
Mantiene <br> en la línea del texto que corta, en lugar de darle una línea propia. <hr>, que se renderiza como una línea horizontal bajo el contenido anterior, no se ve afectado.
keep_br_inline=truekeep_br_inline=true"keep_br_inline": true--keep-br-inlineline_break_after_multiline_tag
Valor predeterminado: false
Cuando los atributos de una etiqueta ocupan varias líneas, empieza su contenido en una línea nueva.
line_break_after_multiline_tag=trueline_break_after_multiline_tag=true"line_break_after_multiline_tag": true--line-break-after-multiline-taglinter_output_format
Valor predeterminado: "{code} {line} {message} {match}"
El formato de cada mensaje del linter, a partir de {filename}, {line}, {end}, {code}, {message} y {match}. Sin {filename}, la salida se agrupa por archivo y cada grupo lleva una cabecera.
linter_output_format="{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
Valor predeterminado: 70
Cuando los atributos de una etiqueta superan esta longitud, el formateador los reparte en varias líneas.
max_attribute_length=10max_attribute_length=10"max_attribute_length": 10--max-attribute-length 10max_blank_lines
Valor predeterminado: 0
Conserva como máximo este número de líneas en blanco seguidas, así que 0 las elimina. No tiene efecto con preserve_blank_lines.
max_blank_lines=5max_blank_lines=5"max_blank_lines": 5--max-blank-lines 5max_line_length
Valor predeterminado: 120
El formateador junta algunas etiquetas HTML y de plantilla en una sola línea solo si la línea cabe en esta longitud. Si no se define, djLint toma el max_line_length que .editorconfig asigna al archivo, si lo hay.
max_line_length=100max_line_length=100"max_line_length": 100--max-line-length 100name_endblocks
Valor predeterminado: false
Escribe el nombre del bloque en el {% endblock %} que lo cierra, cuando el bloque ocupa varias líneas. Es lo que pide T003.
name_endblocks=truename_endblocks=true"name_endblocks": true--name-endblocksno_entity_formatting
Valor predeterminado: false
No reescribe una referencia de entidad como el carácter que nombra, así que © se deja tal como está escrito en lugar de convertirse en ©. Las entidades con función sintáctica, y las invisibles, nunca se reescriben en ningún caso. H023 sigue notificando las entidades con esta opción; añade H023 a ignore para conservarlas.
no_entity_formatting=trueno_entity_formatting=true"no_entity_formatting": true--no-entity-formattingno_function_formatting
Valor predeterminado: false
No formatea los argumentos de las llamadas a funciones dentro de {{ }}.
no_function_formatting=trueno_function_formatting=true"no_function_formatting": true--no-function-formattingno_indent_inner_html
Valor predeterminado: false
No indenta <head> ni <body> dentro de <html>, que es como el formateador HTML integrado de VS Code organiza un documento.
no_indent_inner_html=trueno_indent_inner_html=true"no_indent_inner_html": true--no-indent-inner-htmlno_line_after_yaml
Valor predeterminado: false
No añade una línea en blanco después del front matter de YAML.
no_line_after_yaml=trueno_line_after_yaml=true"no_line_after_yaml": true--no-line-after-yamlno_set_formatting
Valor predeterminado: false
No formatea el contenido de las etiquetas {% set %}.
no_set_formatting=trueno_set_formatting=true"no_set_formatting": true--no-set-formattingper_file_ignores
Valor predeterminado: ninguno
Códigos del linter que se omiten en los archivos cuya ruta coincide con una expresión regular. En un archivo de configuración, la clave es per-file-ignores, con guiones.
[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", "file_two.html":"H001" }--per-file-ignores "file.html" "H026,H025" --per-file-ignores "file_two.html" "H001"prefer_configuration
Valor predeterminado: false
Hace que el archivo indicado por --configuration prevalezca sobre el propio archivo de configuración del proyecto, que gana por defecto cuando ambos definen la misma opción. Solo en la línea de comandos, ya que decide cómo se leen los propios archivos de configuración.
--prefer-configurationpreserve_blank_lines
Valor predeterminado: false
Conserva las líneas en blanco cuando es posible. Útil para plantillas que no son HTML, donde las líneas en blanco son intencionadas.
preserve_blank_lines=truepreserve_blank_lines=true"preserve_blank_lines": true--preserve-blank-linespreserve_class_newlines
Valor predeterminado: false
Conserva los saltos de línea de los atributos class escritos en varias líneas.
preserve_class_newlines=truepreserve_class_newlines=true"preserve_class_newlines": true--preserve-class-newlinespreserve_leading_space
Valor predeterminado: false
Conserva los espacios iniciales de las líneas de texto cuando es posible. Útil para plantillas que no son HTML, donde la sangría del texto es intencionada.
preserve_leading_space=truepreserve_leading_space=true"preserve_leading_space": true--preserve-leading-spaceprofile
Valor predeterminado: ninguno
El lenguaje de plantillas. Decide qué reglas del linter se ejecutan y cómo se formatea la sintaxis de plantillas: en handlebars, por ejemplo, no hay espacios dentro de las etiquetas {{#if}}.
Sin perfil, djLint formatea la sintaxis de todos los lenguajes de plantillas, como hace all, y el linter usa las reglas de html.
Opciones:
- html
- django
- jinja
- nunjucks (para nunjucks y twig)
- handlebars (para handlebars y mustache)
- liquid (shopify, jekyll, eleventy)
- golang (plantillas de go; hugo, helm)
- angular
- tera (también para zola; usa jinja para minijinja)
- askama (plantillas de estilo jinja en rust; las expresiones de rust nunca se reformatean)
- mako (las líneas de control y los comentarios
##se dejan tal cual) - all (todos los lenguajes de plantillas a la vez)
profile="django"profile="django""profile": "django"--profile "django"quiet
Valor predeterminado: false
No imprime los diffs, la barra de progreso ni el resumen.
quiet=truequiet=true"quiet": true--quietquote_style
Valor predeterminado: "double"
Comillas que se usan en las cadenas dentro de las etiquetas de plantilla: double o single. T002 pide las mismas comillas, y el formateador las usa en condiciones como {% if x == "a" %}, para que un mismo archivo no escriba la misma cadena de dos formas. El entrecomillado de los atributos HTML se deja a H008.
quote_style="single"quote_style="single""quote_style": "single"--quote-style singlerequire_pragma
Valor predeterminado: false
Solo formatea o analiza los archivos que empiezan con un comentario djlint:on. Puede ser un comentario HTML o uno del lenguaje de plantillas indicado en profile y, sin perfil, uno de cualquiera de ellos.
<!-- djlint:on -->{# djlint:on #}{% comment %} djlint:on {% endcomment %}{{ /* djlint:on */ }}{{!-- djlint:on --}}require_pragma=truerequire_pragma=true"require_pragma": true--require-pragmarules
Un archivo de reglas personalizadas en el formato de .djlint_rules.yaml, que se lee en lugar del de la raíz del proyecto.
--rules ../shared/.djlint_rules.yamlsarif
Valor predeterminado: false
Imprime los problemas como un documento SARIF 2.1.0, para el escaneo de código de GitHub y otras herramientas. Consulta GitHub Actions.
--sarifsingle_attribute_per_line
Valor predeterminado: false
Cuando una etiqueta de apertura se parte en varias líneas, pone el nombre de la etiqueta, cada atributo y el corchete angular de cierre en líneas separadas.
single_attribute_per_line=truesingle_attribute_per_line=true"single_attribute_per_line": true--single-attribute-per-linesort_attributes
Valor predeterminado: false
Ordena los atributos por nombre, con id primero y class segundo. Una etiqueta cuyos atributos están condicionados por una etiqueta de plantilla conserva el orden en que se escribió, ya que sacar un atributo de su rama cambiaría la página.
sort_attributes=truesort_attributes=true"sort_attributes": true--sort-attributessort_load_tags
Valor predeterminado: false
Ordena las bibliotecas de las etiquetas {% load %} y quita las que están escritas dos veces, de modo que {% load static i18n %} se convierte en {% load i18n static %}. En {% load a b from library %} se ordenan los nombres que van antes de from. Cuando dos bibliotecas definen una etiqueta o un filtro con el mismo nombre, prevalece la que se carga en último lugar, así que ordenarlas puede cambiar cuál usa la plantilla.
sort_load_tags=truesort_load_tags=true"sort_load_tags": true--sort-load-tagsstatistics
Valor predeterminado: false
Después del análisis, imprime cuántas veces se encontró cada código.
--statisticsstdin_filename
Valor predeterminado: "-"
Ruta que representa a stdin en los mensajes y al comparar con exclude y per-file-ignores.
--stdin-filename templates/index.htmluse_gitignore
Valor predeterminado: false
Omite también las rutas que indica el .gitignore de la raíz del proyecto.
use_gitignore=trueuse_gitignore=true"use_gitignore": true--use-gitignoreversion
Muestra la versión y sale.
--versionwarn
Valor predeterminado: false
Sale con 0 en lugar de 1 cuando hay errores del linter o archivos por reformatear.
--warn