Write 'searchindex.js' using minimal JSON separators (#13062)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
sphinx-doc · Oct 24, 2024 · b75e695 · b75e695
1 parent 8042eb6
commit b75e695
Show file tree

Hide file tree

Showing 6 changed files with 8 additions and 7 deletions.
diff --git a/sphinx/search/__init__.py b/sphinx/search/__init__.py
@@ -164,7 +164,8 @@ class _JavaScriptIndex:
     SUFFIX = ')'
 
     def dumps(self, data: Any) -> str:
-        return self.PREFIX + json.dumps(data, sort_keys=True) + self.SUFFIX
+        data_json = json.dumps(data, separators=(',', ':'), sort_keys=True)
+        return self.PREFIX + data_json + self.SUFFIX
 
     def loads(self, s: str) -> Any:
         data = s[len(self.PREFIX) : -len(self.SUFFIX)]

diff --git a/tests/js/fixtures/cpp/searchindex.js b/tests/js/fixtures/cpp/searchindex.js
diff --git a/tests/js/fixtures/multiterm/searchindex.js b/tests/js/fixtures/multiterm/searchindex.js
diff --git a/tests/js/fixtures/partial/searchindex.js b/tests/js/fixtures/partial/searchindex.js
diff --git a/tests/js/fixtures/titles/searchindex.js b/tests/js/fixtures/titles/searchindex.js
diff --git a/tests/test_search.py b/tests/test_search.py
@@ -152,8 +152,8 @@ def test_term_in_heading_and_section(app):
     # if search term is in the title of one doc and in the text of another
     # both documents should be a hit in the search index as a title,
     # respectively text hit
-    assert '"textinhead": 2' in searchindex
-    assert '"textinhead": 0' in searchindex
+    assert '"textinhead":2' in searchindex
+    assert '"textinhead":0' in searchindex
 
 
 @pytest.mark.sphinx('html', testroot='search')