mkdocs-document-dates 3.1.5__tar.gz → 3.2__tar.gz

mkdocs_document_dates-3.2/MANIFEST.in

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

{mkdocs_document_dates-3.1.5 → mkdocs_document_dates-3.2}/PKG-INFO

@@ -1,13 +1,12 @@
 Metadata-Version: 2.4
 Name: mkdocs-document-dates
-Version: 3.1.5
+Version: 3.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
 Author-email: aaronwqt@gmail.com
 License: MIT
 Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown
@@ -38,14 +37,11 @@ An easy-to-use, lightweight MkDocs plugin for displaying the <mark>exact</mark>
 - 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
@@ -80,9 +76,7 @@ plugins:
       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
@@ -123,18 +117,18 @@ 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 preset values 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, theme color, font, animation, dividing line**, etc. Everything is customizable (I've already written the code, you just need to turn on the uncomment switch):
 
-|        Function：        | Location：                               |
+|        Category:        | 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 time dynamically, `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):
+**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
+- In `mkdocs.yml`, 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
@@ -150,12 +144,37 @@ The plugin supports deep customization, such as **icon style, font style, theme
 ![05-change-theme](mkdocs_document_dates/demo_images/05-change-theme.png)
 
 ![06-change-theme](mkdocs_document_dates/demo_images/06-change-theme.png)
-![07-pop-up-from-top](mkdocs_document_dates/demo_images/07-pop-up-from-top.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 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!
@@ -167,11 +186,11 @@ The plugin supports deep customization, such as **icon style, font style, theme
 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 more accurate, 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
+    - 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 in advance, 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 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!
+    - 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

{mkdocs_document_dates-3.1.5 → mkdocs_document_dates-3.2}/README.md

@@ -11,14 +11,11 @@ An easy-to-use, lightweight MkDocs plugin for displaying the <mark>exact</mark>
 - 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
@@ -53,9 +50,7 @@ plugins:
       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
@@ -96,18 +91,18 @@ 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 preset values 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, theme color, font, animation, dividing line**, etc. Everything is customizable (I've already written the code, you just need to turn on the uncomment switch):
 
-|        Function：        | Location：                               |
+|        Category:        | 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 time dynamically, `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):
+**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
+- In `mkdocs.yml`, 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
@@ -123,12 +118,37 @@ The plugin supports deep customization, such as **icon style, font style, theme
 ![05-change-theme](mkdocs_document_dates/demo_images/05-change-theme.png)
 
 ![06-change-theme](mkdocs_document_dates/demo_images/06-change-theme.png)
-![07-pop-up-from-top](mkdocs_document_dates/demo_images/07-pop-up-from-top.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 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!
@@ -140,11 +160,11 @@ The plugin supports deep customization, such as **icon style, font style, theme
 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 more accurate, 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
+    - 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 in advance, 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 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!
+    - 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

mkdocs_document_dates-3.2/mkdocs_document_dates/cache_manager.py

@@ -0,0 +1,126 @@
+import logging
+import subprocess
+from pathlib import Path
+from .utils import read_json_cache, read_jsonl_cache, write_jsonl_cache, get_file_creation_time, get_git_first_commit_time
+
+logger = logging.getLogger("mkdocs.plugins.document_dates")
+logger.setLevel(logging.WARNING)  # DEBUG, INFO, WARNING, ERROR, CRITICAL
+
+def find_mkdocs_projects():
+    projects = []
+    try:
+        git_root = Path(subprocess.check_output(
+            ['git', 'rev-parse', '--show-toplevel'],
+            text=True, encoding='utf-8'
+        ).strip())
+
+        # 遍历 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:
+            logger.warning("No MkDocs projects found in the repository")
+    except subprocess.CalledProcessError as e:
+        logger.error(f"Failed to find the Git repository root: {e}")
+    except Exception as e:
+        logger.error(f"Unexpected error while searching for MkDocs projects: {e}")
+    
+    return projects
+
+def setup_gitattributes(docs_dir: Path):
+    try:
+        gitattributes_path = docs_dir / '.gitattributes'
+        union_merge_line = ".dates_cache.jsonl merge=union"
+        # custom_merge_line = ".dates_cache.json merge=custom_json_merge"
+        content = gitattributes_path.read_text(encoding='utf-8') if gitattributes_path.exists() else ""
+        if union_merge_line not in content:
+            if content and not content.endswith('\n'):
+                content += '\n'
+            content += f"{union_merge_line}\n"
+            gitattributes_path.write_text(content, encoding='utf-8')
+            subprocess.run(["git", "add", str(gitattributes_path)], check=True)
+            logger.info(f"Updated .gitattributes file: {gitattributes_path}")
+            return True
+    except (IOError, OSError) as e:
+        logger.error(f"Failed to read/write .gitattributes file: {e}")
+    except Exception as e:
+        logger.error(f"Failed to add .gitattributes to git: {e}")
+    return False
+
+def update_cache():
+    global_updated = False
+
+    for project_dir in find_mkdocs_projects():
+        try:
+            project_updated = False
+
+            docs_dir = project_dir / 'docs'
+            if not docs_dir.exists():
+                logger.error(f"Document directory does not exist: {docs_dir}")
+                continue
+
+            # 设置.gitattributes文件
+            global_updated = setup_gitattributes(docs_dir)
+
+            # 获取docs目录下已跟踪(tracked)的markdown文件
+            cmd = ["git", "ls-files", "*.md"]
+            result = subprocess.run(cmd, cwd=docs_dir, capture_output=True, text=True)
+            tracked_files = result.stdout.splitlines() if result.stdout else []
+
+            if not tracked_files:
+                logger.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
+
+                    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:
+                    logger.error(f"Error processing file {rel_path}: {e}")
+                    continue
+
+            # 标记删除不再跟踪的文件
+            if len(jsonl_dates_cache) > len(tracked_files):
+                project_updated = True
+
+            # 如果有更新，写入JSONL缓存文件
+            if project_updated or not jsonl_cache_file.exists():
+                global_updated = write_jsonl_cache(jsonl_cache_file, jsonl_dates_cache, tracked_files)
+        except subprocess.CalledProcessError as e:
+            logger.error(f"Failed to execute git command: {e}")
+            continue
+        except Exception as e:
+            logger.error(f"Error processing project directory {project_dir}: {e}")
+            continue
+    return global_updated
+
+
+if __name__ == "__main__":
+    update_cache()

mkdocs_document_dates-3.2/mkdocs_document_dates/hooks_installer.py

@@ -0,0 +1,109 @@
+import os
+import sys
+import logging
+import subprocess
+from pathlib import Path
+import platform
+
+logger = logging.getLogger("mkdocs.plugins.document_dates")
+logger.setLevel(logging.WARNING)  # DEBUG, INFO, WARNING, ERROR, CRITICAL
+
+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)
+        if result.returncode == 0 and result.stdout.strip().lower() == 'true':
+            return True
+        else:
+            logger.warning(f"Low python version, requires python_requires >=3.7")
+    except Exception as e:
+        logger.info(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 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:
+        logger.error(f"No permission to create directory: {config_dir}")
+    except Exception as e:
+        logger.error(f"Failed to create directory {config_dir}: {str(e)}")
+    return None
+
+def install_hook_file(source_dir: Path, target_dir: Path):
+    try:
+        shebang = detect_python_interpreter()
+        for item in source_dir.iterdir():
+            # 跳过隐藏文件和目录
+            if item.name.startswith('.') or not item.is_file():
+                continue
+            # 添加 shebang 行
+            content = item.read_text(encoding='utf-8')
+            if content.startswith('#!'):
+                content = shebang + os.linesep + content[content.find('\n')+1:]
+            else:
+                content = shebang + os.linesep + content
+
+            target_hook_path = target_dir / item.name
+            target_hook_path.write_text(content, encoding='utf-8')
+            os.chmod(target_hook_path, 0o755)
+
+        return True
+    except Exception as e:
+        logger.error(f"Failed to create hook file {target_hook_path}: {str(e)}")
+    return False
+
+def configure_git_hooks(hooks_dir):
+    try:
+        # 配置自定义合并驱动
+        # script_path = hooks_dir / 'json_merge_driver.py'
+        # subprocess.run(['git', 'config', '--global', 'merge.custom_json_merge.name', 'Custom JSON merge driver'], check=True)
+        # subprocess.run(['git', 'config', '--global', 'merge.custom_json_merge.driver', f'"{sys.executable}" "{script_path}" %O %A %B'], check=True)
+
+        subprocess.run(['git', 'config', '--global', 'core.hooksPath', str(hooks_dir)], check=True)
+        logger.info(f"Git hooks successfully installed in: {hooks_dir}")
+        return True
+    except Exception:
+        logger.warning("Git not detected, using plugin in a no-Git environment")
+    return False
+
+def install():
+    try:
+        # 创建hooks目录
+        target_dir = setup_hooks_directory()
+        if not target_dir:
+            return False
+
+        # 安装hook文件
+        source_dir = Path(__file__).parent / 'hooks'
+        if not install_hook_file(source_dir, target_dir):
+            return False
+
+        # 配置git hooks路径
+        return configure_git_hooks(target_dir)
+
+    except Exception as e:
+        logger.error(f"Unexpected error during hooks installation: {str(e)}")
+        return False
+
+if __name__ == '__main__':
+    install()