Run pre-commit-config and apply it, also lint jinja template files

DitZii · Feb 27, 2024 · b512f72 · b512f72
1 parent fb06e43
commit b512f72
Show file tree

Hide file tree

Showing 50 changed files with 5,800 additions and 6,202 deletions.
diff --git a/.gitleaksignore b/.gitleaksignore
@@ -1 +1,9 @@
 src/ui/templates/profile.html:hashicorp-tf-password:343
+src/ui/templates/account.html:hashicorp-tf-password:194
+src/ui/templates/account.html:hashicorp-tf-password:255
+src/ui/templates/account.html:hashicorp-tf-password:292
+src/ui/templates/account.html:hashicorp-tf-password:329
+src/ui/templates/account.html:hashicorp-tf-password:417
+src/ui/templates/account.html:hashicorp-tf-password:470
+src/ui/templates/settings_plugins.html:hashicorp-tf-password:87
+src/ui/templates/settings_plugins.html:hashicorp-tf-password:297
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -17,7 +17,7 @@ repos:
       - id: check-case-conflict
 
   - repo: https://github.com/psf/black
-    rev: e026c93888f91a47a9c9f4e029f3eb07d96375e6 # frozen: 24.1.1
+    rev: 6fdf8a4af28071ed1d079c01122b34c5d587207a # frozen: 24.2.0
     hooks:
       - id: black
         name: Black Python Formatter

diff --git a/.prettierignore b/.prettierignore
@@ -16,5 +16,6 @@ flatpickr.*
 src/ui/static/js/editor/*
 src/ui/static/js/utils/purify/*
 src/ui/templates/*
+src/common/core/*/ui/*
 datepicker-foundation.css
 examples/*
diff --git a/docs/overrides/main.html b/docs/overrides/main.html
@@ -1,23 +1,25 @@
-{% extends "base.html" %} {% block outdated %} You're not viewing the
-documentation of the latest version.
-<a href="{{ '../' ~ base_url }}">
-  <strong>Click here to view latest.</strong>
-</a>
-{% endblock %} {% block announce %} 📢 Looking for technical support, tailored
-consulting or custom development for BunkerWeb ? Visit the
-<a
-  href="https://panel.bunkerweb.io/?utm_campaign=self&utm_source=doc"
-  style="color: #3f6ec6; text-decoration: underline"
-  >BunkerWeb Panel</a
->
-for more information on our enterprise offers. {% endblock %} {% block libs %}
-<script
-  async
-  defer
-  data-domain="docs.bunkerweb.io"
-  src="https://data.bunkerity.com/js/script.js"
-></script>
-<script defer>
+{% extends "base.html" %}
+{% block outdated %}
+    You're not viewing the
+    documentation of the latest version.
+    <a href="{{ '../' ~ base_url }}">
+        <strong>Click here to view latest.</strong>
+    </a>
+{% endblock %}
+{% block announce %}
+    📢 Looking for technical support, tailored
+    consulting or custom development for BunkerWeb ? Visit the
+    <a href="https://panel.bunkerweb.io/?utm_campaign=self&utm_source=doc"
+       style="color: #3f6ec6;
+              text-decoration: underline">BunkerWeb Panel</a>
+    for more information on our enterprise offers.
+{% endblock %}
+{% block libs %}
+    <script async
+            defer
+            data-domain="docs.bunkerweb.io"
+            src="https://data.bunkerity.com/js/script.js"></script>
+    <script defer>
   // Lazy load images and embed youtube videos
   window.addEventListener("load", () => {
     document.querySelectorAll("[data-src]").forEach((el) => {
@@ -30,5 +32,5 @@
       .querySelector('div.md-search[data-md-component="search"][role="dialog"]')
       .setAttribute("aria-label", "Search in documentation");
   } catch (err) {}
-</script>
+    </script>
 {% endblock %}
diff --git a/misc/format-jinja-files.sh b/misc/format-jinja-files.sh
@@ -0,0 +1,45 @@
+#!/bin/bash
+
+first_arg=$1
+args=("$@")
+
+if [ "$first_arg" == "manual" ]; then
+  echo "⏳ Running djLint for web UI Jinja files..."
+  djlint --reformat --profile=jinja --exclude=src/ui/templates/setup.html src/ui/templates
+  ret=$?
+  if [ $ret -ne 0 ]; then
+      echo "❌ djLint failed for web UI template files. Exiting..."
+      exit $ret
+  fi
+  echo "✅ djLint for web UI template files passed."
+
+
+  echo "⏳ Running djLint for core plugins UI Jinja files..."
+  djlint --reformat --profile=jinja src/common/core/*/ui
+  ret=$?
+  if [ $ret -ne 0 ]; then
+      echo "❌ djLint failed for core plugins UI template files. Exiting..."
+      exit $ret
+  fi
+  echo "✅ djLint for core plugins UI template files passed."
+
+  echo "⏳ Running djLint for documentation Jinja files..."
+  djlint --reformat --profile=jinja docs/
+  ret=$?
+  if [ $ret -ne 0 ]; then
+      echo "❌ djLint failed for documentation files. Exiting..."
+      exit $ret
+  fi
+  echo "✅ djLint for documentation files passed."
+
+  echo "✅ All djLint commands passed"
+else
+  echo "⏳ Running custom djLint command with args: ${args[*]}"
+  djlint --reformat --profile=jinja "${args[@]}"
+  ret=$?
+  if [ $ret -ne 0 ]; then
+      echo "❌ djLint failed for custom command. Exiting..."
+      exit $ret
+  fi
+  echo "✅ djLint for custom command passed."
+fi
diff --git a/src/common/core/antibot/ui/template.html b/src/common/core/antibot/ui/template.html
@@ -1,60 +1,44 @@
-{% extends "base.html" %} {% block content %}
-<input
-  type="csrf_token"
-  name="csrf_token"
-  value="{{ csrf_token }}"
-  class="hidden"
-  hidden
-/>
-
-<div class="core-layout">
-  {% if is_used and is_metrics %}
-  <!-- info-->
-  <div class="core-card">
-    <h5 class="core-card-info-title">INFO</h5>
-
-    <div class="core-card-info-list">
-      <p data-info class="core-card-info-text"></p>
-    </div>
-  </div>
-  <!-- end info -->
-
-  <div class="core-card-metrics">
-    <!-- text -->
-    <div>
-      <p class="core-card-metrics-name">Challenges</p>
-      <h5 data-count class="core-card-title">"unknown"</h5>
-
-      <p class="core-card-metrics-subtitle">
-        <span class="core-card-metrics-subtitle-content error"
-          >total failed
-        </span>
-      </p>
-    </div>
-    <!-- end text -->
-    <!-- icon -->
-    <div role="img" class="core-card-metrics-svg-container blue">
-      <svg
-        xmlns="http://www.w3.org/2000/svg"
-        viewBox="0 0 24 24"
-        fill="currentColor"
-        class="size-base core-card-metrics-svg"
-      >
-        <path
-          d="M11.7 2.805a.75.75 0 0 1 .6 0A60.65 60.65 0 0 1 22.83 8.72a.75.75 0 0 1-.231 1.337 49.948 49.948 0 0 0-9.902 3.912l-.003.002c-.114.06-.227.119-.34.18a.75.75 0 0 1-.707 0A50.88 50.88 0 0 0 7.5 12.173v-.224c0-.131.067-.248.172-.311a54.615 54.615 0 0 1 4.653-2.52.75.75 0 0 0-.65-1.352 56.123 56.123 0 0 0-4.78 2.589 1.858 1.858 0 0 0-.859 1.228 49.803 49.803 0 0 0-4.634-1.527.75.75 0 0 1-.231-1.337A60.653 60.653 0 0 1 11.7 2.805Z"
-        />
-        <path
-          d="M13.06 15.473a48.45 48.45 0 0 1 7.666-3.282c.134 1.414.22 2.843.255 4.284a.75.75 0 0 1-.46.711 47.87 47.87 0 0 0-8.105 4.342.75.75 0 0 1-.832 0 47.87 47.87 0 0 0-8.104-4.342.75.75 0 0 1-.461-.71c.035-1.442.121-2.87.255-4.286.921.304 1.83.634 2.726.99v1.27a1.5 1.5 0 0 0-.14 2.508c-.09.38-.222.753-.397 1.11.452.213.901.434 1.346.66a6.727 6.727 0 0 0 .551-1.607 1.5 1.5 0 0 0 .14-2.67v-.645a48.549 48.549 0 0 1 3.44 1.667 2.25 2.25 0 0 0 2.12 0Z"
-        />
-        <path
-          d="M4.462 19.462c.42-.419.753-.89 1-1.395.453.214.902.435 1.347.662a6.742 6.742 0 0 1-1.286 1.794.75.75 0 0 1-1.06-1.06Z"
-        />
-      </svg>
-    </div>
-    <!-- end icon -->
-  </div>
-
-  <script nonce="{{script_nonce}}">
+{% extends "base.html" %}
+{% block content %}
+    <input type="csrf_token"
+           name="csrf_token"
+           value="{{ csrf_token }}"
+           class="hidden"
+           hidden />
+    <div class="core-layout">
+        {% if is_used and is_metrics %}
+            <!-- info-->
+            <div class="core-card">
+                <h5 class="core-card-info-title">INFO</h5>
+                <div class="core-card-info-list">
+                    <p data-info class="core-card-info-text"></p>
+                </div>
+            </div>
+            <!-- end info -->
+            <div class="core-card-metrics">
+                <!-- text -->
+                <div>
+                    <p class="core-card-metrics-name">Challenges</p>
+                    <h5 data-count class="core-card-title">"unknown"</h5>
+                    <p class="core-card-metrics-subtitle">
+                        <span class="core-card-metrics-subtitle-content error">total failed</span>
+                    </p>
+                </div>
+                <!-- end text -->
+                <!-- icon -->
+                <div role="img" class="core-card-metrics-svg-container blue">
+                    <svg xmlns="http://www.w3.org/2000/svg"
+                         viewBox="0 0 24 24"
+                         fill="currentColor"
+                         class="size-base core-card-metrics-svg">
+                        <path d="M11.7 2.805a.75.75 0 0 1 .6 0A60.65 60.65 0 0 1 22.83 8.72a.75.75 0 0 1-.231 1.337 49.948 49.948 0 0 0-9.902 3.912l-.003.002c-.114.06-.227.119-.34.18a.75.75 0 0 1-.707 0A50.88 50.88 0 0 0 7.5 12.173v-.224c0-.131.067-.248.172-.311a54.615 54.615 0 0 1 4.653-2.52.75.75 0 0 0-.65-1.352 56.123 56.123 0 0 0-4.78 2.589 1.858 1.858 0 0 0-.859 1.228 49.803 49.803 0 0 0-4.634-1.527.75.75 0 0 1-.231-1.337A60.653 60.653 0 0 1 11.7 2.805Z" />
+                        <path d="M13.06 15.473a48.45 48.45 0 0 1 7.666-3.282c.134 1.414.22 2.843.255 4.284a.75.75 0 0 1-.46.711 47.87 47.87 0 0 0-8.105 4.342.75.75 0 0 1-.832 0 47.87 47.87 0 0 0-8.104-4.342.75.75 0 0 1-.461-.71c.035-1.442.121-2.87.255-4.286.921.304 1.83.634 2.726.99v1.27a1.5 1.5 0 0 0-.14 2.508c-.09.38-.222.753-.397 1.11.452.213.901.434 1.346.66a6.727 6.727 0 0 0 .551-1.607 1.5 1.5 0 0 0 .14-2.67v-.645a48.549 48.549 0 0 1 3.44 1.667 2.25 2.25 0 0 0 2.12 0Z" />
+                        <path d="M4.462 19.462c.42-.419.753-.89 1-1.395.453.214.902.435 1.347.662a6.742 6.742 0 0 1-1.286 1.794.75.75 0 0 1-1.06-1.06Z" />
+                    </svg>
+                </div>
+                <!-- end icon -->
+            </div>
+            <script nonce="{{script_nonce}}">
     // Use SetupPlugin class that is on static/js/plugins/setup.js
     const setPlugin = new SetupPlugin({
       info: {
@@ -68,39 +52,29 @@ <h5 data-count class="core-card-title">"unknown"</h5>
         type: "text",
       },
     });
-  </script>
-  {% else %}
-  <div class="core-card">
-    <div class="core-card-wrap">
-      <h5 class="core-card-deactivated-title">Deactivated</h5>
-      <!-- icon -->
-      <div role="img" class="core-card-svg-container">
-        <svg
-          xmlns="http://www.w3.org/2000/svg"
-          fill="none"
-          viewBox="0 0 24 24"
-          stroke-width="1.5"
-          stroke="currentColor"
-          class="core-card-deactivated-svg"
-        >
-          <path
-            stroke-linecap="round"
-            stroke-linejoin="round"
-            d="M12 9v3.75m9-.75a9 9 0 1 1-18 0 9 9 0 0 1 18 0Zm-9 3.75h.008v.008H12v-.008Z"
-          />
-        </svg>
-      </div>
-      <!-- end icon -->
-    </div>
-
-    <div class="core-card-text-container">
-      <p data-info class="core-card-text">
-        This plugin need to be activated to get metrics.
-      </p>
+            </script>
+        {% else %}
+            <div class="core-card">
+                <div class="core-card-wrap">
+                    <h5 class="core-card-deactivated-title">Deactivated</h5>
+                    <!-- icon -->
+                    <div role="img" class="core-card-svg-container">
+                        <svg xmlns="http://www.w3.org/2000/svg"
+                             fill="none"
+                             viewBox="0 0 24 24"
+                             stroke-width="1.5"
+                             stroke="currentColor"
+                             class="core-card-deactivated-svg">
+                            <path stroke-linecap="round" stroke-linejoin="round" d="M12 9v3.75m9-.75a9 9 0 1 1-18 0 9 9 0 0 1 18 0Zm-9 3.75h.008v.008H12v-.008Z" />
+                        </svg>
+                    </div>
+                    <!-- end icon -->
+                </div>
+                <div class="core-card-text-container">
+                    <p data-info class="core-card-text">This plugin need to be activated to get metrics.</p>
+                </div>
+            </div>
+            <!-- end info -->
+        {% endif %}
     </div>
-  </div>
-  <!-- end info -->
-  {% endif %}
-</div>
-
 {% endblock %}