djlint 1.28.0 → 1.30.0

package/tests/test_linter/test_nunjucks_linter.py

@@ -0,0 +1,59 @@
+"""Djlint linter rule tests for nunjucks.
+
+poetry run pytest tests/test_linter/test_nunjucks_linter.py
+
+"""
+import pytest
+
+from src.djlint.lint import linter
+from tests.conftest import lint_printer
+
+test_data = [
+    pytest.param(
+        ("{%- test-%}"),
+        (
+            [
+                {
+                    "code": "T001",
+                    "line": "1:4",
+                    "match": "test-%}",
+                    "message": "Variables should be wrapped in a single whitespace.",
+                }
+            ]
+        ),
+        id="T001",
+    ),
+    pytest.param(
+        ("{%-test -%}"),
+        (
+            [
+                {
+                    "code": "T001",
+                    "line": "1:0",
+                    "match": "{%-test",
+                    "message": "Variables should be wrapped in a single whitespace.",
+                }
+            ]
+        ),
+        id="T001_2",
+    ),
+    pytest.param(
+        ("{%- test -%}"),
+        ([]),
+        id="T001_3",
+    ),
+]
+
+
+@pytest.mark.parametrize(("source", "expected"), test_data)
+def test_base(source, expected, nunjucks_config):
+    filename = "test.html"
+    output = linter(nunjucks_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_python_module_rules/.djlint_rules.yaml

@@ -0,0 +1,4 @@
+- rule:
+    name: T001
+    message: Found the 'bad' word
+    python_module: tests.test_linter.test_python_module_rules.my_module

package/tests/test_linter/test_python_module_rules/html_bad.html

@@ -0,0 +1,3 @@
+Random content
+I'm bad
+Random content

package/tests/test_linter/test_python_module_rules/html_ok.html

@@ -0,0 +1,3 @@
+Random content
+I'm ok
+Random content

package/tests/test_linter/test_python_module_rules/my_module.py

@@ -0,0 +1,32 @@
+"""Test module for custom rules."""
+import re
+from typing import Any, Dict, List
+
+from djlint.lint import get_line
+from djlint.settings import Config
+
+
+def run(
+    rule: Dict[str, Any],
+    config: Config,
+    html: str,
+    filepath: str,
+    line_ends: List[Dict[str, int]],
+    *args: Any,
+    **kwargs: Any,
+) -> List[Dict[str, str]]:
+    """Rule that fails if if the html file contains 'bad'.
+
+    In the real world, this should be done with a simple regex rule.
+    """
+    errors: List[Dict[str, str]] = []
+    for match in re.finditer(r"bad", html):
+        errors.append(
+            {
+                "code": rule["name"],
+                "line": get_line(match.start(), line_ends),
+                "match": match.group().strip()[:20],
+                "message": rule["message"],
+            }
+        )
+    return errors

package/tests/test_linter/test_python_module_rules/pyproject.toml

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

package/tests/test_linter/test_python_module_rules/test_linter.py

@@ -0,0 +1,26 @@
+"""Djlint tests specific to pyproject.toml configuration.
+
+run::
+
+   pytest tests/test_linter/test_python_module_rules/test_linter.py --cov=src/djlint --cov-branch \
+          --cov-report xml:coverage.xml --cov-report term-missing
+
+"""
+
+
+from click.testing import CliRunner
+
+from src.djlint import main as djlint
+
+
+def test_custom_rules(runner: CliRunner) -> None:
+    """Test that our python_module is properly loaded and run."""
+    result = runner.invoke(
+        djlint, ["tests/test_linter/test_python_module_rules/", "--profile", "django"]
+    )
+    print(result.output)
+    assert """Linting""" in result.output
+    assert """2/2""" in result.output
+    assert """T001 2:4""" in result.output
+    assert """Linted 2 files, found 1 error.""" in result.output
+    assert result.exit_code == 1

package/tests/test_nunjucks/test_functions.py

@@ -0,0 +1,94 @@
+"""Test nunjucks functions.
+
+poetry run pytest tests/test_nunjucks/test_functions.py
+"""
+import pytest
+
+from src.djlint.reformat import formatter
+from tests.conftest import config_builder, printer
+
+test_data = [
+    pytest.param(
+        (
+            "{{ myfunc({\n"
+            "  bar: {\n"
+            "    baz: {\n"
+            "      cux: 1\n"
+            "    }\n"
+            "  }\n"
+            "})}}"
+        ),
+        ("{{ myfunc({bar: {baz: {cux: 1}}}) }}\n"),
+        ({}),
+        id="long line",
+    ),
+    pytest.param(
+        (
+            "{{ myfunc({\n"
+            "  bar: {\n"
+            "    baz: {\n"
+            "      cux: 1\n"
+            "    }\n"
+            "  }\n"
+            "})}}"
+        ),
+        (
+            "{{ myfunc({\n"
+            "    bar: {\n"
+            "        baz: {\n"
+            "            cux: 1\n"
+            "        }\n"
+            "    }\n"
+            "}) }}\n"
+        ),
+        ({"max_line_length": 1}),
+        id="short line",
+    ),
+    pytest.param(
+        (
+            "<div>{{ myfunc({\n"
+            "  bar: {\n"
+            "    baz: {\n"
+            "      cux: 1\n"
+            "    }\n"
+            "  }\n"
+            "})}}</div>"
+        ),
+        (
+            "<div>\n"
+            "    {{ myfunc({\n"
+            "        bar: {\n"
+            "            baz: {\n"
+            "                cux: 1\n"
+            "            }\n"
+            "        }\n"
+            "    }) }}\n"
+            "</div>\n"
+        ),
+        ({"max_line_length": 1}),
+        id="nested",
+    ),
+    pytest.param(
+        (
+            "{{ myfunc({\n"
+            "  bar: {\n"
+            "    baz: {\n"
+            "      cux: 1\n"
+            "    }\n"
+            "  }\n"
+            "})}"
+        ),
+        ("{{ myfunc({\n" "bar: {\n" "baz: {\n" "cux: 1\n" "}\n" "}\n" "})}\n"),
+        ({}),
+        id="broken",
+    ),
+]
+
+
+@pytest.mark.parametrize(("source", "expected", "args"), test_data)
+def test_base(source, expected, args, nunjucks_config):
+    args["profile"] = "nunjucks"
+    output = formatter(config_builder(args), source)
+
+    printer(expected, source, output)
+    assert expected == output

package/tests/test_nunjucks/test_macros.py

@@ -0,0 +1,41 @@
+"""Test nunjucks macro tag.
+
+poetry run pytest tests/test_nunjucks/test_macros.py
+"""
+import pytest
+
+from src.djlint.reformat import formatter
+from tests.conftest import printer
+
+test_data = [
+    pytest.param(
+        ("{% macro 'cool' %}<div>some html</div>{% endmacro %}"),
+        ("{% macro 'cool' %}\n" "    <div>some html</div>\n" "{% endmacro %}\n"),
+        id="macro_tag",
+    ),
+    pytest.param(
+        (
+            "<ul>\n"
+            "  {# djlint:off #}\n"
+            "  <li>{{foo(1)}}</li>\n"
+            "  {# djlint:on #}\n"
+            "</ul>"
+        ),
+        (
+            "<ul>\n"
+            "    {# djlint:off #}\n"
+            "  <li>{{foo(1)}}</li>\n"
+            "    {# djlint:on #}\n"
+            "</ul>\n"
+        ),
+        id="ignored code should not be touched",
+    ),
+]
+
+
+@pytest.mark.parametrize(("source", "expected"), test_data)
+def test_base(source, expected, nunjucks_config):
+    output = formatter(nunjucks_config, source)
+
+    printer(expected, source, output)
+    assert expected == output

package/tests/test_nunjucks/test_set.py

@@ -0,0 +1,206 @@
+"""Test nunjucks set tags.
+
+poetry run pytest tests/test_nunjucks/test_set.py
+"""
+import pytest
+
+from src.djlint.reformat import formatter
+from tests.conftest import config_builder, printer
+
+test_data = [
+    pytest.param(
+        ("{%- set posts = collections.docs -%}"),
+        ("{%- set posts = collections.docs -%}\n"),
+        ({}),
+        id="set",
+    ),
+    pytest.param(
+        ("{%-set posts = collections.docs-%}\n{%asdf%}"),
+        ("{%- set posts = collections.docs -%}\n" "{% asdf %}\n"),
+        ({}),
+        id="set_with_sibling",
+    ),
+    pytest.param(
+        ('<title>{% set_title "My Title" %}</title>'),
+        ('<title>{% set_title "My Title" %}</title>\n'),
+        ({}),
+        id="don't break underscore stuff",
+    ),
+    pytest.param(
+        (
+            "{% set schema=[\n"
+            "{\n"
+            '"name":"id",\n'
+            '"type":      "integer",\n'
+            '"primary": true,\n'
+            "id:1\n"
+            "},\n"
+            "{\n"
+            '"name": "name",\n'
+            '"type": "string"\n'
+            "}\n"
+            "] %}"
+        ),
+        (
+            "{% set schema = [\n"
+            "    {\n"
+            '        name: "id",\n'
+            '        type: "integer",\n'
+            "        primary: true,\n"
+            "        id: 1\n"
+            "    },\n"
+            "    {\n"
+            '        name: "name",\n'
+            '        type: "string"\n'
+            "    }\n"
+            "] %}\n"
+        ),
+        ({"max_line_length": 10}),
+        id="indent multiilne",
+    ),
+    pytest.param(
+        (
+            "<div>{% set schema=[\n"
+            "{\n"
+            '"name":"id",\n'
+            '"type":      "integer",\n'
+            '"primary": true,\n'
+            "id:1\n"
+            "},\n"
+            "{\n"
+            '"name": "name",\n'
+            '"type": "string"\n'
+            "}\n"
+            "] %}</div>"
+        ),
+        (
+            "<div>\n"
+            "    {% set schema = [\n"
+            "        {\n"
+            '            name: "id",\n'
+            '            type: "integer",\n'
+            "            primary: true,\n"
+            "            id: 1\n"
+            "        },\n"
+            "        {\n"
+            '            name: "name",\n'
+            '            type: "string"\n'
+            "        }\n"
+            "    ] %}\n"
+            "</div>\n"
+        ),
+        ({"max_line_length": 10}),
+        id="nestedindent multiilne",
+    ),
+    pytest.param(
+        (
+            '{% set schema=[{"name": "id",\n'
+            '"type": "integer",\n'
+            '"primary": true\n'
+            "},] %}"
+        ),
+        ('{% set schema = [{name: "id", type: "integer", primary: true}] %}\n'),
+        ({}),
+        id="indent invalid json",
+    ),
+    pytest.param(
+        (
+            '{% set schema=[{name: "id",\n'
+            "'type': \"1\",\n"
+            '"primary+1": true\n'
+            "}] %}"
+        ),
+        ('{% set schema = [{name: "id", type: "1", "primary+1": true}] %}\n'),
+        ({}),
+        id="indent valid json",
+    ),
+    pytest.param(
+        (
+            '{% set table_keys = [ ( "date_started", "Start date"), ( "name", "Name" )] %}'
+        ),
+        ("{% set table_keys = [('date_started', 'Start date'), ('name', 'Name')] %}\n"),
+        ({}),
+        id="indent py style list",
+    ),
+    pytest.param(
+        (
+            '{% set cta %}{% include "partials/cta.njk" %}<div></div>{% endset %}\n'
+            "{%-set posts = collections.docs-%}\n"
+            "{%asdf%}"
+        ),
+        (
+            "{% set cta %}\n"
+            '    {% include "partials/cta.njk" %}\n'
+            "    <div></div>\n"
+            "{% endset %}\n"
+            "{%- set posts = collections.docs -%}\n"
+            "{% asdf %}\n"
+        ),
+        ({}),
+        id="set block",
+    ),
+    pytest.param(
+        (
+            "<ul>\n"
+            "  {# djlint:off #}\n"
+            "  <li>{%set a=[{'x':1}]%}</li>\n"
+            "  {# djlint:on #}\n"
+            "</ul>"
+        ),
+        (
+            "<ul>\n"
+            "    {# djlint:off #}\n"
+            "  <li>{%set a=[{'x':1}]%}</li>\n"
+            "    {# djlint:on #}\n"
+            "</ul>\n"
+        ),
+        ({"max_line_length": 1}),
+        id="ignored code should not be touched",
+    ),
+    pytest.param(
+        ('{%- set posts = "¿Spécial çhärs 👻?" -%}'),
+        ('{%- set posts = "¿Spécial çhärs 👻?" -%}\n'),
+        ({}),
+        id="set",
+    ),
+    pytest.param(
+        ("<li>{{ foo(1,2) }}</li>"),
+        ("<li>{{ foo(1, 2) }}</li>\n"),
+        ({}),
+        id="don't add parenth to lists",
+    ),
+    pytest.param(
+        ('{{- foo("bar") -}}'),
+        ('{{- foo("bar") -}}\n'),
+        ({}),
+        id="don't break spaceless tags #667",
+    ),
+    pytest.param(
+        (
+            "{% for tag in collections.all | getAllTags | filterTagList | sort %}\n"
+            "    {% set tagUrl %}\n"
+            "        /tags/{{ tag | slugify }}/{% endset %}\n"
+            '        <a href="{{ tagUrl }}" class="post-tag">{{ tag }} ({{ collections[tag].length }})</a>\n'
+            "    {% endfor %}\n"
+        ),
+        (
+            "{% for tag in collections.all | getAllTags | filterTagList | sort %}\n"
+            "    {% set tagUrl %}\n"
+            "        /tags/{{ tag | slugify }}/\n"
+            "    {% endset %}\n"
+            '    <a href="{{ tagUrl }}" class="post-tag">{{ tag }} ({{ collections[tag].length }})</a>\n'
+            "{% endfor %}\n"
+        ),
+        ({}),
+        id="check dedent on nested block",
+    ),
+]
+
+
+@pytest.mark.parametrize(("source", "expected", "args"), test_data)
+def test_base(source, expected, args, nunjucks_config):
+    args["profile"] = "nunjucks"
+    output = formatter(config_builder(args), source)
+
+    printer(expected, source, output)
+    assert expected == output

package/tests/test_nunjucks/test_spaceless.py

@@ -0,0 +1,24 @@
+"""Test nunjucks spaceless tag.
+
+poetry run pytest tests/test_nunjucks/test_spaceless.py
+"""
+import pytest
+
+from src.djlint.reformat import formatter
+from tests.conftest import printer
+
+test_data = [
+    pytest.param(
+        ("{%- if entry.children.length -%}<strong>{%- endif -%}"),
+        ("{%- if entry.children.length -%}<strong>{%- endif -%}\n"),
+        id="spaceless_tag",
+    ),
+]
+
+
+@pytest.mark.parametrize(("source", "expected"), test_data)
+def test_base(source, expected, nunjucks_config):
+    output = formatter(nunjucks_config, source)
+
+    printer(expected, source, output)
+    assert expected == output

package/tests/test_twig/test_comments.py

@@ -0,0 +1,51 @@
+"""Test twig comment tags.
+
+poetry run pytest tests/test_twig/test_comments.py
+"""
+import pytest
+
+from src.djlint.reformat import formatter
+from tests.conftest import printer
+
+test_data = [
+    pytest.param(
+        ("{% if %}\n" "    {#\n" "        line\n" "    #}\n" "{% endif %}"),
+        ("{% if %}\n" "    {#\n" "        line\n" "    #}\n" "{% endif %}\n"),
+        id="comments",
+    ),
+    pytest.param(
+        (
+            "<div>\n"
+            "    {#\n"
+            "    multi\n"
+            "    line\n"
+            "    comment\n"
+            "    #}\n"
+            "</div>\n"
+            "<div>\n"
+            "    <p></p>\n"
+            "</div>\n"
+        ),
+        (
+            "<div>\n"
+            "    {#\n"
+            "    multi\n"
+            "    line\n"
+            "    comment\n"
+            "    #}\n"
+            "</div>\n"
+            "<div>\n"
+            "    <p></p>\n"
+            "</div>\n"
+        ),
+        id="comments",
+    ),
+]
+
+
+@pytest.mark.parametrize(("source", "expected"), test_data)
+def test_base(source, expected, nunjucks_config):
+    output = formatter(nunjucks_config, source)
+
+    printer(expected, source, output)
+    assert expected == output

package/tox.ini

@@ -0,0 +1,48 @@
+[tox]
+envlist = test
+skip_missing_interpreters = True
+isolated_build = True
+setenv =
+    PYTHONDONTWRITEBYTECODE=1
+
+[testenv:isort]
+commands =
+    isort src/djlint
+    isort tests
+skip_install = True
+allowlist_externals = isort
+
+[testenv:black]
+commands =
+    black src/djlint
+    black tests
+skip_install = True
+allowlist_externals = black
+
+[testenv:lint]
+commands =
+    ruff src/djlint
+    black --fast --check src/djlint
+    mypy src/djlint
+    ruff tests
+    black --fast --check tests
+    mypy tests
+skip_install = true
+allowlist_externals =
+    black
+    mypy
+    ruff
+
+[testenv]
+commands =
+    pytest --cov=src/djlint --cov-branch --cov-report xml:coverage.xml --cov-report term-missing {posargs:} -n auto --dist loadgroup
+; need to install so that we can test python calls
+skip_install = false
+allowlist_externals = pytest
+
+[testenv:test-fast]
+commands =
+    pytest -n 7
+; need to install so that we can test python calls
+skip_install = false
+allowlist_externals = pytest