From 82b09d2a5962b0d29098b347573626e6df0623d2 Mon Sep 17 00:00:00 2001
From: Kari Salminen <kari.salminen@anders.com>
Date: Wed, 19 Feb 2025 15:23:45 +0200
Subject: [PATCH] fix(sonarcloud): ignore ul-wrapping of li with //NOSONAR,
 django does it

SonarCloud was raising a reliability issue on the <li> tag line:
> Surround this <li> item tag by a <ul> or <ol> container one.
> "<li>" and "<dt>" item tags should be in "<ul>", "<ol>" or "<dl>"
> container tags Web:ItemTagNotWithinContainerTagCheck

This is a false positive issue as Django's default
admin/change_list.html wraps the object-tools-items inside <ul>...</ul>
tag, see
https://github.com/django/django/blob/4.2.18/django/contrib/admin/templates/admin/change_list.html#L44-L48

"//NOSONAR" is a bit of a blunt object, as it ignores all SonarCloud
issues on the given line. Ignoring a specific SonarCloud rule for
specific files using `sonar.issue.ignore.multicriteria` would possibly
work also, and be more rule specific, although not as line specific.

refs KK-1416
---
 common/templates/notification_change_list.html    | 2 +-
 importers/templates/notification_change_list.html | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/common/templates/notification_change_list.html b/common/templates/notification_change_list.html
index 0bd43c02..1cf157c8 100644
--- a/common/templates/notification_change_list.html
+++ b/common/templates/notification_change_list.html
@@ -3,7 +3,7 @@
 
 {% block object-tools-items %}
 {{ block.super }}
-<li>
+<li> <!-- //NOSONAR No need to wrap with <ul> here, base template does that -->
     <a href="{% url 'admin:import-new-notifications' %}" class="btn btn-high btn-success">{% trans "Import new notifications from the spreadsheet" %}</a>
 </li>
 {% endblock %}
diff --git a/importers/templates/notification_change_list.html b/importers/templates/notification_change_list.html
index b492db5a..e3836793 100644
--- a/importers/templates/notification_change_list.html
+++ b/importers/templates/notification_change_list.html
@@ -3,7 +3,7 @@
 
 {% block object-tools-items %}
 {{ block.super }}
-<li>
+<li> <!-- //NOSONAR No need to wrap with <ul> here, base template does that -->
     <a href="{% url 'admin:import-missing-notifications' %}" class="btn btn-high btn-success">{% trans "Import missing notifications from the spreadsheet" %}</a>
 </li>
 {% endblock %}