Minify included JavaScript

coderedcms/templates/coderedcms/pages/base.html

@@ -176,7 +176,7 @@ <h2 class="text-center my-5">{% trans "Related" %}</h2>
   {% endblock %}
 
   {% block coderedcms_scripts %}
-  <script src="{% static 'coderedcms/js/crx-front.js' %}?v={% coderedcms_version %}"></script>
+  <script src="{% static 'coderedcms/js/crx-front.min.js' %}?v={% coderedcms_version %}"></script>
   {% endblock %}
 
   {% block custom_scripts %}{% endblock %}

coderedcms/templates/coderedcms/pages/event_index_page.html

@@ -33,5 +33,5 @@
 {{ block.super }}
 <script src="https://cdn.jsdelivr.net/npm/fullcalendar@6.1.15/index.global.min.js" integrity="sha256-ZztCtsADLKbUFK/X6nOYnJr0eelmV2X3dhLDB/JK6fM=" crossorigin="anonymous"></script>
 <script src="https://cdn.jsdelivr.net/npm/@fullcalendar/bootstrap5@6.1.15/index.global.min.js" integrity="sha256-TslkUnYKZuqQj4Ueu1WQesikFvl2DADWslCx3EfBHZM=" crossorigin="anonymous"></script>
-<script src="{% static 'coderedcms/js/crx-events.js' %}?v={% coderedcms_version %}"></script>
+<script src="{% static 'coderedcms/js/crx-events.min.js' %}?v={% coderedcms_version %}"></script>
 {% endblock %}

coderedcms/templates/coderedcms/pages/location_index_page.html

@@ -38,6 +38,6 @@
 {% endblock %}
 {% block coderedcms_scripts %}
 {{ block.super }}
-<script src="{% static 'coderedcms/js/crx-maps.js' %}?v={% coderedcms_version %}"></script>
+<script src="{% static 'coderedcms/js/crx-maps.min.js' %}?v={% coderedcms_version %}"></script>
 <script defer src="https://maps.googleapis.com/maps/api/js?key={{ google_api_key }}&callback=initMap&libraries=places"></script>
 {% endblock %}

coderedcms/templates/coderedcms/pages/stream_form_page.html

@@ -57,5 +57,5 @@
 {% block coderedcms_scripts %}
 {{ block.super }}
 <script src="https://cdn.jsdelivr.net/npm/jquery@3.7.1/dist/jquery.min.js" integrity="sha256-/JqT3SQfawRcv/BIHPThkBvs0OEvtFFmqPF/lYI/Cxo=" crossorigin="anonymous"></script>
-<script src="{% static 'coderedcms/js/crx-streamforms.js' %}?v={% coderedcms_version %}"></script>
+<script src="{% static 'coderedcms/js/crx-streamforms.min.js' %}?v={% coderedcms_version %}"></script>
 {% endblock %}

docs/contributing/index.rst

@@ -112,7 +112,7 @@ license header comment states copyright, ownership, license, and also provides c
 
     /*!
     Wagtail CRX (https://www.coderedcorp.com/cms/)
-    Copyright 2018-2023 CodeRed LLC
+    Copyright 2018-2025 CodeRed LLC
     License: https://github.com/coderedcorp/coderedcms/blob/main/LICENSE
     @license magnet:?xt=urn:btih:c80d50af7d3db9be66a4d0a86db0286e4fd33292&dn=bsd-3-clause.txt BSD-3-Clause
     */
@@ -121,6 +121,12 @@ license header comment states copyright, ownership, license, and also provides c
 
     /* @license-end */
 
+When editing JavaScript files, be sure to minify them. The minified files must also be committed to version control as they are distributed as part of our package.
+
+.. code-block:: console
+
+   $ python minify.py
+
 
 Upgrading 3rd-Party CSS/JavaScript Libraries
 --------------------------------------------

minify.py

@@ -0,0 +1,22 @@
+"""
+Utility to minify JavaScript.
+Run this after modifiying JavaScript files, before committing.
+"""
+
+from pathlib import Path
+
+from jsmin import jsmin
+
+
+JSDIR = Path("coderedcms") / "static" / "coderedcms" / "js"
+
+# iterate directory
+for entry in JSDIR.iterdir():
+    if entry.is_file() and entry.suffixes == [".js"]:
+        print(f"Minifying {entry}")
+        minified = ""
+        with open(entry, "r", encoding="utf8") as f:
+            minified = jsmin(f.read())
+        newpath = entry.parent / (entry.stem + ".min.js")
+        with open(newpath, "w", encoding="utf8", newline="\n") as f:
+            f.write(minified)

requirements-dev.txt

@@ -3,6 +3,7 @@
 
 # Requirements, in addition to coderedcms, needed for development.
 build
+jsmin
 libsass
 setuptools>=65.5
 twine