Renaming option from ignore_missing_git to fallback_to_build_date

Author: Guts

README.md

@@ -87,7 +87,7 @@ Specify a two letter [ISO639](https://en.wikipedia.org/wiki/List_of_ISO_639-1_co
 - When used in combination with `type: timeago` then [timeago.js](https://github.com/hustcc/timeago.js) is added to your website, which supports [these locales](https://github.com/hustcc/timeago.js/tree/master/src/lang). If you specify a locale not supported by timeago.js, the fallback is English (`en`)
 - When not set, this plugin will look for `locale` or `language` options set in your theme. If also not set, the fallback is English (`en`)
 
-### `ignore_missing_git`
+### `fallback_to_build_date`
 
 If you need to ignore the Git exceptions during `git log` operations, set this option to `true` (default is `false`).
 
@@ -105,7 +105,7 @@ plugins:
   - git-revision-date-localized:
     locale: en
     type: timeago
-    ignore_missing_git: true
+    fallback_to_build_date: true
 ```
 
 Result:

mkdocs_git_revision_date_localized_plugin/plugin.py

@@ -12,7 +12,7 @@
 
 class GitRevisionDateLocalizedPlugin(BasePlugin):
     config_scheme = (
-        ("ignore_missing_git", config_options.Type(bool, default=False)),
+        ("fallback_to_build_date", config_options.Type(bool, default=False)),
         ("locale", config_options.Type(str, default="")),
         ("type", config_options.Type(str, default="date")),
     )
@@ -119,7 +119,7 @@ def on_page_markdown(
         revision_dates = self.util.get_revision_date_for_file(
             path=page.file.abs_src_path,
             locale=self.locale,
-            ignore_missing_git=self.config.get("ignore_missing_git"),
+            fallback_to_build_date=self.config.get("fallback_to_build_date"),
         )
         revision_date = revision_dates[self.config["type"]]
         page.meta["git_revision_date_localized"] = revision_date

mkdocs_git_revision_date_localized_plugin/util.py

@@ -69,7 +69,7 @@ def _date_formats(unix_timestamp: float, locale="en") -> dict:
         }
 
     def get_revision_date_for_file(
-        self, path: str, locale: str = "en", ignore_missing_git: bool = False
+        self, path: str, locale: str = "en", fallback_to_build_date: bool = False
     ) -> dict:
         """
         Determine localized date variants for a given file
@@ -85,7 +85,7 @@ def get_revision_date_for_file(
         try:
             unix_timestamp = self.repo.log(path, n=1, date="short", format="%at")
         except GitCommandError as err:
-            if ignore_missing_git:
+            if fallback_to_build_date:
                 unix_timestamp = None
                 logging.warning(
                     "Unable to read git logs of '%s'."
@@ -100,7 +100,7 @@ def get_revision_date_for_file(
                 )
                 raise err
         except GitCommandNotFound as err:
-            if ignore_missing_git:
+            if fallback_to_build_date:
                 unix_timestamp = None
                 logging.warning(
                     "Unable to perform command: git log. Is git installed?"

tests/basic_setup/mkdocs_ignore_missing_git.yml

@@ -4,4 +4,4 @@ use_directory_urls: true
 plugins:
     - search
     - git-revision-date-localized:
-        ignore_missing_git: true
+        fallback_to_build_date: true

tests/test_basic.py

@@ -222,7 +222,7 @@ def test_missing_git_repo_ignored(tmp_path):
     When there is no GIT repo, the git error should be ignored.
     """
     testproject_path = setup_clean_mkdocs_folder(
-        mkdocs_yml_path="tests/basic_setup/mkdocs_ignore_missing_git.yml",
+        mkdocs_yml_path="tests/basic_setup/mkdocs_fallback_to_build_date.yml",
         output_path=tmp_path,
     )