mkdocs-document-dates 1.3.0__tar.gz → 1.4.0__tar.gz

{mkdocs_document_dates-1.3.0 → mkdocs_document_dates-1.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: mkdocs-document-dates
-Version: 1.3.0
+Version: 1.4.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
@@ -112,8 +112,10 @@ modified: 2023-12-31
   - 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
-  - You can configure it like this: `pip install --upgrade mkdocs-document-dates` or `pip install mkdocs-document-dates==1.2.0`
+  - You can configure it like this: `pip install --upgrade mkdocs-document-dates`
     ```
+    ...
+    
       - run: pip install --upgrade mkdocs-document-dates
       - run: mkdocs gh-deploy --force
     ```  

{mkdocs_document_dates-1.3.0 → mkdocs_document_dates-1.4.0}/README.md

@@ -90,8 +90,10 @@ modified: 2023-12-31
   - 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
-  - You can configure it like this: `pip install --upgrade mkdocs-document-dates` or `pip install mkdocs-document-dates==1.2.0`
+  - You can configure it like this: `pip install --upgrade mkdocs-document-dates`
     ```
+    ...
+    
       - run: pip install --upgrade mkdocs-document-dates
       - run: mkdocs gh-deploy --force
     ```  

{mkdocs_document_dates-1.3.0 → mkdocs_document_dates-1.4.0}/mkdocs_document_dates/hooks/pre-commit

@@ -4,7 +4,6 @@ import sys
 import json
 import platform
 import subprocess
-import traceback
 from datetime import datetime
 from pathlib import Path
 
@@ -47,73 +46,34 @@ def get_file_dates(file_path):
         current_time = datetime.now()
         return current_time.isoformat(), current_time.isoformat()
 
+
 def update_dates_cache():
     """更新文档时间缓存"""
-    projects = find_mkdocs_projects()
-    if not projects:
-        print("No MkDocs projects found")
-        return
-
-    for project_dir in projects:
+    for project_dir in find_mkdocs_projects():
         docs_dir = project_dir / 'docs'
         if not docs_dir.exists():
             continue
-            
-        # 检查 assets 目录
-        assets_dir = docs_dir / 'assets'
-        if not assets_dir.exists():
-            assets_dir.mkdir(parents=True)
-            
-        cache_file = assets_dir / 'dates_cache.json'
-        dates_cache = _load_cache(cache_file)
-        
-        _update_cache(docs_dir, dates_cache)
-        _save_cache(cache_file, dates_cache)
 
-def _load_cache(cache_file):
-    """加载缓存文件"""
-    if cache_file.exists():
-        try:
-            with open(cache_file) as f:
-                return json.load(f)
-        except json.JSONDecodeError:
-            pass
-    return {}
-
-def _update_cache(docs_dir, dates_cache):
-    """更新缓存内容"""
-    # 记录当前所有的 markdown 文件
-    current_files = set()
-    
-    # 处理新增和更新的文件
-    for md_file in docs_dir.rglob("*.md"):
-        rel_path = str(md_file.relative_to(docs_dir))
-        current_files.add(rel_path)
-        
-        # 文件不在缓存中（新增）或文件修改时间变化（更新）
-        if rel_path not in dates_cache or os.path.getmtime(md_file) != dates_cache[rel_path].get("mtime", 0):
+        dates_cache = {}
+        # 获取所有 markdown 文件的时间信息
+        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,
-                "mtime": os.path.getmtime(md_file)
+                "modified": modified
             }
-    
-    # 处理删除的文件
-    for cached_path in list(dates_cache.keys()):
-        if cached_path not in current_files:
-            del dates_cache[cached_path]
 
-def _save_cache(cache_file, dates_cache):
-    """保存缓存文件"""
-    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)
+        # 保存缓存文件
+        cache_file = docs_dir / '.dates_cache.json'
+        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)
+
 
-# 添加主入口
 if __name__ == "__main__":
     try:
         update_dates_cache()
     except Exception as e:
-        traceback.print_exc()
+        print(f"Error updating dates cache: {e}", file=sys.stderr)
         sys.exit(1)

{mkdocs_document_dates-1.3.0 → mkdocs_document_dates-1.4.0}/mkdocs_document_dates/plugin.py

@@ -84,10 +84,16 @@ class DocumentDatesPlugin(BasePlugin):
         if self._is_excluded(file_path, Path(config['docs_dir'])):
             return markdown
         
+        # 获取文件时间
         created, modified = self._get_file_dates(file_path)
+        
+        # 处理 front matter 中的时间
         created, modified = self._process_meta_dates(page.meta, created, modified)
         
+        # 生成日期信息 HTML
         date_info = self._get_date_info(created, modified)
+        
+        # 将日期信息写入 markdown
         return self._insert_date_info(markdown, date_info)
 
     def _is_excluded(self, file_path: Path, docs_dir: Path) -> bool:
@@ -152,23 +158,16 @@ class DocumentDatesPlugin(BasePlugin):
             docs_dir = Path(self.config['docs_dir'])
             rel_path = str(Path(file_path).relative_to(docs_dir))
             
-            # 尝试从缓存读取时间信息
-            cache_paths = [
-                # 部署环境路径（gh-pages）
-                Path(file_path).parent / 'assets' / 'dates_cache.json',
-                # 开发环境路径（main）
-                docs_dir / 'assets' / 'dates_cache.json'
-            ]
-            
-            for cache_file in cache_paths:
-                if cache_file.exists():
-                    with open(cache_file) as f:
-                        dates_cache = json.load(f)
-                        if rel_path in dates_cache:
-                            return (
-                                datetime.fromisoformat(dates_cache[rel_path]['created']),
-                                datetime.fromisoformat(dates_cache[rel_path]['modified'])
-                            )
+            # 尝试从缓存文件读取时间信息
+            cache_file = docs_dir / '.dates_cache.json'
+            if cache_file.exists():
+                with open(cache_file) as f:
+                    dates_cache = json.load(f)
+                    if rel_path in dates_cache:
+                        return (
+                            datetime.fromisoformat(dates_cache[rel_path]['created']),
+                            datetime.fromisoformat(dates_cache[rel_path]['modified'])
+                        )
             
             # 如果缓存不存在或文件不在缓存中，使用文件系统时间
             stat = os.stat(file_path)
@@ -186,7 +185,7 @@ class DocumentDatesPlugin(BasePlugin):
                 created = modified
 
             return created, modified
-            
+                
         except (OSError, ValueError, json.JSONDecodeError) as e:
             current_time = datetime.now()
             return current_time, current_time

{mkdocs_document_dates-1.3.0 → mkdocs_document_dates-1.4.0}/mkdocs_document_dates.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: mkdocs-document-dates
-Version: 1.3.0
+Version: 1.4.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
@@ -112,8 +112,10 @@ modified: 2023-12-31
   - 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
-  - You can configure it like this: `pip install --upgrade mkdocs-document-dates` or `pip install mkdocs-document-dates==1.2.0`
+  - You can configure it like this: `pip install --upgrade mkdocs-document-dates`
     ```
+    ...
+    
       - run: pip install --upgrade mkdocs-document-dates
       - run: mkdocs gh-deploy --force
     ```  

{mkdocs_document_dates-1.3.0 → mkdocs_document_dates-1.4.0}/setup.py

@@ -1,4 +1,6 @@
 from setuptools import setup, find_packages
+from setuptools.command.install import install
+from setuptools.command.develop import develop
 from setuptools.command.build_py import build_py
 import os
 import subprocess
@@ -32,6 +34,16 @@ def install_git_hooks():
     except Exception as e:
         print(f"Warning: Failed to install git hooks: {e}")
 
+class CustomInstall(install):
+    def run(self):
+        install.run(self)
+        install_git_hooks()
+
+class CustomDevelop(develop):
+    def run(self):
+        develop.run(self)
+        install_git_hooks()
+
 class CustomBuildPy(build_py):
     def run(self):
         build_py.run(self)
@@ -43,7 +55,7 @@ try:
 except FileNotFoundError:
     long_description = "A MkDocs plugin for displaying accurate document creation and last modification dates."
 
-VERSION = '1.3.0'
+VERSION = '1.4.0'
 
 setup(
     name="mkdocs-document-dates",
@@ -68,7 +80,9 @@ setup(
         ]
     },
     cmdclass={
-        'build_py': CustomBuildPy,  # 在构建时安装 hooks，无论是正式安装还是开发模式安装，都会经过构建阶段
+        'build_py': CustomBuildPy,
+        'install': CustomInstall,
+        'develop': CustomDevelop,
     },
     package_data={
         'mkdocs_document_dates': ['hooks/*'],