djlint 1.28.0 → 1.30.0

package/tests/test_config/test_profile/html.html

@@ -0,0 +1,2 @@
+<a href="/path"></a>
+{{test}}

package/tests/test_config/test_profile/pyproject.toml

@@ -0,0 +1,3 @@
+[tool]
+[tool.djlint]
+profile = "django"

package/tests/test_config/test_profile/test_config.py

@@ -0,0 +1,64 @@
+"""Djlint tests specific to pyproject.toml configuration.
+
+run::
+
+   pytest tests/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_profile(runner: CliRunner) -> None:
+    result = runner.invoke(djlint, ["tests/test_config/test_profile/html.html"])
+
+    assert "T001" in result.output
+    assert "J018" not in result.output
+    assert "D018" in result.output
+
+    result = runner.invoke(
+        djlint, ["tests/test_config/test_profile/html.html", "--profile", "jinja"]
+    )
+    assert "T001" in result.output
+    assert "J018" in result.output
+    assert "D018" not in result.output
+
+    result = runner.invoke(
+        djlint, ["tests/test_config/test_profile/html.html", "--profile", "handlebars"]
+    )
+    assert "T001" not in result.output
+    assert "J018" not in result.output
+    assert "D018" not in result.output
+
+    result = runner.invoke(
+        djlint,
+        [
+            "tests/test_config/test_profile/html.html",
+            "--check",
+            "--profile",
+            "handlebars",
+        ],
+    )
+
+    assert result.exit_code == 0
+
+    result = runner.invoke(
+        djlint,
+        ["tests/test_config/test_profile/html.html", "--check", "--profile", "jinja"],
+    )
+    assert result.exit_code == 1
+    assert (
+        """-{{test}}
++{{ test }}"""
+        in result.output
+    )

package/tests/test_config/test_pyproject/pyproject.toml

@@ -0,0 +1,36 @@
+[tool.djlint]
+exclude = "foo/excluded.html"
+extend_exclude = "excluded.html"
+blank_line_after_tag="load,extends,include"
+blank_line_before_tag="load,extends,include"
+custom_blocks="toc,example"
+custom_html="mjml,simple-greeting,mj-\\w+"
+extension="html.dj"
+files=["index.html"]
+format_attribute_template_tags=true
+format_css=true
+format_js=true
+ignore="H014,H015"
+ignore_blocks="raw,example"
+ignore_case=true
+include="H014,H015"
+indent=3
+linter_output_format="{code} {message} {match} {filename}:{line}"
+max_attribute_length=10
+max_line_length=120
+preserve_blank_lines=true
+preserve_leading_space=true
+profile="django"
+require_pragma=true
+use_gitignore=true
+
+
+[tool.djlint.js]
+indent_size=5
+
+[tool.djlint.css]
+indent_size=5
+
+[tool.djlint.per-file-ignores]
+"file.html"= "H026,H025"
+"file_two.html"="H001"

package/tests/test_config/test_pyproject/test_config.py

@@ -0,0 +1,44 @@
+"""Test pyproject.toml config.
+
+poetry run pytest tests/test_config/test_pyproject
+
+"""
+from pathlib import Path
+
+from src.djlint.settings import Config
+
+
+def test_profile() -> None:
+    config = Config(str(Path(__file__) / "blank.html"))
+
+    assert config.exclude == "foo/excluded.html | excluded.html"
+    assert config.blank_line_after_tag == "load,extends,include"
+    assert config.blank_line_before_tag == "load,extends,include"
+    assert config.custom_blocks == r"|endexample\b|endtoc\b|example\b|toc\b"
+    assert config.custom_html == r"|mjml|simple-greeting|mj-\w+"
+    assert config.extension == "html.dj"
+    assert config.files == ["index.html"]
+    assert config.format_attribute_template_tags is True
+    assert config.format_css is True
+    assert config.format_js is True
+    assert config.ignore == "H014,H015"
+    assert config.ignore_blocks == r"endexample\b|endraw\b|example\b|raw\b"
+    assert config.ignore_case is True
+    assert config.include == "H014,H015"
+    assert config.indent == 3 * " "
+    assert config.linter_output_format == "{code} {message} {match} {filename}:{line}"
+    assert config.max_attribute_length == 10
+    assert config.max_line_length == 120
+    assert config.preserve_blank_lines is True
+    assert config.preserve_leading_space is True
+    assert config.profile == "django"
+    assert config.require_pragma is True
+    assert config.use_gitignore is True
+
+    assert config.js_config == {"indent_size": 5}
+    assert config.css_config == {"indent_size": 5}
+
+    assert config.per_file_ignores == {
+        "file.html": "H026,H025",
+        "file_two.html": "H001",
+    }

package/tests/test_django/test_asset.py

@@ -0,0 +1,32 @@
+"""Test django asset tag.
+
+poetry run pytest tests/test_django/test_asset.py
+"""
+import pytest
+
+from src.djlint.reformat import formatter
+from tests.conftest import printer
+
+test_data = [
+    pytest.param(
+        (
+            '{% block css %}{% assets "css_error" %}<link type="text/css" rel="stylesheet" href="{{ ASSET_URL }}" />{% endassets %}{% endblock css %}'
+        ),
+        (
+            "{% block css %}\n"
+            '    {% assets "css_error" %}\n'
+            '        <link type="text/css" rel="stylesheet" href="{{ ASSET_URL }}" />\n'
+            "    {% endassets %}\n"
+            "{% endblock css %}\n"
+        ),
+        id="asset_tag",
+    ),
+]
+
+
+@pytest.mark.parametrize(("source", "expected"), test_data)
+def test_base(source, expected, django_config):
+    output = formatter(django_config, source)
+
+    printer(expected, source, output)
+    assert expected == output

package/tests/test_django/test_autoescape.py

@@ -0,0 +1,25 @@
+"""Test django autoescape tag.
+
+poetry run pytest tests/test_django/test_autoescape.py
+"""
+
+import pytest
+
+from src.djlint.reformat import formatter
+from tests.conftest import printer
+
+test_data = [
+    pytest.param(
+        ("{% autoescape on %}{{ body }}{% endautoescape %}"),
+        ("{% autoescape on %}\n" "    {{ body }}\n" "{% endautoescape %}\n"),
+        id="autoescape_tag",
+    )
+]
+
+
+@pytest.mark.parametrize(("source", "expected"), test_data)
+def test_base(source, expected, django_config):
+    output = formatter(django_config, source)
+
+    printer(expected, source, output)
+    assert expected == output

package/tests/test_django/test_block.py

@@ -0,0 +1,29 @@
+"""Test django block tag.
+
+poetry run pytest tests/test_django/test_block.py
+"""
+
+import pytest
+
+from src.djlint.reformat import formatter
+from tests.conftest import printer
+
+test_data = [
+    pytest.param(
+        ("{% block content %}{% block scripts %}{% endblock %}{% endblock %}"),
+        (
+            "{% block content %}\n"
+            "    {% block scripts %}{% endblock %}\n"
+            "{% endblock %}\n"
+        ),
+        id="asset_tag",
+    ),
+]
+
+
+@pytest.mark.parametrize(("source", "expected"), test_data)
+def test_base(source, expected, django_config):
+    output = formatter(django_config, source)
+
+    printer(expected, source, output)
+    assert expected == output

package/tests/test_django/test_blocktrans.py

@@ -0,0 +1,236 @@
+"""Test django blocktrans(late) tag.
+
+poetry run pytest tests/test_django/test_blocktrans.py
+
+blocktrans/late contents cannot be touched.
+
+leading tag can be indented, but not trailing tag.
+
+---
+
+blocktrans/late "trimmed" can be fully formatted and are in separate tests
+
+"""
+import pytest
+
+from src.djlint.reformat import formatter
+from tests.conftest import printer
+
+test_data = [
+    pytest.param(
+        ("{% blocktranslate %} The width is: {{ width }}{% endblocktranslate %}"),
+        ("{% blocktranslate %} The width is: {{ width }}{% endblocktranslate %}\n"),
+        id="blocktranslate_no_attr",
+    ),
+    pytest.param(
+        ("{% blocktranslate  %}The width is: {{ width }} {% endblocktranslate %}"),
+        ("{% blocktranslate  %}The width is: {{ width }} {% endblocktranslate %}\n"),
+        id="blocktranslate_with_attr",
+    ),
+    pytest.param(
+        ("{% blocktrans %} The width is: {{ width }}{% endblocktrans %}"),
+        ("{% blocktrans %} The width is: {{ width }}{% endblocktrans %}\n"),
+        id="blocktrans_no_attr",
+    ),
+    pytest.param(
+        ("{% blocktrans  %}The width is: {{ width }} {% endblocktrans %}"),
+        ("{% blocktrans  %}The width is: {{ width }} {% endblocktrans %}\n"),
+        id="blocktrans_with_attr",
+    ),
+    pytest.param(
+        (
+            "<p>\n"
+            "    {% blocktrans %}If you have not created an account yet, then please\n"
+            '    <a href="{{ signup_url }}">sign up</a> first.{% endblocktrans %}\n'
+            "</p>\n"
+            "<p>\n"
+            "    {% blocktrans %}   If you have not created an account yet, then please\n"
+            '    <a href="{{ signup_url }}">sign up</a> first.   {% endblocktrans %}\n'
+            "</p>\n"
+        ),
+        (
+            "<p>\n"
+            "    {% blocktrans %}If you have not created an account yet, then please\n"
+            '    <a href="{{ signup_url }}">sign up</a> first.{% endblocktrans %}\n'
+            "</p>\n"
+            "<p>\n"
+            "    {% blocktrans %}   If you have not created an account yet, then please\n"
+            '    <a href="{{ signup_url }}">sign up</a> first.   {% endblocktrans %}\n'
+            "</p>\n"
+        ),
+        id="blocktrans_with_nested_tags",
+    ),
+    pytest.param(
+        (
+            "<div>\n"
+            '     {% translate "View all" %}\n'
+            "    <br />\n"
+            "     ({% blocktranslate count counter=images|length  %}\n"
+            "            {{ counter }} photo\n"
+            "            {% plural %}\n"
+            "            {{ counter }} photos\n"
+            "{% endblocktranslate %})\n"
+            "     ({% blocktrans count counter=images|length  %}\n"
+            "            {{ counter }} photo\n"
+            "            {% plural %}\n"
+            "            {{ counter }} photos\n"
+            " {% endblocktrans %})\n"
+            "</div>\n"
+        ),
+        (
+            "<div>\n"
+            '    {% translate "View all" %}\n'
+            "    <br />\n"
+            "    ({% blocktranslate count counter=images|length  %}\n"
+            "            {{ counter }} photo\n"
+            "            {% plural %}\n"
+            "            {{ counter }} photos\n"
+            "{% endblocktranslate %})\n"
+            "    ({% blocktrans count counter=images|length  %}\n"
+            "            {{ counter }} photo\n"
+            "            {% plural %}\n"
+            "            {{ counter }} photos\n"
+            " {% endblocktrans %})\n"
+            "</div>\n"
+        ),
+        id="blocktrans_indent",
+    ),
+    pytest.param(
+        (
+            "<div>\n"
+            '    {% translate "View all" %}\n'
+            "    <br />\n"
+            "   ({% blocktranslate count counter=images|length  %}\n"
+            "            {{ counter }} photo\n"
+            "            {% plural %}\n"
+            "asdf\n"
+            "            {{ counter }} photos\n"
+            "     {% endblocktranslate %})\n"
+            "    ({% blocktrans count counter=images|length  %}\n"
+            "            {{ counter }} photo\n"
+            "           {% plural %}\n"
+            "            {{ counter }} photos\n"
+            "   {% endblocktrans %})\n"
+            "</div>\n"
+        ),
+        (
+            "<div>\n"
+            '    {% translate "View all" %}\n'
+            "    <br />\n"
+            "    ({% blocktranslate count counter=images|length  %}\n"
+            "            {{ counter }} photo\n"
+            "            {% plural %}\n"
+            "asdf\n"
+            "            {{ counter }} photos\n"
+            "     {% endblocktranslate %})\n"
+            "    ({% blocktrans count counter=images|length  %}\n"
+            "            {{ counter }} photo\n"
+            "           {% plural %}\n"
+            "            {{ counter }} photos\n"
+            "   {% endblocktrans %})\n"
+            "</div>\n"
+        ),
+        id="blocktrans_indent_2",
+    ),
+    pytest.param(
+        (
+            "<tr>\n"
+            "    {% if status.stage.value == 0 %}\n"
+            "        {% blocktranslate with obj=status.scanned_objects %}{{ obj }} objects scanned{% endblocktranslate %}\n"
+            "          {% elif status.stage.value == 2 %}\n"
+            "        {% blocktranslate with obj=status.scanned_objects %}        {{ obj }} objects scanned {% endblocktranslate %}\n"
+            "    {% endif %}\n"
+            "</tr>\n"
+        ),
+        (
+            "<tr>\n"
+            "    {% if status.stage.value == 0 %}\n"
+            "        {% blocktranslate with obj=status.scanned_objects %}{{ obj }} objects scanned{% endblocktranslate %}\n"
+            "    {% elif status.stage.value == 2 %}\n"
+            "        {% blocktranslate with obj=status.scanned_objects %}        {{ obj }} objects scanned {% endblocktranslate %}\n"
+            "    {% endif %}\n"
+            "</tr>\n"
+        ),
+        id="blocktrans_indent_if",
+    ),
+    pytest.param(
+        (
+            "<tr>\n"
+            "    {% if status.stage.value == 0 %}\n"
+            "        {% blocktranslate with obj=status.scanned_objects %}{{ obj }} objects scanned {% endblocktranslate %}\n"
+            "          {% elif status.stage.value == 2 %}\n"
+            "        {% blocktranslate with obj=status.scanned_objects %} {{ obj }} objects scanned{% endblocktranslate %}\n"
+            "    {% endif %}\n"
+            "</tr>\n"
+        ),
+        (
+            "<tr>\n"
+            "    {% if status.stage.value == 0 %}\n"
+            "        {% blocktranslate with obj=status.scanned_objects %}{{ obj }} objects scanned {% endblocktranslate %}\n"
+            "    {% elif status.stage.value == 2 %}\n"
+            "        {% blocktranslate with obj=status.scanned_objects %} {{ obj }} objects scanned{% endblocktranslate %}\n"
+            "    {% endif %}\n"
+            "</tr>\n"
+        ),
+        id="blocktrans_indent_if_2",
+    ),
+    pytest.param(
+        ("<p>{% trans 'Please do <b>Blah</b>.' %}</p>\n"),
+        ("<p>\n" "    {% trans 'Please do <b>Blah</b>.' %}\n" "</p>\n"),
+        id="blocktrans_indent_3",
+    ),
+    pytest.param(
+        (
+            "{% autoescape off %}\n"
+            "\n"
+            "  {% blocktrans %}\n"
+            "  You're receiving this email because you requested a password reset for your user account at {{ site_name }}.\n"
+            "  {% endblocktrans %}\n"
+        ),
+        (
+            "{% autoescape off %}\n"
+            "    {% blocktrans %}\n"
+            "  You're receiving this email because you requested a password reset for your user account at {{ site_name }}.\n"
+            "  {% endblocktrans %}\n"
+        ),
+        id="blocktrans_autoescape",
+    ),
+    pytest.param(
+        (
+            "{% autoescape off %}\n"
+            "    {% blocktrans %}\n"
+            "  You're receiving this email because you requested a password reset for your user account at {{ site_name }}.\n"
+            "      {% endblocktrans %}\n"
+        ),
+        (
+            "{% autoescape off %}\n"
+            "    {% blocktrans %}\n"
+            "  You're receiving this email because you requested a password reset for your user account at {{ site_name }}.\n"
+            "      {% endblocktrans %}\n"
+        ),
+        id="blocktrans_autoescape_two",
+    ),
+    pytest.param(
+        (
+            "{% blocktranslate count counter=list|length  %}\n"
+            "There is only one {{ name }} object.\n"
+            "  {% plural %}   There are {{ counter }} {{ name }} objects.\n"
+            "{% endblocktranslate %}\n"
+        ),
+        (
+            "{% blocktranslate count counter=list|length  %}\n"
+            "There is only one {{ name }} object.\n"
+            "  {% plural %}   There are {{ counter }} {{ name }} objects.\n"
+            "{% endblocktranslate %}\n"
+        ),
+        id="plural not formatted",
+    ),
+]
+
+
+@pytest.mark.parametrize(("source", "expected"), test_data)
+def test_base(source, expected, django_config):
+    output = formatter(django_config, source)
+
+    printer(expected, source, output)
+    assert expected == output