Wrap date outputs in span element for styling

Author: timvink

mkdocs_git_revision_date_localized_plugin/util.py

@@ -64,7 +64,7 @@ def _date_formats(
             + loc_revision_date.strftime("%H:%M:%S"),
             "iso_date": loc_revision_date.strftime("%Y-%m-%d"),
             "iso_datetime": loc_revision_date.strftime("%Y-%m-%d %H:%M:%S"),
-            "timeago": "<span class='timeago' datetime='%s' locale='%s'></span>"
+            "timeago": '<span class="timeago" datetime="%s" locale="%s"></span>'
             % (loc_revision_date.isoformat(), locale),
         }
 
@@ -132,6 +132,15 @@ def get_revision_date_for_file(
                     % path
                 )
 
-        return self._date_formats(
+        date_formats = self._date_formats(
             unix_timestamp=unix_timestamp, time_zone=time_zone, locale=locale
         )
+
+        # Wrap in <span> for styling
+        for date_type, date_string in date_formats.items():
+            date_formats[date_type] = (
+                '<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-%s">%s</span>'
+                % (date_type, date_string)
+            )
+
+        return date_formats

tests/test_builds.py

@@ -200,7 +200,7 @@ def validate_build(testproject_path, plugin_config: dict = {}):
         fallback_to_build_date=plugin_config.get("fallback_to_build_date"),
     )
 
-    searches = [re.search(x, contents) for x in date_formats.values()]
+    searches = [x in contents for x in date_formats.values()]
     assert any(searches), "No correct date formats output was found"
 
 
@@ -240,7 +240,7 @@ def test_date_formats():
         "datetime": "February 22, 2020 18:52:09",
         "iso_date": "2020-02-22",
         "iso_datetime": "2020-02-22 18:52:09",
-        "timeago": "<span class='timeago' datetime='2020-02-22T18:52:09+00:00' locale='en'></span>",
+        "timeago": '<span class="timeago" datetime="2020-02-22T18:52:09+00:00" locale="en"></span>',
     }
 
 
@@ -301,7 +301,7 @@ def test_build_material_theme(tmp_path):
     # in German because locale is set to 'de'
     index_file = testproject_path / "site/index.html"
     contents = index_file.read_text(encoding="utf8")
-    assert re.search(r"Letztes Update\:\s[\w].+", contents)
+    assert re.search(r"Letztes Update\:\s[<span class].+", contents)
 
 
 def test_material_theme_locale(tmp_path):
@@ -318,7 +318,7 @@ def test_material_theme_locale(tmp_path):
     # The date will be in german though
     index_file = testproject_path / "site/index.html"
     contents = index_file.read_text(encoding="utf8")
-    assert re.search(r"Last update\:\s[\w].+", contents)
+    assert re.search(r"Last update\:\s[<span class].+", contents)
 
 
 def test_material_theme_no_locale(tmp_path):
@@ -334,7 +334,7 @@ def test_material_theme_no_locale(tmp_path):
     # in German because locale is set to 'de'
     index_file = testproject_path / "site/index.html"
     contents = index_file.read_text(encoding="utf8")
-    assert re.search(r"Last update\:\s[\w].+", contents)
+    assert re.search(r"Last update\:\s[<span class].+", contents)
 
 
 def test_type_timeago(tmp_path):