mkdocs-document-dates 3.1__tar.gz → 3.1.2__tar.gz

{mkdocs_document_dates-3.1 → mkdocs_document_dates-3.1.2}/PKG-INFO

@@ -1,9 +1,10 @@
 Metadata-Version: 2.4
 Name: mkdocs-document-dates
-Version: 3.1
+Version: 3.1.2
 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
+License: MIT
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
@@ -16,6 +17,7 @@ Dynamic: classifier
 Dynamic: description
 Dynamic: description-content-type
 Dynamic: home-page
+Dynamic: license
 Dynamic: license-file
 Dynamic: requires-dist
 Dynamic: requires-python
@@ -70,7 +72,7 @@ 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
+      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)
       exclude:                 # List of excluded files
@@ -120,38 +122,49 @@ 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, it's super easy):
+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):
 
 - 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
-
-Note: Due to the redesign of the configuration file update mechanism, the configuration file starting with document-dates.config in the previous version has been canceled and replaced by user.config
+- 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
+        ```
 
 ## 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:
-    - `docs/.dates_cache.jsonl`, cache file (.json without the l is the old cache file and will be automatically migrated to .jsonl after any git commit)
-    - `docs/.gitattributes`, configuration file (merge mechanism for cache file in case of multi-person collaboration)
-- The Git Hooks mechanism is used to automatically trigger the storing of the cache (every time executes a git commit), and the cached file is automatically committed along with it
-- The installation of Git Hooks is automatically triggered when the plugin is installed
-- The above actions are fully automated without any manual intervention, applicable to any environment, and have been tested and validated in Git-less environments, CI/CD environments (e.g., GitHub Actions), one-person collaborations, multi-person collaborations, etc
+    - `docs/.dates_cache.jsonl`, cache file
+    - `docs/.gitattributes`, merge mechanism for cache file in case of multi-person collaboration
+- The Git Hooks mechanism is used to automatically trigger the storing of the cache (every time executes a 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 nothing to do can take a look \^\_\^ 
+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
 - **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. Existing in the Front Matter is very reasonable and 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!
+    - 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!
 - **Difficulty**:
-    1. When to read and store raw 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 action occurs, such as every time commit is performed
-    2. How can I ensure that a single cache file does not conflict when collaborating with multi-person?
-        - My solution: use JSONL (JSON Lines) instead of JSON, and with the merge strategy 'merge=union'
+    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 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
@@ -159,4 +172,4 @@ A dispensable, insignificant little plug-in, friends who have nothing to do can
         - 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**:
-    - I'm not a programmer, my main job is marketing, can you believe it? (Feel free to leave a comment)
+    - Programming is a hobby, and I'm a marketer of 8 years (Feel free to leave a comment)

{mkdocs_document_dates-3.1 → mkdocs_document_dates-3.1.2}/README.md

@@ -47,7 +47,7 @@ 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
+      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)
       exclude:                 # List of excluded files
@@ -97,38 +97,49 @@ 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, it's super easy):
+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):
 
 - 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
-
-Note: Due to the redesign of the configuration file update mechanism, the configuration file starting with document-dates.config in the previous version has been canceled and replaced by user.config
+- 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
+        ```
 
 ## 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:
-    - `docs/.dates_cache.jsonl`, cache file (.json without the l is the old cache file and will be automatically migrated to .jsonl after any git commit)
-    - `docs/.gitattributes`, configuration file (merge mechanism for cache file in case of multi-person collaboration)
-- The Git Hooks mechanism is used to automatically trigger the storing of the cache (every time executes a git commit), and the cached file is automatically committed along with it
-- The installation of Git Hooks is automatically triggered when the plugin is installed
-- The above actions are fully automated without any manual intervention, applicable to any environment, and have been tested and validated in Git-less environments, CI/CD environments (e.g., GitHub Actions), one-person collaborations, multi-person collaborations, etc
+    - `docs/.dates_cache.jsonl`, cache file
+    - `docs/.gitattributes`, merge mechanism for cache file in case of multi-person collaboration
+- The Git Hooks mechanism is used to automatically trigger the storing of the cache (every time executes a 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 nothing to do can take a look \^\_\^ 
+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
 - **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. Existing in the Front Matter is very reasonable and 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!
+    - 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!
 - **Difficulty**:
-    1. When to read and store raw 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 action occurs, such as every time commit is performed
-    2. How can I ensure that a single cache file does not conflict when collaborating with multi-person?
-        - My solution: use JSONL (JSON Lines) instead of JSON, and with the merge strategy 'merge=union'
+    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 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
@@ -136,4 +147,4 @@ A dispensable, insignificant little plug-in, friends who have nothing to do can
         - 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**:
-    - I'm not a programmer, my main job is marketing, can you believe it? (Feel free to leave a comment)
+    - Programming is a hobby, and I'm a marketer of 8 years (Feel free to leave a comment)

mkdocs_document_dates-3.1.2/mkdocs_document_dates/__init__.py

@@ -0,0 +1,6 @@
+"""MkDocs Document Dates Plugin."""
+
+from .hooks_installer import install
+
+# 在包被导入时自动执行 hooks 安装
+install()

mkdocs_document_dates-3.1.2/mkdocs_document_dates/cache_manager.py

@@ -0,0 +1,234 @@
+import os
+import json
+import logging
+import platform
+import subprocess
+from datetime import datetime
+from pathlib import Path
+
+# 配置日志等级 (INFO WARNING ERROR)
+logging.basicConfig(
+    level=logging.WARNING,
+    format='%(levelname)s: %(message)s'
+)
+
+def find_mkdocs_projects():
+    try:
+        git_root = Path(subprocess.check_output(
+            ['git', 'rev-parse', '--show-toplevel'],
+            text=True, encoding='utf-8'
+        ).strip())
+
+        projects = []
+        # 遍历 git_root 及子目录, 寻找 mkdocs.yml 文件
+        for config_file in git_root.rglob('mkdocs.y*ml'):
+            if config_file.name.lower() in ('mkdocs.yml', 'mkdocs.yaml'):
+                projects.append(config_file.parent)
+
+        if not projects:
+            logging.info("No MkDocs projects found in the repository")
+        return projects
+    except subprocess.CalledProcessError as e:
+        logging.error(f"Failed to find the Git repository root: {e}")
+        return []
+    except Exception as e:
+        logging.error(f"Unexpected error while searching for MkDocs projects: {e}")
+        return []
+
+def get_file_creation_time(file_path):
+    try:
+        stat = os.stat(file_path)
+        system = platform.system().lower()
+        if system.startswith('win'):  # Windows
+            return datetime.fromtimestamp(stat.st_ctime)
+        elif system == 'darwin':  # macOS
+            try:
+                return datetime.fromtimestamp(stat.st_birthtime)
+            except AttributeError:
+                return datetime.fromtimestamp(stat.st_ctime)
+        else:  # Linux, 没有创建时间，使用修改时间
+            return datetime.fromtimestamp(stat.st_mtime)
+    except (OSError, ValueError) as e:
+        logging.error(f"Failed to get file creation time for {file_path}: {e}")
+        return datetime.now()
+
+def get_git_first_commit_time(file_path):
+    try:
+        # 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)
+    except Exception as e:
+        logging.info(f"Error getting git first commit time for {file_path}: {e}")
+    return None
+
+def setup_gitattributes(docs_dir):
+    updated = False
+    try:
+        gitattributes_path = docs_dir / '.gitattributes'
+        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()
+            
+            if union_config_line not in content:
+                with open(gitattributes_path, 'a', encoding='utf-8') as f:
+                    f.write(f"\n{union_config_line}\n")
+                updated = True
+        else:
+            with open(gitattributes_path, 'w', encoding='utf-8') as f:
+                f.write(f"{union_config_line}\n")
+            updated = True
+        
+        if updated:
+            subprocess.run(["git", "add", str(gitattributes_path)], check=True)
+            logging.info(f"Updated .gitattributes file: {gitattributes_path}")
+    except (IOError, OSError) as e:
+        logging.error(f"Failed to read/write .gitattributes file: {e}")
+    except Exception as e:
+        logging.error(f"Failed to add .gitattributes to git: {e}")
+    
+    return updated
+
+def read_json_cache(cache_file):
+    dates_cache = {}
+    if cache_file.exists():
+        try:
+            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}")
+    return dates_cache
+
+def read_jsonl_cache(jsonl_file):
+    dates_cache = {}
+    if jsonl_file.exists():
+        try:
+            with open(jsonl_file, "r", encoding='utf-8') as f:
+                for line in f:
+                    try:
+                        entry = json.loads(line.strip())
+                        if entry and isinstance(entry, dict) and len(entry) == 1:
+                            file_path, file_info = next(iter(entry.items()))
+                            dates_cache[file_path] = file_info
+                    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}")
+    return dates_cache
+
+def write_jsonl_cache(jsonl_file, dates_cache, tracked_files):
+    try:
+        # 使用临时文件写入，然后替换原文件，避免写入过程中的问题
+        temp_file = jsonl_file.with_suffix('.jsonl.tmp')
+        with open(temp_file, "w", encoding='utf-8') as f:
+            for file_path in tracked_files:
+                if file_path in dates_cache:
+                    entry = {file_path: dates_cache[file_path]}
+                    f.write(json.dumps(entry, ensure_ascii=False) + '\n')
+        
+        # 替换原文件
+        temp_file.replace(jsonl_file)
+        
+        # 将文件添加到git
+        subprocess.run(["git", "add", str(jsonl_file)], check=True)
+        logging.info(f"Successfully updated JSONL cache file: {jsonl_file}")
+        return True
+    except (IOError, json.JSONDecodeError) as e:
+        logging.error(f"Failed to write JSONL cache file {jsonl_file}: {e}")
+        return False
+    except subprocess.CalledProcessError as e:
+        logging.error(f"Failed to add JSONL cache file to git: {e}")
+        return False
+
+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
+
+                # 设置.gitattributes文件
+                gitattributes_updated = setup_gitattributes(docs_dir)
+                if gitattributes_updated:
+                    global_updated = True
+
+                # 获取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
+
+                # 读取旧的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 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}")
+                        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
+
+    except Exception as e:
+        logging.error(f"Unexpected error in update_cache: {e}")
+    
+    return global_updated
+
+
+if __name__ == "__main__":
+    update_cache()

{mkdocs_document_dates-3.1 → mkdocs_document_dates-3.1.2}/mkdocs_document_dates/hooks/pre-commit

@@ -1,16 +1,12 @@
 #!/usr/bin/env python3
 
 import sys
-import logging
 
 try:
     from mkdocs_document_dates.cache_manager import update_cache
 except ImportError:
+    # 正常退出（0 状态码），不影响 git 的后续动作
     sys.exit(0)
 
 if __name__ == "__main__":
-    try:
-        update_cache()
-    except Exception as e:
-        logging.error(f"Hook execution failed: {e}")
-        sys.exit(1)
+    update_cache()

mkdocs_document_dates-3.1.2/mkdocs_document_dates/hooks_installer.py

@@ -0,0 +1,126 @@
+import os
+import sys
+import logging
+import subprocess
+from pathlib import Path
+import platform
+
+# 配置日志等级 (INFO WARNING ERROR)
+logging.basicConfig(
+    level=logging.WARNING,
+    format='%(levelname)s: %(message)s'
+)
+
+def get_config_dir():
+    if platform.system().lower().startswith('win'):
+        return Path(os.getenv('APPDATA', str(Path.home() / 'AppData' / 'Roaming')))
+    else:
+        return Path.home() / '.config'
+
+def check_python_version(interpreter):
+    try:
+        result = subprocess.run(
+            [interpreter, "-c", "import sys; print(sys.version_info >= (3, 7))"],
+            capture_output=True, text=True, check=False
+        )
+        if result.returncode == 0 and result.stdout.strip() == 'True':
+            return True
+        else:
+            logging.warning(f"Low python version, requires python_requires >=3.7")
+            return False
+    except Exception as e:
+        logging.debug(f"Failed to check {interpreter}: {str(e)}")
+        return False
+
+def detect_python_interpreter():
+    # 检查可能的Python解释器
+    python_interpreters = ['python3', 'python']
+    
+    for interpreter in python_interpreters:
+        if check_python_version(interpreter):
+            return f'#!/usr/bin/env {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:
+        config_dir.mkdir(parents=True, exist_ok=True)
+        os.chmod(config_dir, 0o755)
+        return config_dir
+    except PermissionError:
+        logging.error(f"No permission to create directory: {config_dir}")
+        return None
+    except Exception as e:
+        logging.error(f"Failed to create directory {config_dir}: {str(e)}")
+        return None
+
+def install_hook_file(source_hook, target_dir):
+    target_hook_path = target_dir / source_hook.name
+    try:
+        # 读取并更新hook文件内容
+        with open(source_hook, 'r', encoding='utf-8') as f_in:
+            content = f_in.read()
+        
+        # 更新shebang行
+        shebang = detect_python_interpreter()
+        if content.startswith('#!'):
+            content = shebang + os.linesep + content[content.find('\n'):]
+        else:
+            content = shebang + os.linesep + content
+        
+        # 写入并设置权限
+        with open(target_hook_path, 'w', encoding='utf-8') as f_out:
+            f_out.write(content)
+        os.chmod(target_hook_path, 0o755)
+        return True
+    except Exception as e:
+        logging.error(f"Failed to create hook file {target_hook_path}: {str(e)}")
+        return False
+
+def configure_git_hooks(hooks_dir):
+    try:
+        subprocess.run(
+            ['git', 'config', '--global', 'core.hooksPath', str(hooks_dir)],
+            check=True, capture_output=True, encoding='utf-8'
+        )
+        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)}")
+        return False
+
+def install():
+    try:
+        # 检查git是否可用
+        if not check_git_available():
+            return False
+
+        # 创建hooks目录
+        hooks_dir = setup_hooks_directory()
+        if not hooks_dir:
+            return False
+
+        # 安装hook文件
+        source_hook = Path(__file__).parent / 'hooks' / 'pre-commit'
+        if not install_hook_file(source_hook, hooks_dir):
+            return False
+
+        # 配置git hooks路径
+        return configure_git_hooks(hooks_dir)
+
+    except Exception as e:
+        logging.error(f"Unexpected error during hooks installation: {str(e)}")
+        return False
+
+if __name__ == '__main__':
+    install()