mkdocs-document-dates 1.9.8__py3-none-any.whl → 2.0.0__py3-none-any.whl

mkdocs_document_dates/__init__.py

@@ -1,3 +1,11 @@
 """MkDocs Document Dates Plugin."""
 
-__version__ = '1.0.0'
+__version__ = '2.0.0'
+
+from .hooks_installer import install
+
+# 第三个入口：当包被导入时自动执行 hooks 安装，作为额外保障
+try:
+    install()
+except Exception as e:
+    print(f"安装 git hooks 失败: {e}")

mkdocs_document_dates/hooks/pre-commit

@@ -13,16 +13,17 @@ def find_mkdocs_projects():
     try:
         git_root = Path(subprocess.check_output(
             ['git', 'rev-parse', '--show-toplevel'],
-            text=True
+            text=True, encoding='utf-8'
         ).strip())
         
         projects = []
         for config_file in git_root.rglob('mkdocs.y*ml'):
-            if config_file.name in ('mkdocs.yml', 'mkdocs.yaml'):
+            if config_file.name.lower() in ('mkdocs.yml', 'mkdocs.yaml'):
                 projects.append(config_file.parent)
+        
         return projects
     except subprocess.CalledProcessError as e:
-        print(f"Error finding git root: {e}")
+        print(f"Error finding git root: {e}", file=sys.stderr)
         return []
 
 def get_file_dates(file_path):
@@ -48,28 +49,40 @@ def get_file_dates(file_path):
         return current_time.isoformat(), current_time.isoformat()
 
 def update_dates_cache():
+    print("开始更新文档时间缓存...")
     """更新文档时间缓存"""
     for project_dir in find_mkdocs_projects():
         docs_dir = project_dir / 'docs'
         if not docs_dir.exists():
+            print(f"文档目录不存在: {docs_dir}")
             continue
 
         dates_cache = {}
-        for md_file in docs_dir.rglob("*.md"):
-            rel_path = str(md_file.relative_to(docs_dir))
-            created, modified = get_file_dates(md_file)
-            dates_cache[rel_path] = {
-                "created": created,
-                "modified": modified
-            }
+        md_files = list(docs_dir.rglob("*.md"))
+        
+        for md_file in md_files:
+            try:
+                rel_path = str(md_file.relative_to(docs_dir))
+                created, modified = get_file_dates(md_file)
+                dates_cache[rel_path] = {
+                    "created": created,
+                    "modified": modified
+                }
+            except Exception as e:
+                print(f"处理文件 {md_file} 时出错: {e}")
+
+        if not dates_cache:
+            continue
 
         cache_file = docs_dir / '.dates_cache.json'
+        print(f"正在写入缓存文件: {cache_file}")
         try:
             with open(cache_file, "w") as f:
                 json.dump(dates_cache, f, indent=2, ensure_ascii=False)
             subprocess.run(["git", "add", str(cache_file)], check=True)
+            print(f"缓存文件 {cache_file} 已更新.")
         except Exception as e:
-            print(f"Error handling cache file: {e}", file=sys.stderr)
+            print(f"写入缓存文件时出错: {e}", file=sys.stderr)
             raise
 
 if __name__ == "__main__":

mkdocs_document_dates/hooks_installer.py

@@ -0,0 +1,87 @@
+import os
+import sys
+import subprocess
+from pathlib import Path
+import site
+import platform
+
+def install():
+    """安装 git hooks"""
+    try:
+        # 检查 git 是否可用
+        try:
+            subprocess.run(['git', '--version'], check=True, capture_output=True, encoding='utf-8')
+        except (subprocess.CalledProcessError, FileNotFoundError):
+            # 静默失败，因为用户可能在非 git 环境下安装
+            return False
+        
+        # 检查是否在 git 仓库中
+        try:
+            subprocess.run(['git', 'rev-parse', '--git-dir'], check=True, capture_output=True, encoding='utf-8')
+        except subprocess.CalledProcessError:
+            # 静默失败，用户可能不在 git 仓库中
+            return False
+            
+        # 检查是否是开发模式安装
+        def is_dev_install():
+            try:
+                import mkdocs_document_dates
+                pkg_path = Path(mkdocs_document_dates.__file__).resolve().parent
+                current_path = Path(__file__).resolve().parent
+                # 检查是否在开发目录中
+                if current_path == pkg_path:
+                    return True
+                # 检查是否是 egg-link 安装
+                site_packages = [Path(p) for p in site.getsitepackages()]
+                for p in site_packages:
+                    if (p / 'mkdocs_document_dates.egg-link').exists():
+                        return True
+                return False
+            except (ImportError, AttributeError) as e:
+                print(f"开发模式检查失败: {e}")
+                return False
+
+        is_dev_mode = is_dev_install()
+        hook_path = None
+        
+        if is_dev_mode:
+            hooks_dir = Path(__file__).parent.resolve() / 'hooks'
+            if hooks_dir.exists():
+                hook_path = hooks_dir / 'pre-commit'
+        else:
+            for site_dir in site.getsitepackages():
+                hooks_dir = Path(site_dir) / 'mkdocs_document_dates' / 'hooks'
+                if hooks_dir.exists():
+                    hook_path = hooks_dir / 'pre-commit'
+                    break
+        
+                    
+        if not hook_path or not hook_path.exists():
+            print("错误: 未找到 hooks 目录或 hook 文件")
+            return False
+
+        # 设置文件权限（Unix-like 系统）
+        if platform.system() != 'Windows':
+            try:
+                os.chmod(hook_path.parent, 0o755)
+                os.chmod(hook_path, 0o755)
+            except OSError as e:
+                print(f"警告: 设置权限时出错: {e}")
+
+        # 配置 git hooks 路径
+        try:
+            hooks_dir = hook_path.parent
+            subprocess.run(['git', 'config', '--global', 'core.hooksPath', 
+                          str(hooks_dir)], check=True, encoding='utf-8')
+            print(f"Git hooks 已安装到: {hooks_dir}")
+            return True
+        except subprocess.CalledProcessError as e:
+            print(f"错误: 设置 git hooks 路径失败: {e}")
+            return False
+            
+    except Exception as e:
+        print(f"安装 hooks 时出错: {e}")
+        return False
+
+if __name__ == '__main__':
+    install()

{mkdocs_document_dates-1.9.8.dist-info → mkdocs_document_dates-2.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: mkdocs-document-dates
-Version: 1.9.8
+Version: 2.0.0
 Summary: A MkDocs plugin for displaying accurate document creation and last modification dates.
 Home-page: https://github.com/jaywhj/mkdocs-document-dates
 Author: Aaron Wang
@@ -111,7 +111,7 @@ modified: 2023-12-31
   - macOS: Uses file creation time (birthtime)
   - Linux: Uses modification time as creation time due to system limitations, if you need the exact creation time, you can manually specify it in Front Matter
 - It still works when using CI/CD build systems (e.g. Github Actions)
-  - Used a cache file `dates_cache.json` to solve this problem
+  - Used a cache file `.dates_cache.json` to solve this problem
   - You can configure it like this: `pip install --upgrade mkdocs-document-dates`
     ```
     ...

{mkdocs_document_dates-1.9.8.dist-info → mkdocs_document_dates-2.0.0.dist-info}/RECORD

@@ -1,7 +1,8 @@
-mkdocs_document_dates/__init__.py,sha256=CZ37u8DC6kbkupKFk-VKyfKZZFAJ4rOD0aPzOzVoATc,58
+mkdocs_document_dates/__init__.py,sha256=0nh_vvDiVeDUDIgIB-Oea3gc46lZ8av9c_YGyuWf1Y8,267
+mkdocs_document_dates/hooks_installer.py,sha256=pQBVa366bUb82U-BjIzfmOcl5wRT5hxwN8dzoZ8ILfo,3226
 mkdocs_document_dates/plugin.py,sha256=zgZ9QrbfsMDAv80P11I_99urSvFolJq93Ow7P-pfS_A,9753
 mkdocs_document_dates/styles.py,sha256=ujhlKgDWsOo5sHiYtf3XekuGg4C5Yjol8RzP3W9Wzjo,578
-mkdocs_document_dates/hooks/pre-commit,sha256=YoNwuoT2NxMbpzwxMctH4EFB5ex_LdzG5xDxKjl93LQ,2601
+mkdocs_document_dates/hooks/pre-commit,sha256=pCMSzKA7Gs74G4F0pRbGL1gmT8R_1RaMY6hJDQH3f0s,3107
 mkdocs_document_dates/lang/__init__.py,sha256=M1BLjCOA3HHKeAitk45YAgzxxNpnxFUvVAk6-FO_QSA,690
 mkdocs_document_dates/lang/ar.py,sha256=BsZlxz54U_spOZ5SBiKt73ywoLKbR54cZNkKAs86OxM,632
 mkdocs_document_dates/lang/de.py,sha256=B0Ffrn4lVSvcxFpGho7SiMm16GXYEmpjcVAR-k4UgSI,585
@@ -13,9 +14,9 @@ mkdocs_document_dates/lang/ko.py,sha256=GwY6yrKYAOj6S6feq9yqNxr2XpyGHC0XeenO541v
 mkdocs_document_dates/lang/ru.py,sha256=fK5s4mQKCoP6KI3jf6eqqmqB3YVn39q81U7Cw1QWNNg,721
 mkdocs_document_dates/lang/zh.py,sha256=OrLElrSTZhHSwxBzuUtUj7NpQb7wm0s83viimpk2ynM,519
 mkdocs_document_dates/lang/zh_tw.py,sha256=t3qu-a7UOzgcmYDkLFiosJZCcpfMU4xiKTJfu1ZHoHA,519
-mkdocs_document_dates-1.9.8.dist-info/LICENSE,sha256=1YKfCs5WKSk-bON8a68WZE5to1B2klCrHBYiuaVCThM,514
-mkdocs_document_dates-1.9.8.dist-info/METADATA,sha256=lJqJx-D5OX8JPQPw0r_LZ1DvOe88BASuAtMenlwHtxc,3908
-mkdocs_document_dates-1.9.8.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-mkdocs_document_dates-1.9.8.dist-info/entry_points.txt,sha256=gI-OFLGjDG6-oLEfyevl3Gwwj2GcqVFQeX3bvL1IF8o,83
-mkdocs_document_dates-1.9.8.dist-info/top_level.txt,sha256=yWkKQdNuAJJVqUQ9uLa5xD4x_Gux4IfOUpy8Ryagdwc,22
-mkdocs_document_dates-1.9.8.dist-info/RECORD,,
+mkdocs_document_dates-2.0.0.dist-info/LICENSE,sha256=1YKfCs5WKSk-bON8a68WZE5to1B2klCrHBYiuaVCThM,514
+mkdocs_document_dates-2.0.0.dist-info/METADATA,sha256=-HXJKHDAZQ9HrmYxf4BZLNNbyh_n4lSCjZZ9DTtMD_I,3909
+mkdocs_document_dates-2.0.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+mkdocs_document_dates-2.0.0.dist-info/entry_points.txt,sha256=sTieQtdvk_F4VeLQoyBc9Ck2_Bg40BXk1Piq-5-fqvA,178
+mkdocs_document_dates-2.0.0.dist-info/top_level.txt,sha256=yWkKQdNuAJJVqUQ9uLa5xD4x_Gux4IfOUpy8Ryagdwc,22
+mkdocs_document_dates-2.0.0.dist-info/RECORD,,

mkdocs_document_dates-2.0.0.dist-info/entry_points.txt

@@ -0,0 +1,5 @@
+[console_scripts]
+mkdocs-document-dates-hooks = mkdocs_document_dates.hooks_installer:install
+
+[mkdocs.plugins]
+document-dates = mkdocs_document_dates.plugin:DocumentDatesPlugin

mkdocs_document_dates-1.9.8.dist-info/entry_points.txt

@@ -1,2 +0,0 @@
-[mkdocs.plugins]
-document-dates = mkdocs_document_dates.plugin:DocumentDatesPlugin