djlint 1.28.0 → 1.30.0

package/tests/test_jinja/test_call.py

@@ -0,0 +1,34 @@
+"""Test jinja call tag.
+
+poetry run pytest tests/test_jinja/test_call.py
+"""
+import pytest
+
+from src.djlint.reformat import formatter
+from tests.conftest import printer
+
+test_data = [
+    pytest.param(
+        ("{% call 'cool' %}<div>some html</div>{% endcall %}"),
+        ("{% call 'cool' %}\n" "    <div>some html</div>\n" "{% endcall %}\n"),
+        id="call_tag",
+    ),
+    pytest.param(
+        ("{% call('cool') %}<div>some html</div>{% endcall %}"),
+        ("{% call('cool') %}\n" "    <div>some html</div>\n" "{% endcall %}\n"),
+        id="call_tag_with_function",
+    ),
+    pytest.param(
+        ("{% call (a, b) render_form(form, '<hr>'>) %}"),
+        ("{% call (a, b) render_form(form, '<hr>'>) %}\n"),
+        id="call_tag_with_nested_html",
+    ),
+]
+
+
+@pytest.mark.parametrize(("source", "expected"), test_data)
+def test_base(source, expected, jinja_config):
+    output = formatter(jinja_config, source)
+
+    printer(expected, source, output)
+    assert expected == output

package/tests/test_jinja/test_parenthesis.py

@@ -0,0 +1,24 @@
+"""Test jinja parenthesis.
+
+poetry run pytest tests/test_jinja/test_parenthesis.py
+"""
+import pytest
+
+from src.djlint.reformat import formatter
+from tests.conftest import printer
+
+test_data = [
+    pytest.param(
+        ("{{ url('foo')}}"),
+        ('{{ url("foo") }}\n'),
+        id="parenthesis_tag",
+    ),
+]
+
+
+@pytest.mark.parametrize(("source", "expected"), test_data)
+def test_base(source, expected, jinja_config):
+    output = formatter(jinja_config, source)
+
+    printer(expected, source, output)
+    assert expected == output

package/tests/test_linter/test_custom_rules/.djlint_rules.yaml

@@ -0,0 +1,6 @@
+- rule:
+    name: T001
+    message: Find Trichotillomania
+    flags: re.DOTALL|re.I
+    patterns:
+    - Trichotillomania

package/tests/test_linter/test_custom_rules/html.html

@@ -0,0 +1 @@
+This is trichotillomania.

package/tests/test_linter/test_custom_rules/pyproject.toml

@@ -0,0 +1 @@
+[tool]

package/tests/test_linter/test_custom_rules/test_linter.py

@@ -0,0 +1,29 @@
+"""Djlint tests specific to pyproject.toml configuration.
+
+run::
+
+   pytest tests/test_linter/test_custom_rules/test_linter.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_custom_rules(runner: CliRunner) -> None:
+    result = runner.invoke(
+        djlint, ["tests/test_linter/test_custom_rules/", "--profile", "django"]
+    )
+    assert """Linting""" in result.output
+    assert """1/1""" in result.output
+    assert """T001 1:""" in result.output
+    assert result.exit_code == 1

package/tests/test_linter/test_custom_rules_bad/.djlint_rules.yaml

@@ -0,0 +1,24 @@
+- rule:
+    name: T001
+    message: Find Trichotillomania
+    flags: re.DOTALL|re.I
+    patterns:
+    - Trichotillomania
+
+- rule:
+    name: T002
+    flags: re.DOTALL|re.I
+    patterns:
+    - Trichotillomania
+
+- rule:
+    name: T003
+    patterns:
+    - Trichotillomania
+
+- rule:
+    name: T004
+
+- rule:
+    patterns:
+    - Trichotillomania

package/tests/test_linter/test_custom_rules_bad/html.html

@@ -0,0 +1 @@
+This is trichotillomania.

package/tests/test_linter/test_custom_rules_bad/pyproject.toml

@@ -0,0 +1 @@
+[tool]

package/tests/test_linter/test_custom_rules_bad/test_linter.py

@@ -0,0 +1,29 @@
+"""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_custom_rules_bad_config(runner: CliRunner) -> None:
+    result = runner.invoke(
+        djlint, ["tests/test_linter/test_custom_rules_bad", "--profile", "django"]
+    )
+    assert """Linting""" in result.output
+    assert """1/1""" in result.output
+    assert """T001 1:""" in result.output
+    assert result.exit_code == 1

package/tests/test_linter/test_django_linter.py

@@ -0,0 +1,476 @@
+"""Djlint linter rule tests for django.
+
+poetry run pytest tests/test_linter/test_django_linter.py
+
+"""
+
+import pytest
+
+from src.djlint.lint import linter
+from tests.conftest import lint_printer
+
+test_data = [
+    pytest.param(
+        ("{{test }}\n{% test%}<a>"),
+        (
+            [
+                {
+                    "code": "T001",
+                    "line": "1:0",
+                    "match": "{{test",
+                    "message": "Variables should be wrapped in a single whitespace.",
+                },
+                {
+                    "code": "T001",
+                    "line": "2:3",
+                    "match": "test%}",
+                    "message": "Variables should be wrapped in a single whitespace.",
+                },
+                {
+                    "code": "H025",
+                    "line": "2:9",
+                    "match": "<a>",
+                    "message": "Tag seems to be an orphan.",
+                },
+            ]
+        ),
+        id="T001",
+    ),
+    pytest.param(
+        ("{% extends 'this' %}"),
+        (
+            [
+                {
+                    "code": "T002",
+                    "line": "1:0",
+                    "match": "{% extends 'this' %}",
+                    "message": "Double quotes should be used in tags.",
+                }
+            ]
+        ),
+        id="T002",
+    ),
+    pytest.param(
+        ("{% extends this %}"),
+        ([]),
+        id="T002_unquoted_var_names",
+    ),
+    pytest.param(
+        ("{% with a='this' %}"),
+        (
+            [
+                {
+                    "code": "T002",
+                    "line": "1:0",
+                    "match": "{% with a='this' %}",
+                    "message": "Double quotes should be used in tags.",
+                }
+            ]
+        ),
+        id="T002_with",
+    ),
+    pytest.param(
+        ("{% trans 'this' %}"),
+        (
+            [
+                {
+                    "code": "T002",
+                    "line": "1:0",
+                    "match": "{% trans 'this' %}",
+                    "message": "Double quotes should be used in tags.",
+                }
+            ]
+        ),
+        id="T002_trans",
+    ),
+    pytest.param(
+        ("{% translate 'this' %}"),
+        (
+            [
+                {
+                    "code": "T002",
+                    "line": "1:0",
+                    "match": "{% translate 'this' ",
+                    "message": "Double quotes should be used in tags.",
+                }
+            ]
+        ),
+        id="T002_translate",
+    ),
+    pytest.param(
+        ("{% include 'this' %}"),
+        (
+            [
+                {
+                    "code": "T002",
+                    "line": "1:0",
+                    "match": "{% include 'this' %}",
+                    "message": "Double quotes should be used in tags.",
+                }
+            ]
+        ),
+        id="T002_include",
+    ),
+    pytest.param(
+        ("{% now 'Y-m-d G:i:s' %}"),
+        (
+            [
+                {
+                    "code": "T002",
+                    "line": "1:0",
+                    "match": "{% now 'Y-m-d G:i:s'",
+                    "message": "Double quotes should be used in tags.",
+                }
+            ]
+        ),
+        id="T002_now",
+    ),
+    pytest.param(
+        (
+            '{% extends "layout.h" %}\n'
+            '<div class="card" data-list=\'{"name": "blah"}\'>\n'
+            '{% include "template.html" %}\n'
+            "<div {% fpr %} data-{{ name }}='{{ value }}'{% endfor %}/>"
+        ),
+        (
+            [
+                {
+                    "code": "H025",
+                    "line": "2:0",
+                    "match": '<div class="card" da',
+                    "message": "Tag seems to be an orphan.",
+                }
+            ]
+        ),
+        id="T002_test_greedy_regex",
+    ),
+    pytest.param(
+        ("{% if form.action_url %}\n" "   ='stuff'\n" " {% endif %}"),
+        ([]),
+        id="T002_test_greedy_regex_2",
+    ),
+    pytest.param(
+        (
+            '{% include "template.html" %}\n'
+            " {% include \"template.html\" with type='mono' %}"
+        ),
+        (
+            [
+                {
+                    "code": "T002",
+                    "line": "2:1",
+                    "match": '{% include "template',
+                    "message": "Double quotes should be used in tags.",
+                }
+            ]
+        ),
+        id="T002_test_line_num",
+    ),
+    pytest.param(
+        ("{% endblock %}"),
+        (
+            [
+                {
+                    "code": "T003",
+                    "line": "1:0",
+                    "match": "{% endblock %}",
+                    "message": "Endblock should have name. Ex: {% endblock body %}.",
+                }
+            ]
+        ),
+        id="T003",
+    ),
+    pytest.param(
+        ('<link src="/static/there">'),
+        (
+            [
+                {
+                    "code": "D004",
+                    "line": "1:0",
+                    "match": '<link src="/static/',
+                    "message": "(Django) Static urls should follow {% static path/to/file %} pattern.",
+                }
+            ]
+        ),
+        id="DJ004",
+    ),
+    pytest.param(
+        (
+            '<a href="/Collections?handler=RemoveAgreement&id=@a.Id">\n'
+            '<form action="/Collections"></form></a>'
+        ),
+        (
+            [
+                {
+                    "code": "D018",
+                    "line": "1:0",
+                    "match": '<a href="/Collection',
+                    "message": "(Django) Internal links should use the {% url ... %} pattern.",
+                },
+                {
+                    "code": "D018",
+                    "line": "2:0",
+                    "match": '<form action="/Colle',
+                    "message": "(Django) Internal links should use the {% url ... %} pattern.",
+                },
+            ]
+        ),
+        id="DJ018",
+    ),
+    pytest.param(
+        ('<a href="javascript:abc()">\n' '<form action="javascript:abc()"></form></a>'),
+        (
+            [
+                {
+                    "code": "H019",
+                    "line": "1:0",
+                    "match": '<a href="javascript:',
+                    "message": "Replace 'javascript:abc()' with on_ event and real url.",
+                },
+                {
+                    "code": "H019",
+                    "line": "2:0",
+                    "match": '<form action="javasc',
+                    "message": "Replace 'javascript:abc()' with on_ event and real url.",
+                },
+            ]
+        ),
+        id="DJ018_no_match",
+    ),
+    pytest.param(
+        (
+            '<a href="#">\n<form action="#"><a href="#tab">\n'
+            '<form action="#go"></form></a></form></a>'
+        ),
+        ([]),
+        id="DJ018_has_urls",
+    ),
+    pytest.param(
+        ('<div class="em-ajaxLogs" data-src="/table/task/{{ t.id }}/log"></div>'),
+        (
+            [
+                {
+                    "code": "D018",
+                    "line": "1:0",
+                    "match": '<div class="em-ajaxL',
+                    "message": "(Django) Internal links should use the {% url ... %} pattern.",
+                }
+            ]
+        ),
+        id="DJ018_data_src",
+    ),
+    pytest.param(
+        ('<a href="mailto:joe"></a><a href="tel:joe"></a>'),
+        ([]),
+        id="DJ018_mailto",
+    ),
+    pytest.param(
+        ('<a href="data:,Hello%2C%20World%21"></a>'),
+        ([]),
+        id="DJ018_data",
+    ),
+    pytest.param(
+        ('<div data-row-selection-action="highlight"></div>'),
+        ([]),
+        id="DJ018_attribute_names",
+    ),
+    pytest.param(
+        ('<form action="{% url \'something\' %}" data-action="xxx"></form>'),
+        ([]),
+        id="DJ018_data_action",
+    ),
+    pytest.param(
+        ("{% blah 'asdf %}"),
+        (
+            [
+                {
+                    "code": "T027",
+                    "line": "1:0",
+                    "match": "{% blah 'asdf %}",
+                    "message": "Unclosed string found in template syntax.",
+                }
+            ]
+        ),
+        id="T027",
+    ),
+    pytest.param(
+        ("{% blah 'asdf' %}{{ blah \"asdf\" }}"),
+        ([]),
+        id="T027_no",
+    ),
+    pytest.param(
+        ("{% blah 'asdf' 'blah %}"),
+        (
+            [
+                {
+                    "code": "T027",
+                    "line": "1:0",
+                    "match": "{% blah 'asdf' 'blah",
+                    "message": "Unclosed string found in template syntax.",
+                }
+            ]
+        ),
+        id="T027_long_name",
+    ),
+    pytest.param(
+        ('{% trans "Check box if you\'re interested in this location." %}'),
+        ([]),
+        id="T027_trans",
+    ),
+    pytest.param(
+        (
+            "{% macro rendersubmit(buttons=[], class=\"\", index='', url='', that=\"\" , test='') -%}"
+        ),
+        ([]),
+        id="T027_mixed_quotes",
+    ),
+    pytest.param(
+        ("<a href=\"{{ blah 'asdf' -}}\">"),
+        (
+            [
+                {
+                    "code": "H025",
+                    "line": "1:0",
+                    "match": "<a href=\"{{ blah 'as",
+                    "message": "Tag seems to be an orphan.",
+                }
+            ]
+        ),
+        id="T028_no",
+    ),
+    pytest.param(
+        ("<a {{ blah 'asdf' }}>"),
+        (
+            [
+                {
+                    "code": "H025",
+                    "line": "1:0",
+                    "match": "<a {{ blah 'asdf' }}",
+                    "message": "Tag seems to be an orphan.",
+                }
+            ]
+        ),
+        id="T028_no_2",
+    ),
+    pytest.param(
+        ("<a {% blah 'asdf' %}>"),
+        (
+            [
+                {
+                    "code": "H025",
+                    "line": "1:0",
+                    "match": "<a {% blah 'asdf' %}",
+                    "message": "Tag seems to be an orphan.",
+                }
+            ]
+        ),
+        id="T028_no_3",
+    ),
+    pytest.param(
+        ("{% blah 'asdf' %}"),
+        ([]),
+        id="T028_no_5",
+    ),
+    pytest.param(
+        ("{% for 'asdf' %}"),
+        ([]),
+        id="T028_no_6",
+    ),
+    pytest.param(
+        ('<input class="{% if %}{% endif %}" />'),
+        ([]),
+        id="T028_no_7",
+    ),
+    pytest.param(
+        ("{% static ''  \"  \"  'foo/bar.min.css' %}"),
+        (
+            [
+                {
+                    "code": "T032",
+                    "line": "1:0",
+                    "match": "{% static ''",
+                    "message": "Extra whitespace found in template tags.",
+                }
+            ]
+        ),
+        id="T032",
+    ),
+    pytest.param(
+        ("{% static  ''  %}"),
+        (
+            [
+                {
+                    "code": "T001",
+                    "line": "1:12",
+                    "match": "'  %}",
+                    "message": "Variables should be wrapped in a single whitespace.",
+                },
+                {
+                    "code": "T032",
+                    "line": "1:0",
+                    "match": "{% static",
+                    "message": "Extra whitespace found in template tags.",
+                },
+            ]
+        ),
+        id="T032_2",
+    ),
+    pytest.param(
+        ("{% static '' \"     \" 'foo/bar.min.css' %}"),
+        ([]),
+        id="T032_no",
+    ),
+    pytest.param(
+        ("{{ static ''  \"  \"  'foo/bar.min.css' }}"),
+        (
+            [
+                {
+                    "code": "T032",
+                    "line": "1:0",
+                    "match": "{{ static ''",
+                    "message": "Extra whitespace found in template tags.",
+                }
+            ]
+        ),
+        id="T032_3",
+    ),
+    pytest.param(
+        ("{{ static  ''  }}"),
+        (
+            [
+                {
+                    "code": "T001",
+                    "line": "1:12",
+                    "match": "'  }}",
+                    "message": "Variables should be wrapped in a single whitespace.",
+                },
+                {
+                    "code": "T032",
+                    "line": "1:0",
+                    "match": "{{ static",
+                    "message": "Extra whitespace found in template tags.",
+                },
+            ]
+        ),
+        id="T032_4",
+    ),
+    pytest.param(
+        ("{{ static '' \"     \" 'foo/bar.min.css' }}"),
+        ([]),
+        id="T032_no_2",
+    ),
+]
+
+
+@pytest.mark.parametrize(("source", "expected"), test_data)
+def test_base(source, expected, django_config):
+    filename = "test.html"
+    output = linter(django_config, source, filename, filename)
+
+    lint_printer(source, expected, output[filename])
+
+    mismatch = list(filter(lambda x: x not in expected, output[filename])) + list(
+        filter(lambda x: x not in output[filename], expected)
+    )
+
+    assert len(mismatch) == 0

package/tests/test_linter/test_h005.py

@@ -0,0 +1,45 @@
+"""Test linter code H005.
+
+poetry run pytest tests/test_linter/test_h005.py
+"""
+import pytest
+
+from src.djlint.lint import linter
+from tests.conftest import lint_printer
+
+test_data = [
+    pytest.param(
+        ("<!DOCTYPE html>\n<html>"),
+        (
+            [
+                {
+                    "code": "H005",
+                    "line": "2:0",
+                    "match": "<html>",
+                    "message": "Html tag should have lang attribute.",
+                },
+                {
+                    "code": "H025",
+                    "line": "2:0",
+                    "match": "<html>",
+                    "message": "Tag seems to be an orphan.",
+                },
+            ]
+        ),
+        id="one",
+    ),
+]
+
+
+@pytest.mark.parametrize(("source", "expected"), test_data)
+def test_base(source, expected, basic_config):
+    filename = "test.html"
+    output = linter(basic_config, source, filename, filename)
+
+    lint_printer(source, expected, output[filename])
+
+    mismatch = list(filter(lambda x: x not in expected, output[filename])) + list(
+        filter(lambda x: x not in output[filename], expected)
+    )
+
+    assert len(mismatch) == 0