djlint 1.28.0 → 1.30.0

package/tests/test_config/test_max_attribute_length.py

@@ -0,0 +1,100 @@
+"""Test for max_attribute_length.
+
+--max-attribute-length 4
+
+poetry run pytest tests/test_config/test_max_attribute_length.py
+"""
+import pytest
+
+from src.djlint.reformat import formatter
+from tests.conftest import config_builder, printer
+
+test_data = [
+    pytest.param(
+        (
+            '<div required long attributenamesarereallycool class="asdf" data-attr="asdf" id="asdf" ></div>\n'
+            '<div class="my long classes" required="true"\n'
+            '    checked="checked"\n'
+            '    data-attr="some long junk"\n'
+            '    style="margin-left: 90px;\n'
+            "        display: contents;\n"
+            "       font-weight: bold;\n"
+            '       font-size: 1.5rem">\n'
+        ),
+        (
+            "<div required\n"
+            "     long\n"
+            "     attributenamesarereallycool\n"
+            '     class="asdf"\n'
+            '     data-attr="asdf"\n'
+            '     id="asdf">\n'
+            "</div>\n"
+            '<div class="my long classes"\n'
+            '     required="true"\n'
+            '     checked="checked"\n'
+            '     data-attr="some long junk"\n'
+            '     style="margin-left: 90px;\n'
+            "            display: contents;\n"
+            "            font-weight: bold;\n"
+            '            font-size: 1.5rem">\n'
+        ),
+        ({"max_attribute_length": 10, "max_line_length": 1}),
+        id="short lines",
+    ),
+    pytest.param(
+        (
+            '<div required long attributenamesarereallycool class="asdf" data-attr="asdf" id="asdf" ></div>\n'
+            '<div class="my long classes" required="true"\n'
+            '    checked="checked"\n'
+            '    data-attr="some long junk"\n'
+            '    style="margin-left: 90px;\n'
+            "        display: contents;\n"
+            "       font-weight: bold;\n"
+            '       font-size: 1.5rem">\n'
+        ),
+        (
+            "<div required\n"
+            "     long\n"
+            "     attributenamesarereallycool\n"
+            '     class="asdf"\n'
+            '     data-attr="asdf"\n'
+            '     id="asdf"></div>\n'
+            '<div class="my long classes"\n'
+            '     required="true"\n'
+            '     checked="checked"\n'
+            '     data-attr="some long junk"\n'
+            '     style="margin-left: 90px;\n'
+            "            display: contents;\n"
+            "            font-weight: bold;\n"
+            '            font-size: 1.5rem">\n'
+        ),
+        ({"max_attribute_length": 10, "max_line_length": 1000}),
+        id="longer lines",
+    ),
+    pytest.param(
+        (
+            '<div required long attributenamesarereallycool class="asdf" data-attr="asdf" id="asdf" ></div>\n'
+            '<div class="my long classes" required="true"\n'
+            '    checked="checked"\n'
+            '    data-attr="some long junk"\n'
+            '    style="margin-left: 90px;\n'
+            "        display: contents;\n"
+            "       font-weight: bold;\n"
+            '       font-size: 1.5rem">\n'
+        ),
+        (
+            '<div required long attributenamesarereallycool class="asdf" data-attr="asdf" id="asdf"></div>\n'
+            '<div class="my long classes" required="true" checked="checked" data-attr="some long junk" style="margin-left: 90px; display: contents; font-weight: bold; font-size: 1.5rem">\n'
+        ),
+        ({"max_attribute_length": 10000, "max_line_length": 1000}),
+        id="longest lines",
+    ),
+]
+
+
+@pytest.mark.parametrize(("source", "expected", "args"), test_data)
+def test_base(source, expected, args):
+    output = formatter(config_builder(args), source)
+
+    printer(expected, source, output)
+    assert expected == output

package/tests/test_config/test_max_line_length.py

@@ -0,0 +1,94 @@
+"""Test for max line length.
+
+--max-line-length 4
+
+poetry run pytest tests/test_config/test_max_line_length.py
+"""
+import pytest
+
+from src.djlint.reformat import formatter
+from tests.conftest import config_builder, printer
+
+test_data = [
+    pytest.param(
+        (
+            '<div required long attributenamesarereallycool class="asdf" data-attr="asdf" id="asdf" ></div>\n'
+            '<div class="my long classes" required="true"\n'
+            '    checked="checked"\n'
+            '    data-attr="some long junk"\n'
+            '    style="margin-left: 90px;\n'
+            "        display: contents;\n"
+            "       font-weight: bold;\n"
+            '       font-size: 1.5rem">\n'
+        ),
+        (
+            "<div required\n"
+            "     long\n"
+            "     attributenamesarereallycool\n"
+            '     class="asdf"\n'
+            '     data-attr="asdf"\n'
+            '     id="asdf">\n'
+            "</div>\n"
+            '<div class="my long classes"\n'
+            '     required="true"\n'
+            '     checked="checked"\n'
+            '     data-attr="some long junk"\n'
+            '     style="margin-left: 90px;\n'
+            "            display: contents;\n"
+            "            font-weight: bold;\n"
+            '            font-size: 1.5rem">\n'
+        ),
+        ({"max_line_length": 1}),
+        id="short lines",
+    ),
+    pytest.param(
+        (
+            '<div required long attributenamesarereallycool class="asdf" data-attr="asdf" id="asdf" ></div>\n'
+            '<div class="my long classes" required="true"\n'
+            '    checked="checked"\n'
+            '    data-attr="some long junk"\n'
+            '    style="margin-left: 90px;\n'
+            "        display: contents;\n"
+            "       font-weight: bold;\n"
+            '       font-size: 1.5rem">\n'
+        ),
+        (
+            "<div required\n"
+            "     long\n"
+            "     attributenamesarereallycool\n"
+            '     class="asdf"\n'
+            '     data-attr="asdf"\n'
+            '     id="asdf"></div>\n'
+            '<div class="my long classes"\n'
+            '     required="true"\n'
+            '     checked="checked"\n'
+            '     data-attr="some long junk"\n'
+            '     style="margin-left: 90px;\n'
+            "            display: contents;\n"
+            "            font-weight: bold;\n"
+            '            font-size: 1.5rem">\n'
+        ),
+        ({"max_line_length": 1000}),
+        id="longer lines",
+    ),
+    pytest.param(
+        ("<div></div>\n"),
+        ("<div></div>\n"),
+        ({"max_line_length": 12}),
+        id="twelve",
+    ),
+    pytest.param(
+        ("<div></div>\n"),
+        ("<div>\n" "</div>\n"),
+        ({"max_line_length": 11}),
+        id="eleven",
+    ),
+]
+
+
+@pytest.mark.parametrize(("source", "expected", "args"), test_data)
+def test_base(source, expected, args):
+    output = formatter(config_builder(args), source)
+
+    printer(expected, source, output)
+    assert expected == output

package/tests/test_config/test_per_file_ignores/html.html

@@ -0,0 +1,2 @@
+<div>
+    <div></div>

package/tests/test_config/test_per_file_ignores/pyproject.toml

@@ -0,0 +1,2 @@
+[tool.djlint.per-file-ignores]
+"html.html"= "H025"

package/tests/test_config/test_per_file_ignores/test_config.py

@@ -0,0 +1,25 @@
+"""Djlint tests specific to pyproject.toml configuration.
+
+run::
+
+   pytest tests/test_config/test_per_file_ignores/test_config.py --cov=src/djlint --cov-branch \
+          --cov-report xml:coverage.xml --cov-report term-missing
+
+for a single test, run::
+
+   pytest tests/test_config.py::test_custom_html --cov=src/djlint \
+     --cov-branch --cov-report xml:coverage.xml --cov-report term-missing
+
+"""
+# pylint: disable=C0116
+
+
+from click.testing import CliRunner
+
+from src.djlint import main as djlint
+
+
+def test_ignores(runner: CliRunner) -> None:
+    result = runner.invoke(djlint, ["tests/test_config/test_per_file_ignores"])
+    assert "H025" not in result.output
+    assert "H020" in result.output

package/tests/test_config/test_pragmas/html_five.html

@@ -0,0 +1,2 @@
+<!-- djlint:on -->
+{% extends "nothing.html" %}{% load stuff %}{% load stuff 2 %}{% include "html_two.html" %}<div></div>

package/tests/test_config/test_pragmas/html_four.html

@@ -0,0 +1,5 @@
+{{ /* djlint:on */ }}
+<h1>Test</h1><p>{{ .Variable }}</p>
+{{ range .Items }} <p>{{ . }}
+
+</p>{{ end }}

package/tests/test_config/test_pragmas/html_one.html

@@ -0,0 +1 @@
+{% extends "nothing.html" %}{% load stuff %}{% load stuff 2 %}{% include "html_two.html" %}<div></div>

package/tests/test_config/test_pragmas/html_six.html

@@ -0,0 +1,2 @@
+{% comment %} djlint:on {% endcomment %}
+{% extends "nothing.html" %}{% load stuff %}{% load stuff 2 %}{% include "html_two.html" %}<div></div>

package/tests/test_config/test_pragmas/html_three.html

@@ -0,0 +1,4 @@
+{{!-- djlint:on --}}
+<p>
+
+{{firstname}} </p><p>{{lastname}}</p>

package/tests/test_config/test_pragmas/html_two.html

@@ -0,0 +1,2 @@
+{# djlint:on #}
+{% extends "nothing.html" %}{% load stuff %}{% load stuff 2 %}{% include "html_two.html" %}<div></div>

package/tests/test_config/test_pragmas/pyproject.toml

@@ -0,0 +1,3 @@
+[tool]
+[tool.djlint]
+require_pragma=true

package/tests/test_config/test_pragmas/test_config.py

@@ -0,0 +1,142 @@
+"""Djlint tests specific to pyproject.toml configuration.
+
+run::
+
+   pytest tests/test_config/test_pragmas/test_config.py --cov=src/djlint --cov-branch \
+          --cov-report xml:coverage.xml --cov-report term-missing
+
+   pytest tests/test_config/test_pragmas/test_config.py::test_require_pragma
+
+"""
+# pylint: disable=C0116
+
+
+from click.testing import CliRunner
+
+from src.djlint import main as djlint
+
+
+def test_require_pragma(runner: CliRunner) -> None:
+    result = runner.invoke(
+        djlint,
+        [
+            "tests/test_config/test_pragmas/html_one.html",
+            "--lint",
+            "--check",
+            "--profile",
+            "django",
+        ],
+    )
+
+    assert """No files to check!""" in result.output
+    assert result.exit_code == 0
+
+    result = runner.invoke(
+        djlint,
+        [
+            "tests/test_config/test_pragmas/html_two.html",
+            "--check",
+            "--profile",
+            "django",
+        ],
+    )
+    assert (
+        """ {# djlint:on #}
+-{% extends "nothing.html" %}{% load stuff %}{% load stuff 2 %}{% include "html_two.html" %}<div></div>
++{% extends "nothing.html" %}
++{% load stuff %}
++{% load stuff 2 %}
++{% include "html_two.html" %}
++<div></div>"""
+        in result.output
+    )
+    assert """1 file would be updated.""" in result.output
+    assert result.exit_code == 1
+
+    result = runner.invoke(
+        djlint,
+        [
+            "tests/test_config/test_pragmas/html_three.html",
+            "--check",
+            "--profile",
+            "handlebars",
+        ],
+    )
+
+    assert (
+        """ {{!-- djlint:on --}}
+-<p>
+-
+-{{firstname}} </p><p>{{lastname}}</p>
++<p>{{firstname}}</p>
++<p>{{lastname}}</p>"""
+        in result.output
+    )
+    assert """1 file would be updated.""" in result.output
+    assert result.exit_code == 1
+
+    result = runner.invoke(
+        djlint,
+        [
+            "tests/test_config/test_pragmas/html_four.html",
+            "--check",
+            "--profile",
+            "golang",
+        ],
+    )
+
+    assert (
+        """ {{ /* djlint:on */ }}
+-<h1>Test</h1><p>{{ .Variable }}</p>
+-{{ range .Items }} <p>{{ . }}
+-
+-</p>{{ end }}
++<h1>Test</h1>
++<p>{{ .Variable }}</p>
++{{ range .Items }}
++<p>{{ . }}</p>
++{{ end }}
+
+1 file would be updated."""
+        in result.output
+    )
+    assert """1 file would be updated.""" in result.output
+    assert result.exit_code == 1
+
+    result = runner.invoke(
+        djlint, ["tests/test_config/test_pragmas/html_five.html", "--check"]
+    )
+    assert (
+        """ <!-- djlint:on -->
+-{% extends "nothing.html" %}{% load stuff %}{% load stuff 2 %}{% include "html_two.html" %}<div></div>
++{% extends "nothing.html" %}
++{% load stuff %}
++{% load stuff 2 %}
++{% include "html_two.html" %}
++<div></div>"""
+        in result.output
+    )
+    assert """1 file would be updated.""" in result.output
+    assert result.exit_code == 1
+
+    result = runner.invoke(
+        djlint,
+        [
+            "tests/test_config/test_pragmas/html_six.html",
+            "--check",
+            "--profile",
+            "django",
+        ],
+    )
+    assert (
+        """ {% comment %} djlint:on {% endcomment %}
+-{% extends "nothing.html" %}{% load stuff %}{% load stuff 2 %}{% include "html_two.html" %}<div></div>
++{% extends "nothing.html" %}
++{% load stuff %}
++{% load stuff 2 %}
++{% include "html_two.html" %}
++<div></div>"""
+        in result.output
+    )
+    assert """1 file would be updated.""" in result.output
+    assert result.exit_code == 1

package/tests/test_config/test_preserve_blank_lines.py

@@ -0,0 +1,109 @@
+"""Test for preserve blank lines.
+
+--preserve-blank-lines
+
+poetry run pytest tests/test_config/test_preserve_blank_lines.py
+"""
+import pytest
+
+from src.djlint.reformat import formatter
+from tests.conftest import config_builder, printer
+
+test_data = [
+    pytest.param(
+        (
+            "---\n"
+            "my:yaml\n"
+            "---\n"
+            "\n"
+            "\n"
+            "\n"
+            "\n"
+            "{% if   abc == 101 %}\n"
+            " interface Ethernet1/2\n"
+            "   description // Connected to leaf-2\n"
+            "   no switchport\n"
+            "   ip address 10.1.2.1/30\n"
+            "   ip router ospf 1 area 0.0.0.0\n"
+            "   no shutdown\n"
+            "{% endif %}\n"
+            "\n"
+            "\n"
+            "{% if abc == 102 %}\n"
+            " interface Ethernet1/2\n"
+            "   description // Connected to leaf-2\n"
+            "   no switchport\n"
+            "   ip address 10.1.2.1/30\n"
+            "   ip router ospf 1 area 0.0.0.0\n"
+            "   no shutdown\n"
+            "{% endif %}\n"
+            "\n"
+            "{% if abc == 103 %}\n"
+            " interface Ethernet1/2\n"
+            "   description // Connected to leaf-2\n"
+            "   no switchport\n"
+            "   ip address 10.1.2.1/30\n"
+            "   ip router ospf 1 area 0.0.0.0\n"
+            "   no shutdown\n"
+            "{% endif %}\n"
+        ),
+        (
+            "---\n"
+            "my:yaml\n"
+            "---\n"
+            "\n"
+            "\n"
+            "\n"
+            "\n"
+            "{% if   abc == 101 %}\n"
+            " interface Ethernet1/2\n"
+            "   description // Connected to leaf-2\n"
+            "   no switchport\n"
+            "   ip address 10.1.2.1/30\n"
+            "   ip router ospf 1 area 0.0.0.0\n"
+            "   no shutdown\n"
+            "{% endif %}\n"
+            "\n"
+            "\n"
+            "{% if abc == 102 %}\n"
+            " interface Ethernet1/2\n"
+            "   description // Connected to leaf-2\n"
+            "   no switchport\n"
+            "   ip address 10.1.2.1/30\n"
+            "   ip router ospf 1 area 0.0.0.0\n"
+            "   no shutdown\n"
+            "{% endif %}\n"
+            "\n"
+            "{% if abc == 103 %}\n"
+            " interface Ethernet1/2\n"
+            "   description // Connected to leaf-2\n"
+            "   no switchport\n"
+            "   ip address 10.1.2.1/30\n"
+            "   ip router ospf 1 area 0.0.0.0\n"
+            "   no shutdown\n"
+            "{% endif %}\n"
+        ),
+        ({"preserve_blank_lines": True, "preserve_leading_space": True}),
+        id="network stuff",
+    ),
+    pytest.param(
+        ("{% block someblock %}{% endblock %}\n" "<br />\n" "<br />\n"),
+        ("{% block someblock %}{% endblock %}\n" "<br />\n" "<br />\n"),
+        ({"preserve_blank_lines": True}),
+        id="whitespace test",
+    ),
+    pytest.param(
+        ("<div>"),
+        ("<div>\n"),
+        ({"preserve_blank_lines": True}),
+        id="whitespace test",
+    ),
+]
+
+
+@pytest.mark.parametrize(("source", "expected", "args"), test_data)
+def test_base(source, expected, args):
+    output = formatter(config_builder(args), source)
+
+    printer(expected, source, output)
+    assert expected == output

package/tests/test_config/test_preserve_leading_space.py

@@ -0,0 +1,159 @@
+"""Test for preserve leading space.
+
+--preserve-leading-space
+
+poetry run pytest tests/test_config/test_preserve_leading_space.py
+"""
+import pytest
+
+from src.djlint.reformat import formatter
+from tests.conftest import config_builder, printer
+
+test_data = [
+    pytest.param(
+        (
+            "---\n"
+            "my:yaml\n"
+            "---\n"
+            "\n"
+            "\n"
+            "\n"
+            "\n"
+            "{% if   abc == 101 %}\n"
+            " interface Ethernet1/2\n"
+            "   description // Connected to leaf-2\n"
+            "   no switchport\n"
+            "   ip address 10.1.2.1/30\n"
+            "   ip router ospf 1 area 0.0.0.0\n"
+            "   no shutdown\n"
+            "{% endif %}\n"
+            "\n"
+            "\n"
+            "{% if abc == 102 %}\n"
+            " interface Ethernet1/2\n"
+            "   description // Connected to leaf-2\n"
+            "   no switchport\n"
+            "   ip address 10.1.2.1/30\n"
+            "   ip router ospf 1 area 0.0.0.0\n"
+            "   no shutdown\n"
+            "{% endif %}\n"
+            "\n"
+            "{% if abc == 103 %}\n"
+            " interface Ethernet1/2\n"
+            "   description // Connected to leaf-2\n"
+            "   no switchport\n"
+            "     ip address 10.1.2.1/30\n"
+            "   ip router ospf 1 area 0.0.0.0\n"
+            "   no shutdown\n"
+            "{% endif %}\n"
+        ),
+        (
+            "---\n"
+            "my:yaml\n"
+            "---\n"
+            "\n"
+            "\n"
+            "\n"
+            "\n"
+            "{% if   abc == 101 %}\n"
+            " interface Ethernet1/2\n"
+            "   description // Connected to leaf-2\n"
+            "   no switchport\n"
+            "   ip address 10.1.2.1/30\n"
+            "   ip router ospf 1 area 0.0.0.0\n"
+            "   no shutdown\n"
+            "{% endif %}\n"
+            "\n"
+            "\n"
+            "{% if abc == 102 %}\n"
+            " interface Ethernet1/2\n"
+            "   description // Connected to leaf-2\n"
+            "   no switchport\n"
+            "   ip address 10.1.2.1/30\n"
+            "   ip router ospf 1 area 0.0.0.0\n"
+            "   no shutdown\n"
+            "{% endif %}\n"
+            "\n"
+            "{% if abc == 103 %}\n"
+            " interface Ethernet1/2\n"
+            "   description // Connected to leaf-2\n"
+            "   no switchport\n"
+            "     ip address 10.1.2.1/30\n"
+            "   ip router ospf 1 area 0.0.0.0\n"
+            "   no shutdown\n"
+            "{% endif %}\n"
+        ),
+        ({"preserve_blank_lines": True, "preserve_leading_space": True}),
+        id="network stuff",
+    ),
+    pytest.param(
+        (
+            "{% if   abc == 101 %}\n"
+            " interface Ethernet1/2\n"
+            "   description // Connected to leaf-2\n"
+            "   no switchport\n"
+            "   ip address 10.1.2.1/30\n"
+            "   ip router ospf 1 area 0.0.0.0\n"
+            "   no shutdown\n"
+            "{% endif %}\n"
+            "\n"
+            "\n"
+            " {% if abc == 102 %}\n"
+            " interface Ethernet1/2\n"
+            "   description // Connected to leaf-2\n"
+            "   no switchport\n"
+            "   ip address 10.1.2.1/30\n"
+            "   ip router ospf 1 area 0.0.0.0\n"
+            "   no shutdown\n"
+            "  {% endif %}\n"
+            "\n"
+            "{% if abc == 103 %}\n"
+            " interface Ethernet1/2\n"
+            "   description // Connected to leaf-2\n"
+            "   no switchport\n"
+            "   ip address 10.1.2.1/30\n"
+            "   ip router ospf 1 area 0.0.0.0\n"
+            "   no shutdown\n"
+            "            {% endif %}\n"
+        ),
+        (
+            "{% if   abc == 101 %}\n"
+            " interface Ethernet1/2\n"
+            "   description // Connected to leaf-2\n"
+            "   no switchport\n"
+            "   ip address 10.1.2.1/30\n"
+            "   ip router ospf 1 area 0.0.0.0\n"
+            "   no shutdown\n"
+            "{% endif %}\n"
+            "\n"
+            "\n"
+            "{% if abc == 102 %}\n"
+            " interface Ethernet1/2\n"
+            "   description // Connected to leaf-2\n"
+            "   no switchport\n"
+            "   ip address 10.1.2.1/30\n"
+            "   ip router ospf 1 area 0.0.0.0\n"
+            "   no shutdown\n"
+            "{% endif %}\n"
+            "\n"
+            "{% if abc == 103 %}\n"
+            " interface Ethernet1/2\n"
+            "   description // Connected to leaf-2\n"
+            "   no switchport\n"
+            "   ip address 10.1.2.1/30\n"
+            "   ip router ospf 1 area 0.0.0.0\n"
+            "   no shutdown\n"
+            "{% endif %}\n"
+        ),
+        ({"preserve_blank_lines": True, "preserve_leading_space": True}),
+        id="network stuff",
+    ),
+]
+
+
+@pytest.mark.parametrize(("source", "expected", "args"), test_data)
+def test_base(source, expected, args):
+    output = formatter(config_builder(args), source)
+
+    printer(expected, source, output)
+    assert expected == output