Move the configuration into a JSON blob

Author: matthiask

.pre-commit-config.yaml

@@ -14,27 +14,26 @@ repos:
       - id: mixed-line-ending
       - id: trailing-whitespace
   - repo: https://github.com/adamchainz/django-upgrade
-    rev: 1.22.1
+    rev: 1.24.0
     hooks:
       - id: django-upgrade
         args: [--target-version, "3.2"]
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: "v0.8.0"
+    rev: "v0.11.5"
     hooks:
       - id: ruff
         args: [--unsafe-fixes]
       - id: ruff-format
   - repo: https://github.com/biomejs/pre-commit
-    rev: "v0.5.0"
+    rev: "v1.9.4"
     hooks:
       - id: biome-check
-        additional_dependencies: ["@biomejs/[email protected]"]
         args: [--unsafe]
   - repo: https://github.com/tox-dev/pyproject-fmt
-    rev: v2.5.0
+    rev: v2.5.1
     hooks:
       - id: pyproject-fmt
   - repo: https://github.com/abravalheri/validate-pyproject
-    rev: v0.23
+    rev: v0.24.1
     hooks:
       - id: validate-pyproject

CHANGELOG.rst

@@ -8,6 +8,9 @@ Next version
 - Removed mentions of the ``Template`` type from the docs and deprecated the
   class. django-content-editor never used it, only FeinCMS did; feincms3 ships
   its own ``TemplateType`` type replacing it.
+- Prepared for the new object-based ``Script`` by moving from django-js-asset's
+  ``JS`` to a script without attributes, and moved the configuration into an
+  inline JSON blob.
 
 
 7.2 (2025-01-27)

content_editor/admin.py

@@ -8,7 +8,7 @@
 from django.core import checks
 from django.utils.text import capfirst
 from django.utils.translation import gettext
-from js_asset.js import JS
+from js_asset.js import JSON
 
 
 __all__ = ("ContentEditorInline", "ContentEditor", "allow_regions", "deny_regions")
@@ -220,13 +220,11 @@ def _content_editor_media(self, request, context):
                 "admin/js/jquery.init.js",
                 "content_editor/save_shortcut.js",
                 "content_editor/tabbed_fieldsets.js",
-                JS(
-                    "content_editor/content_editor.js",
-                    {
-                        "id": "content-editor-context",
-                        "data-context": self._content_editor_context(request, context),
-                    },
+                JSON(
+                    self._content_editor_context(request, context),
+                    id="content-editor-context",
                 ),
+                "content_editor/content_editor.js",
             ],
         )
 

content_editor/static/content_editor/content_editor.js

@@ -1,6 +1,8 @@
 /* global django,ContentEditor */
 ;(() => {
-  const _contentEditorContext = document.currentScript.dataset.context
+  const _contentEditorContext = document.getElementById(
+    "content-editor-context",
+  ).textContent
 
   function qs(sel, ctx = document) {
     return ctx.querySelector(sel)

pyproject.toml

@@ -35,7 +35,7 @@ dynamic = [
 ]
 dependencies = [
   "django>=3.2",
-  "django-js-asset",
+  "django-js-asset>=3",
 ]
 optional-dependencies.tests = [
   "coverage",

tests/testapp/test_content_editor.py

@@ -78,8 +78,9 @@ def test_stuff(client):
 def test_admin(client):
     response = client.get(reverse("admin:testapp_article_add"))
 
-    assertContains(response, '_editor.js" data-context="{"', 1)
-    assertContains(response, 'id="content-editor-context"></sc', 1)
+    assertContains(
+        response, '<script id="content-editor-context" type="application/json">'
+    )
     assertContains(response, 'class="richtext"', 1)
     assertContains(
         response,
@@ -177,8 +178,7 @@ class ModelAdmin(ContentEditor):
 
     assert ModelAdmin(Model, admin.AdminSite()).check() == [
         checks.Error(
-            "ContentEditor models require a non-empty 'regions'"
-            " attribute or property.",
+            "ContentEditor models require a non-empty 'regions' attribute or property.",
             obj=ModelAdmin,
             id="content_editor.E002",
         )