mkdocs-document-dates 3.1.3__tar.gz → 3.1.6__tar.gz

mkdocs_document_dates-3.1.6/MANIFEST.in

@@ -0,0 +1,2 @@
+global-exclude tests/*
+global-exclude tests/**/*

{mkdocs_document_dates-3.1.3 → mkdocs_document_dates-3.1.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocs-document-dates
-Version: 3.1.3
+Version: 3.1.6
 Summary: An easy-to-use, lightweight MkDocs plugin for displaying the exact creation time, last modification time and author info of markdown documents.
 Home-page: https://github.com/jaywhj/mkdocs-document-dates
 Author: Aaron Wang
@@ -12,7 +12,7 @@ Classifier: Operating System :: OS Independent
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: mkdocs>=1.0.0
+Requires-Dist: mkdocs>=1.1.0
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier
@@ -35,17 +35,14 @@ An easy-to-use, lightweight MkDocs plugin for displaying the <mark>exact</mark>
 
 ## Features
 
-- Work in any environment, for Git-less environments, CI/CD environments (e.g. GitHub Actions), one-person collaboration, multi-person collaboration, etc
-- Support for manually specifying time and author info in `Front Matter`
+- Always display exact meta-info of the document for any environment (no-Git, Git, all CI/CD build systems, etc)
+- Support for manually specifying time and author in `Front Matter`
 - Support for multiple time formats (date, datetime, timeago)
-- Support for document exclusion mode
 - Flexible display position (top or bottom)
 - Elegant styling (fully customizable)
 - Supports Tooltip Hover Tips
   - Intelligent repositioning to always float optimally in view
   - Supports automatic theme switching following Material's light/dark color scheme
-  - Support for customizing themes, styles, animations
-  - Compatible with mouse, keyboard and **touch** (mobile) to trigger hover
 - Multi-language support, cross-platform support (Windows, macOS, Linux)
 
 ## Showcases
@@ -74,23 +71,20 @@ plugins:
   - document-dates:
       position: top            # Display position: top (after title)  bottom (end of document), default: bottom
       type: date               # Date type: date  datetime  timeago, default: date
-      locale: en               # Localization: zh zh_TW en es fr de ar ja ko ru, default: en
-      date_format: '%Y-%m-%d'  # Date format, supports all python datetime format strings, e.g., %Y-%m-%d, %b %d, %Y, etc
-      time_format: '%H:%M:%S'  # Time format (valid only if type=datetime)
+      locale: en               # Localization: en zh zh_TW es fr de ar ja ko ru, default: en
+      date_format: '%Y-%m-%d'  # Date format strings, e.g., %Y-%m-%d, %b %d, %Y, etc
+      time_format: '%H:%M:%S'  # Time format strings (valid only if type=datetime)
       exclude:                 # List of excluded files
         - temp.md              # Exclude specific file
         - private/*            # Exclude all files in private directory, including subdirectories
-        - drafts/*.md          # Exclude all markdown files in the current directory drafts, but not subdirectories
-      
-      show_author: true        # Show author or not: true false, default: true
-
+      show_author: true        # Show author or not, default: true
 ```
 
 ## Specify time manually
 
 The plugin will automatically get the exact time of the document, will automatically cache the creation time, but of course, you can also specify it manually in `Front Matter`
 
-Priority: `Front Matter` > `Cache Files` > `File System Timestamps`
+Priority order: `Front Matter` > `Cache Files` > `File System Timestamps`
 
 ```yaml
 ---
@@ -108,7 +102,7 @@ modified: 2025-02-23
 
 The plugin will automatically get the author of the document, will parse the email and make a link, also you can specify it manually in `Front Matter`
 
-Priority: `Front Matter` > `Git Author Info` > `PC Username`
+Priority order: `Front Matter` > `Git Author` > `site_author (mkdocs.yml)` > `PC Username`
 
 ```yaml
 ---
@@ -124,26 +118,67 @@ email: e-name@gmail.com
 
 ## Customization
 
-The plugin supports deep customization, such as icon style, font style, theme color, animation type, dividing line, etc. All of it can be customized by modifying the code in the corresponding file (I've already written the code and comments, you just need to turn on the switch and change the value):
+The plugin supports deep customization, such as **icon style, font style, theme color, animation type, dividing line**, etc. Everything is customizable (I've already written the code, you just need to turn on the uncomment switch):
+
+|        Function：        | Location：                               |
+| :----------------------: | ---------------------------------------- |
+|     **Style & Theme**     | `docs/assets/document_dates/user.config.css` |
+| **Properties & Functions** | `docs/assets/document_dates/user.config.js` |
+| **Localized languages** | `docs/assets/document_dates/languages/` <br />refer to the template file `en.json` for any additions or modifications |
+
+**Tip**: when `type: timeago` is set, timeago.js is enabled to render dynamic time, `timeago.min.js` only contains English and Chinese by default, if you need to load other languages, you can configure it as below (choose one):
+
+- In `user.config.js`, refer to [the demo commented out](https://github.com/jaywhj/mkdocs-document-dates/blob/main/mkdocs_document_dates/static/config/user.config.js) at the bottom, translate it into your local language
+- In `mkdocs.yml`, add the following two lines to configure the full version of `timeago.full.min.js` to load all languages at once
+    ```yaml
+    extra_javascript:
+      - assets/document_dates/core/timeago.full.min.js
+      - assets/document_dates/core/timeago-load.js
+    ```
+
+**Demo Images**:
+
+![01-default-w](mkdocs_document_dates/demo_images/01-default-w.png)
+![02-change-icon](mkdocs_document_dates/demo_images/02-change-icon.png)
+![02-change-icon-color](mkdocs_document_dates/demo_images/02-change-icon-color.png)
+![04-default-pop-up](mkdocs_document_dates/demo_images/04-default-pop-up.png)
+![05-change-theme](mkdocs_document_dates/demo_images/05-change-theme.png)
+
+![06-change-theme](mkdocs_document_dates/demo_images/06-change-theme.png)
+![08-pop-up-from-bottom](mkdocs_document_dates/demo_images/08-pop-up-from-bottom.png)
+
+## Used in templates
+
+You can access the meta-info of a document in a template using the following variables:
+
+- page.meta.document_dates_created
+- page.meta.document_dates_modified
+- page.meta.document_dates_authors
+
+For example like this:
+
+```jinja2
+<div><span>{{ page.meta.document_dates_created }}</span></div>
+<div><span>{{ page.meta.document_dates_modified }}</span></div>
+{% set authors = page.meta.document_dates_authors %}
+{% if authors %}
+<div>
+    {% for author in authors %}
+    {% if author.email %}<a href="mailto:{{ author.email }}">{{ author.name }}</a>
+    {% else %}<span>{{ author.name }}</span>{% endif %}
+    {% endfor %}
+</div>
+{% endif %}
+```
 
-- Style & Theme: `docs/assets/document_dates/user.config.css`
-- Properties & Animations: `docs/assets/document_dates/user.config.js`
-- Localized languages: `docs/assets/document_dates/languages/` , refer to the template file `en.json` for any additions or modifications
-- timeago.js localization: `timeago.min.js` only contains English and Chinese by default, if you need to load other languages, you can configure it as below (choose one):
-    - In `user.config.js`, refer to [the demo commented out](https://github.com/jaywhj/mkdocs-document-dates/blob/main/mkdocs_document_dates/static/config/user.config.js) at the bottom, translate it into your local language
-    - In `mkdocs.yml`, add the following two lines to configure the full version of `timeago.full.min.js` to load all languages at once
-        ```yaml
-        extra_javascript:
-          - assets/document_dates/core/timeago.full.min.js
-          - assets/document_dates/core/timeago-load.js
-        ```
+**Full example**: set the correct lastmod for [sitemap.xml](https://github.com/jaywhj/mkdocs-document-dates/blob/main/sitemap.xml) so that search engines can better handle SEO and thus increase your site's exposure (override path: `docs/overrides/sitemap.xml`)
 
 ## Other Tips
 
-- In order to get the exact creation time, a separate cache file is used to store the creation time of the file, located in the doc folder (hidden by default), please don't delete it:
+- In order to always get the exact creation time, a separate cache file is used to store the creation time of the document, located in the docs folder (hidden by default), please don't remove it:
     - `docs/.dates_cache.jsonl`, cache file
     - `docs/.gitattributes`, merge mechanism for cache file
-- The Git Hooks mechanism is used to automatically trigger the storing of the cache (on each git commit), and the cached file is automatically committed along with it. In addition, the installation of Git Hooks is automatically triggered when the plugin is installed, without any manual intervention!
+- The Git Hooks mechanism is used to automatically trigger the storing of the cache (on each git commit), and the cached file is automatically committed along with it, in addition, the installation of Git Hooks is automatically triggered when the plugin is installed, without any manual intervention!
 
 <br />
 
@@ -152,11 +187,11 @@ The plugin supports deep customization, such as icon style, font style, theme co
 A dispensable, insignificant little plug-in, friends who have time can take a look \^\_\^ 
 
 - **Origin**:
-    - Because [mkdocs-git-revision-date-localized-plugin](https://github.com/timvink/mkdocs-git-revision-date-localized-plugin), a great project. When I used it at the end of 2024, I found that I couldn't use it locally because my mkdocs documentation was not included in git management, then I don't understand why not read the file system time, but to use the git time, and raised an issue to the author, but didn't get a reply for about a week (the author had a reply later, nice guy, I guess he was busy at the time), and then I thought, there is nothing to do during the Chinese New Year, and now AI is so hot, why not with the help of the AI try it out for myself, it was born, born in February 2025
+    - Because [mkdocs-git-revision-date-localized-plugin](https://github.com/timvink/mkdocs-git-revision-date-localized-plugin), a great project. When I used it at the end of 2024, I found that I couldn't use it locally because my mkdocs documentation was not included in git management, I don't understand why not read the file system time, but to use the git time, and the filesystem time is exact, then raised an issue to the author, but didn't get a reply for about a week (the author had a reply later, nice guy, I guess he was busy at the time), and then I thought, there is nothing to do during the Chinese New Year, and now AI is so hot, why not with the help of the AI try it out for myself, it was born, born in February 2025
 - **Iteration**:
-    - After development, I understood why not use filesystem time, because files will be rebuilt when they go through git checkout or clone, resulting in the loss of original timestamp information, and there are many solutions:
-    - Method 1: Use the last git commit time as the last update time, and the first git commit time as the creation (there is a margin of error, but it's acceptable), mkdocs-git-revision-date-localized-plugin does this
-    - Method 2: You can cache the original time, and then read the cache subsequently. The cache can be in Front Matter of the source document or in a separate file, I chose the latter. Storing in Front Matter makes sense and is simple, but this will modify the source content of the document, although it doesn't have any impact on the body, but I still want to ensure the originality of the data!
+    - After development, I understood why not use filesystem time, because files will be rebuilt when they go through git checkout or clone, resulting in the loss of original timestamp information. There are many solutions:
+    - Method 1: Use the last git commit time as the last update time and the first git commit time as the creation time, mkdocs-git-revision-date-localized-plugin does this. (This way, there will be a margin of error and dependency on git)
+    - Method 2: Cache the original time in advance, and then read the cache subsequently (The time is exact and no dependency on any environment). The cache can be in Front Matter of the source document or in a separate file, I chose the latter. Storing in Front Matter makes sense and is easier, but this will modify the source content of the document, although it doesn't have any impact on the body, but I still want to ensure the originality of the data!
 - **Difficulty**:
     1. When to read and store original time? This is just a plugin for mkdocs, with very limited access and permissions, mkdocs provides only build and serve, so in case a user commits directly without executing build or serve (e.g., when using a CI/CD build system), then you won't be able to retrieve the time information of the file, not to mention caching it!
         - Let's take a straight shot: the Git Hooks mechanism was found, prompted by the AI, which can trigger a custom script when a specific git action occurs, such as every time commit is performed
@@ -167,10 +202,10 @@ A dispensable, insignificant little plug-in, friends who have time can take a lo
     4. How can I ensure that a single cache file does not conflict when collaborating with multi-person?
         - Workaround: use JSONL (JSON Lines) instead of JSON, and with the merge strategy 'merge=union'
 - **Improve**:
-    - Since it has been re-developed, it will be designed in the direction of **excellent products**, and the pursuit of the ultimate **ease of use, simplicity and personalization**
-        - Ease of use: don't let users do things manually if you can, e.g., auto-install Git Hooks, auto-cache, auto-commit, provide customized templates, etc
-        - Simplicity: no unnecessary configurations, the less the simpler, e.g. git account information, repo information, etc., are not required
-        - Personalization: almost everything can be customized, whether it's icons, styles, themes, or features, it's all fully customizable
+    - Since it's a newly developed plugin, it will be designed in the direction of **excellent products**, and the pursuit of the ultimate **ease of use, simplicity and personalization**
+        - **Ease of use**: don't let users do things manually if you can, e.g., auto-install Git Hooks, auto-cache, auto-commit, provide customized templates, etc
+        - **Simplicity**: no unnecessary configuration, no Git dependencies, no CI/CD configuration dependencies, no other package dependencies
+        - **Personalization**: almost everything can be customized, whether it's icons, styles, themes, or features, it's all fully customizable
     - In addition, it has good compatibility and extensibility, and works well in WIN7, mobile devices, old Safari, etc
 - **The Last Secret**:
     - Programming is a hobby, and I'm a marketer of 8 years (Feel free to leave a comment)

mkdocs_document_dates-3.1.6/README.md

@@ -0,0 +1,184 @@
+# mkdocs-document-dates
+
+English | [简体中文](README_zh.md)
+
+
+
+An easy-to-use, lightweight MkDocs plugin for displaying the <mark>exact</mark> creation time, last modification time and author info of markdown documents.
+
+## Features
+
+- Always display exact meta-info of the document for any environment (no-Git, Git, all CI/CD build systems, etc)
+- Support for manually specifying time and author in `Front Matter`
+- Support for multiple time formats (date, datetime, timeago)
+- Flexible display position (top or bottom)
+- Elegant styling (fully customizable)
+- Supports Tooltip Hover Tips
+  - Intelligent repositioning to always float optimally in view
+  - Supports automatic theme switching following Material's light/dark color scheme
+- Multi-language support, cross-platform support (Windows, macOS, Linux)
+
+## Showcases
+
+![render](render.gif)
+
+## Installation
+
+```bash
+pip install mkdocs-document-dates
+```
+
+## Configuration
+
+Just add the plugin to your `mkdocs.yml`:
+
+```yaml
+plugins:
+  - document-dates
+```
+
+Or, personalize the configuration:
+
+```yaml
+plugins:
+  - document-dates:
+      position: top            # Display position: top (after title)  bottom (end of document), default: bottom
+      type: date               # Date type: date  datetime  timeago, default: date
+      locale: en               # Localization: en zh zh_TW es fr de ar ja ko ru, default: en
+      date_format: '%Y-%m-%d'  # Date format strings, e.g., %Y-%m-%d, %b %d, %Y, etc
+      time_format: '%H:%M:%S'  # Time format strings (valid only if type=datetime)
+      exclude:                 # List of excluded files
+        - temp.md              # Exclude specific file
+        - private/*            # Exclude all files in private directory, including subdirectories
+      show_author: true        # Show author or not, default: true
+```
+
+## Specify time manually
+
+The plugin will automatically get the exact time of the document, will automatically cache the creation time, but of course, you can also specify it manually in `Front Matter`
+
+Priority order: `Front Matter` > `Cache Files` > `File System Timestamps`
+
+```yaml
+---
+created: 2023-01-01
+modified: 2025-02-23
+---
+
+# Document Title
+```
+
+- `created` can be replaced with: `created, date, creation`
+- `modified` can be replaced with: `modified, updated, last_modified, last_updated`
+
+## Specify author manually
+
+The plugin will automatically get the author of the document, will parse the email and make a link, also you can specify it manually in `Front Matter`
+
+Priority order: `Front Matter` > `Git Author` > `site_author (mkdocs.yml)` > `PC Username`
+
+```yaml
+---
+author: any-name
+email: e-name@gmail.com
+---
+
+# Document Title
+```
+
+- `author` can be replaced with: `author, name`
+- `email` can be replaced with: `email, mail`
+
+## Customization
+
+The plugin supports deep customization, such as **icon style, font style, theme color, animation type, dividing line**, etc. Everything is customizable (I've already written the code, you just need to turn on the uncomment switch):
+
+|        Function：        | Location：                               |
+| :----------------------: | ---------------------------------------- |
+|     **Style & Theme**     | `docs/assets/document_dates/user.config.css` |
+| **Properties & Functions** | `docs/assets/document_dates/user.config.js` |
+| **Localized languages** | `docs/assets/document_dates/languages/` <br />refer to the template file `en.json` for any additions or modifications |
+
+**Tip**: when `type: timeago` is set, timeago.js is enabled to render dynamic time, `timeago.min.js` only contains English and Chinese by default, if you need to load other languages, you can configure it as below (choose one):
+
+- In `user.config.js`, refer to [the demo commented out](https://github.com/jaywhj/mkdocs-document-dates/blob/main/mkdocs_document_dates/static/config/user.config.js) at the bottom, translate it into your local language
+- In `mkdocs.yml`, add the following two lines to configure the full version of `timeago.full.min.js` to load all languages at once
+    ```yaml
+    extra_javascript:
+      - assets/document_dates/core/timeago.full.min.js
+      - assets/document_dates/core/timeago-load.js
+    ```
+
+**Demo Images**:
+
+![01-default-w](mkdocs_document_dates/demo_images/01-default-w.png)
+![02-change-icon](mkdocs_document_dates/demo_images/02-change-icon.png)
+![02-change-icon-color](mkdocs_document_dates/demo_images/02-change-icon-color.png)
+![04-default-pop-up](mkdocs_document_dates/demo_images/04-default-pop-up.png)
+![05-change-theme](mkdocs_document_dates/demo_images/05-change-theme.png)
+
+![06-change-theme](mkdocs_document_dates/demo_images/06-change-theme.png)
+![08-pop-up-from-bottom](mkdocs_document_dates/demo_images/08-pop-up-from-bottom.png)
+
+## Used in templates
+
+You can access the meta-info of a document in a template using the following variables:
+
+- page.meta.document_dates_created
+- page.meta.document_dates_modified
+- page.meta.document_dates_authors
+
+For example like this:
+
+```jinja2
+<div><span>{{ page.meta.document_dates_created }}</span></div>
+<div><span>{{ page.meta.document_dates_modified }}</span></div>
+{% set authors = page.meta.document_dates_authors %}
+{% if authors %}
+<div>
+    {% for author in authors %}
+    {% if author.email %}<a href="mailto:{{ author.email }}">{{ author.name }}</a>
+    {% else %}<span>{{ author.name }}</span>{% endif %}
+    {% endfor %}
+</div>
+{% endif %}
+```
+
+**Full example**: set the correct lastmod for [sitemap.xml](https://github.com/jaywhj/mkdocs-document-dates/blob/main/sitemap.xml) so that search engines can better handle SEO and thus increase your site's exposure (override path: `docs/overrides/sitemap.xml`)
+
+## Other Tips
+
+- In order to always get the exact creation time, a separate cache file is used to store the creation time of the document, located in the docs folder (hidden by default), please don't remove it:
+    - `docs/.dates_cache.jsonl`, cache file
+    - `docs/.gitattributes`, merge mechanism for cache file
+- The Git Hooks mechanism is used to automatically trigger the storing of the cache (on each git commit), and the cached file is automatically committed along with it, in addition, the installation of Git Hooks is automatically triggered when the plugin is installed, without any manual intervention!
+
+<br />
+
+## Development Stories (Optional)
+
+A dispensable, insignificant little plug-in, friends who have time can take a look \^\_\^ 
+
+- **Origin**:
+    - Because [mkdocs-git-revision-date-localized-plugin](https://github.com/timvink/mkdocs-git-revision-date-localized-plugin), a great project. When I used it at the end of 2024, I found that I couldn't use it locally because my mkdocs documentation was not included in git management, I don't understand why not read the file system time, but to use the git time, and the filesystem time is exact, then raised an issue to the author, but didn't get a reply for about a week (the author had a reply later, nice guy, I guess he was busy at the time), and then I thought, there is nothing to do during the Chinese New Year, and now AI is so hot, why not with the help of the AI try it out for myself, it was born, born in February 2025
+- **Iteration**:
+    - After development, I understood why not use filesystem time, because files will be rebuilt when they go through git checkout or clone, resulting in the loss of original timestamp information. There are many solutions:
+    - Method 1: Use the last git commit time as the last update time and the first git commit time as the creation time, mkdocs-git-revision-date-localized-plugin does this. (This way, there will be a margin of error and dependency on git)
+    - Method 2: Cache the original time in advance, and then read the cache subsequently (The time is exact and no dependency on any environment). The cache can be in Front Matter of the source document or in a separate file, I chose the latter. Storing in Front Matter makes sense and is easier, but this will modify the source content of the document, although it doesn't have any impact on the body, but I still want to ensure the originality of the data!
+- **Difficulty**:
+    1. When to read and store original time? This is just a plugin for mkdocs, with very limited access and permissions, mkdocs provides only build and serve, so in case a user commits directly without executing build or serve (e.g., when using a CI/CD build system), then you won't be able to retrieve the time information of the file, not to mention caching it!
+        - Let's take a straight shot: the Git Hooks mechanism was found, prompted by the AI, which can trigger a custom script when a specific git action occurs, such as every time commit is performed
+    2. How to install Git Hooks automatically? When and how are they triggered? Installing packages from PyPI via pip doesn't have a standard post-install hook mechanism
+        - Workaround: After analyzing the flow of pip installing packages from PyPI, I found that when compiling and installing through the source package (sdist), setuptools will be called to handle it, so we can find a way to implant the installation script in the process of setuptools, i.e., we can add a custom script in setup.py
+    3. How to design a cross-platform hook? To execute a python script, we need to explicitly specify the python interpreter, and the user's python environment varies depending on the operating system, the way python is installed, and the configuration, so how can we ensure that it works properly in all environments?
+        - Solution: I considered using a shell script, but since I'd have to call back to python eventually, it's easier to use a python script. We can detect the user's python environment when the hook is installed, and then dynamically set the hook's shebang line to set the correct python interpreter
+    4. How can I ensure that a single cache file does not conflict when collaborating with multi-person?
+        - Workaround: use JSONL (JSON Lines) instead of JSON, and with the merge strategy 'merge=union'
+- **Improve**:
+    - Since it's a newly developed plugin, it will be designed in the direction of **excellent products**, and the pursuit of the ultimate **ease of use, simplicity and personalization**
+        - **Ease of use**: don't let users do things manually if you can, e.g., auto-install Git Hooks, auto-cache, auto-commit, provide customized templates, etc
+        - **Simplicity**: no unnecessary configuration, no Git dependencies, no CI/CD configuration dependencies, no other package dependencies
+        - **Personalization**: almost everything can be customized, whether it's icons, styles, themes, or features, it's all fully customizable
+    - In addition, it has good compatibility and extensibility, and works well in WIN7, mobile devices, old Safari, etc
+- **The Last Secret**:
+    - Programming is a hobby, and I'm a marketer of 8 years (Feel free to leave a comment)

{mkdocs_document_dates-3.1.3 → mkdocs_document_dates-3.1.6}/mkdocs_document_dates/cache_manager.py

@@ -26,7 +26,7 @@ def find_mkdocs_projects():
                 projects.append(config_file.parent)
 
         if not projects:
-            logging.info("No MkDocs projects found in the repository")
+            logging.warning("No MkDocs projects found in the repository")
     except subprocess.CalledProcessError as e:
         logging.error(f"Failed to find the Git repository root: {e}")
     except Exception as e:
@@ -56,9 +56,9 @@ def get_git_first_commit_time(file_path):
         # git log --reverse --format="%aI" --date=iso -- {file_path} | head -n 1
         result = subprocess.run(['git', 'log', '--reverse', '--format=%aI', '--', file_path], capture_output=True, text=True)
         if result.returncode == 0:
-            commits = result.stdout.strip().split('\n')
-            if commits and commits[0]:
-                return datetime.fromisoformat(commits[0]).replace(tzinfo=None)
+            first_line = result.stdout.partition('\n')[0].strip()
+            if first_line:
+                return datetime.fromisoformat(first_line).replace(tzinfo=None)
     except Exception as e:
         logging.info(f"Error getting git first commit time for {file_path}: {e}")
     return None
@@ -67,7 +67,7 @@ def setup_gitattributes(docs_dir):
     updated = False
     try:
         gitattributes_path = docs_dir / '.gitattributes'
-        union_config_line = ".dates_cache.jsonl merge=union"        
+        union_config_line = ".dates_cache.jsonl merge=union"
         if gitattributes_path.exists():
             with open(gitattributes_path, 'r', encoding='utf-8') as f:
                 content = f.read()
@@ -98,7 +98,7 @@ def read_json_cache(cache_file):
             with open(cache_file, "r", encoding='utf-8') as f:
                 dates_cache = json.load(f)
         except (IOError, json.JSONDecodeError) as e:
-            logging.error(f"Failed to read existing JSON cache file: {e}")
+            logging.warning(f"Error reading from '.dates_cache.json': {str(e)}")
     return dates_cache
 
 def read_jsonl_cache(jsonl_file):
@@ -115,7 +115,7 @@ def read_jsonl_cache(jsonl_file):
                     except (json.JSONDecodeError, StopIteration) as e:
                         logging.warning(f"Skipping invalid JSONL line: {e}")
         except IOError as e:
-            logging.error(f"Failed to read existing JSONL cache file: {e}")
+            logging.warning(f"Error reading from '.dates_cache.jsonl': {str(e)}")
     return dates_cache
 
 def write_jsonl_cache(jsonl_file, dates_cache, tracked_files):
@@ -144,88 +144,81 @@ def write_jsonl_cache(jsonl_file, dates_cache, tracked_files):
 
 def update_cache():
     global_updated = False
-    try:
-        for project_dir in find_mkdocs_projects():
-            try:
-                project_updated = False
 
-                docs_dir = project_dir / 'docs'
-                if not docs_dir.exists():
-                    logging.error(f"Document directory does not exist: {docs_dir}")
-                    continue
+    for project_dir in find_mkdocs_projects():
+        try:
+            project_updated = False
 
-                # 设置.gitattributes文件
-                gitattributes_updated = setup_gitattributes(docs_dir)
-                if gitattributes_updated:
-                    global_updated = True
+            docs_dir = project_dir / 'docs'
+            if not docs_dir.exists():
+                logging.error(f"Document directory does not exist: {docs_dir}")
+                continue
 
-                # 获取docs目录下已跟踪(tracked)的markdown文件
-                cmd = ["git", "ls-files", "*.md"]
-                result = subprocess.run(cmd, cwd=docs_dir, capture_output=True, text=True, check=True)
-                tracked_files = result.stdout.splitlines() if result.stdout else []
-                
-                if not tracked_files:
-                    logging.info(f"No tracked markdown files found in {docs_dir}")
-                    continue
+            # 设置.gitattributes文件
+            gitattributes_updated = setup_gitattributes(docs_dir)
+            if gitattributes_updated:
+                global_updated = True
 
-                # 读取旧的JSON缓存文件（如果存在）
-                json_cache_file = docs_dir / '.dates_cache.json'
-                json_dates_cache = read_json_cache(json_cache_file)
+            # 获取docs目录下已跟踪(tracked)的markdown文件
+            cmd = ["git", "ls-files", "*.md"]
+            result = subprocess.run(cmd, cwd=docs_dir, capture_output=True, text=True, check=True)
+            tracked_files = result.stdout.splitlines() if result.stdout else []
 
-                # 读取新的JSONL缓存文件（如果存在）
-                jsonl_cache_file = docs_dir / '.dates_cache.jsonl'
-                jsonl_dates_cache = read_jsonl_cache(jsonl_cache_file)
-                
-                # 根据 git已跟踪的文件来更新
-                for file_path in tracked_files:
-                    try:
-                        rel_path = file_path
-                        full_path = docs_dir / rel_path
-                        
-                        # 如果文件已在JSONL缓存中，跳过
-                        if rel_path in jsonl_dates_cache:
-                            continue
-                        
-                        # 处理新文件或迁移旧JSON缓存
-                        if rel_path in json_dates_cache:
-                            jsonl_dates_cache[rel_path] = json_dates_cache[rel_path]
-                            project_updated = True
-                        elif full_path.exists():
-                            created_time = get_file_creation_time(full_path)
-                            if not jsonl_cache_file.exists() and not json_cache_file.exists():
-                                git_time = get_git_first_commit_time(full_path)
-                                if git_time is not None:
-                                    created_time = min(created_time, git_time)
-                            jsonl_dates_cache[rel_path] = {
-                                "created": created_time.isoformat()
-                            }
-                            project_updated = True
-                    except Exception as e:
-                        logging.error(f"Error processing file {file_path}: {e}")
+            if not tracked_files:
+                logging.info(f"No tracked markdown files found in {docs_dir}")
+                continue
+
+            # 读取旧的JSON缓存文件（如果存在）
+            json_cache_file = docs_dir / '.dates_cache.json'
+            json_dates_cache = read_json_cache(json_cache_file)
+
+            # 读取新的JSONL缓存文件（如果存在）
+            jsonl_cache_file = docs_dir / '.dates_cache.jsonl'
+            jsonl_dates_cache = read_jsonl_cache(jsonl_cache_file)
+
+            # 根据 git已跟踪的文件来更新
+            for rel_path in tracked_files:
+                try:
+                    # 如果文件已在JSONL缓存中，跳过
+                    if rel_path in jsonl_dates_cache:
                         continue
 
-                # 标记删除不再跟踪的文件
-                files_to_remove = set(jsonl_dates_cache.keys()) - set(tracked_files)
-                if files_to_remove:
-                    project_updated = True
-                    logging.info(f"Removing {len(files_to_remove)} untracked files from cache")
-
-                # 如果有更新，写入JSONL缓存文件
-                if project_updated or not jsonl_cache_file.exists():
-                    if write_jsonl_cache(jsonl_cache_file, jsonl_dates_cache, tracked_files):
-                        global_updated = True
-                else:
-                    logging.info(f"No updates needed for {jsonl_cache_file}")
-            except subprocess.CalledProcessError as e:
-                logging.error(f"Failed to execute git command: {e}")
-                continue
-            except Exception as e:
-                logging.error(f"Error processing project directory {project_dir}: {e}")
-                continue
+                    full_path = docs_dir / rel_path
+                    # 处理新文件或迁移旧JSON缓存
+                    if rel_path in json_dates_cache:
+                        jsonl_dates_cache[rel_path] = json_dates_cache[rel_path]
+                        project_updated = True
+                    elif full_path.exists():
+                        created_time = get_file_creation_time(full_path)
+                        if not jsonl_cache_file.exists() and not json_cache_file.exists():
+                            git_time = get_git_first_commit_time(full_path)
+                            if git_time:
+                                created_time = min(created_time, git_time)
+                        jsonl_dates_cache[rel_path] = {
+                            "created": created_time.isoformat()
+                        }
+                        project_updated = True
+                except Exception as e:
+                    logging.error(f"Error processing file {rel_path}: {e}")
+                    continue
+
+            # 标记删除不再跟踪的文件
+            files_to_remove = set(jsonl_dates_cache.keys()) - set(tracked_files)
+            if files_to_remove:
+                project_updated = True
+                logging.info(f"Removing {len(files_to_remove)} untracked files from cache")
+
+            # 如果有更新，写入JSONL缓存文件
+            if project_updated or not jsonl_cache_file.exists():
+                if write_jsonl_cache(jsonl_cache_file, jsonl_dates_cache, tracked_files):
+                    global_updated = True
+        except subprocess.CalledProcessError as e:
+            logging.error(f"Failed to execute git command: {e}")
+            continue
+        except Exception as e:
+            logging.error(f"Error processing project directory {project_dir}: {e}")
+            continue
 
-    except Exception as e:
-        logging.error(f"Unexpected error in update_cache: {e}")
-    
     return global_updated
 
 

{mkdocs_document_dates-3.1.3 → mkdocs_document_dates-3.1.6}/mkdocs_document_dates/hooks_installer.py

@@ -43,14 +43,6 @@ def detect_python_interpreter():
     # 如果都失败了，使用当前运行的Python解释器
     return f'#!{sys.executable}'
 
-def check_git_available():
-    try:
-        subprocess.run(['git', '--version'], check=True, capture_output=True, encoding='utf-8')
-        return True
-    except Exception:
-        logging.warning("Git not detected, skip hooks installation")
-        return False
-
 def setup_hooks_directory():
     config_dir = get_config_dir() / 'mkdocs-document-dates' / 'hooks'
     try:
@@ -95,16 +87,12 @@ def configure_git_hooks(hooks_dir):
         )
         logging.info(f"Git hooks successfully installed in: {hooks_dir}")
         return True
-    except Exception as e:
-        logging.error(f"Failed to set git hooks path: {str(e)}")
+    except Exception:
+        logging.warning("Git not detected, failed to set git hooks path")
         return False
 
 def install():
     try:
-        # 检查git是否可用
-        if not check_git_available():
-            return False
-
         # 创建hooks目录
         hooks_dir = setup_hooks_directory()
         if not hooks_dir: