ci: update config and add watch dog

Author: Mara-Li

Taskfile.yml

@@ -14,7 +14,7 @@ tasks:
     desc: "Clean up old build files"
     cmds:
       - echo "Cleaning build directories..."
-      - rm -r -Force {{pyproject_dir}}/dist {{pyproject_dir}}/*.egg-info {{pyproject_dir}}/.pytest_cache
+      - rm -r -Force {{.pyproject_dir}}/dist {{.pyproject_dir}}/*.egg-info {{.pyproject_dir}}/.pytest_cache
 
   version:
     desc: "Run semantic-release to determine and bump the version"
@@ -40,8 +40,8 @@ tasks:
         package_path: "mkdocs-obsidian-wikilinks"
         mkdocs_path: "../mara-li"
       cmds:
-        - echo "Starting Watchdog for {{package_path}} with MkDocs at {{mkdocs_path}}..."
-        - uv python watch.py {{package_path}} {{mkdocs_path}}
+        - echo "Starting Watchdog for {{.package_path}} with MkDocs at {{.mkdocs_path}}..."
+        - uv python watch.py {{.package_path}} {{.mkdocs_path}}
 
   release:
     desc: "Perform a full release: version bump, build, and publish"

pyproject.toml

@@ -2,7 +2,6 @@
 name = "mkdocs-embed-file-plugin"
 version = "2.0.10"
 description = "A plugin to quote file from docs"
-readme = "README.md"
 requires-python = ">=3.13"
 dependencies = [
     "mkdocs",
@@ -18,7 +17,7 @@ dependencies = [
 authors = [
     { name = "Mara-Li", email = "mara-li@outlook.fr" }
 ]
-license = "AGPL"
+license = "AGPL-3.0-or-later"
 readme = "README.md"
 keywords = [
     "obsidian",
@@ -54,4 +53,13 @@ packages = ["mkdocs_embed_file_plugins"]
 homepage = "https://github.com/ObsidianPublisher/mkdocs-embed_file-plugin"
 
 [project.entry-points."mkdocs.plugins"]
-embed_file = "mkdocs_embed_file_plugins.plugin:EmbedFile"
+embed_file = "mkdocs_embed_file_plugins.plugin:EmbedFile"
+
+[dependency-groups]
+dev = [
+    "ruff>=0.1.0",
+    "watchdog>=2.1.6",
+    "python-semantic-release>=9.15.2",
+    "build>=0.6.0",
+    "rich>=13.9.4",
+]

setup.py

@@ -1,9 +1,14 @@
+import threading
+
 from watchdog.observers import Observer
 from watchdog.events import FileSystemEventHandler
 import subprocess
 import os
 import time
 import signal
+from pathlib import Path
+from rich.console import Console
+from rich.panel import Panel
 
 # parse arg
 import argparse
@@ -12,51 +17,77 @@
 parser.add_argument("package_path", type = str, help = "Path to the package to watch.")
 parser.add_argument("mkdocs_path", type = str, help = "Path to the MkDocs folder.")
 args = parser.parse_args()
-package_path = args.package_path
-mkdocs_path = args.mkdocs_path
+package_path = Path(args.package_path)
+mkdocs_path = Path(args.mkdocs_path)
+console = Console()
 
 
 class PackageWatchHandler(FileSystemEventHandler) :
     def __init__(self, package_path, mkdocs_path) :
         self.package_path = package_path
         self.mkdocs_path = mkdocs_path
         self.mkdocs_process = None
+        self.mkdocs_process = None
+        self.log_thread = None
+        self.stop_logging = False
+
+    def log_output(self, process) :
+        """Thread for logging MkDocs output with Rich."""
+        while process.poll() is None :  # Check if process is still running
+            line = process.stdout.readline()
+            if line :
+                # Utilise Rich pour afficher les logs stylisés
+                if "ERROR" in line :
+                    console.log(f"[bold red][MkDocs ERROR][/bold red]: {line.strip()}")
+                elif "WARNING" in line :
+                    console.log(f"[bold yellow][MkDocs WARNING][/bold yellow]: {line.strip()}")
+                else :
+                    console.log(f"[bold green][MkDocs][/bold green]: {line.strip()}")
 
     def start_mkdocs(self) :
         """Démarre le serveur MkDocs avec python -m mkdocs."""
-        print("Starting MkDocs server...")
+        console.print(Panel(f"Starting MkDocs server for {self.mkdocs_path}...", style = "bold blue"))
         self.mkdocs_process = subprocess.Popen(
-                ["python", "-m", "mkdocs", "serve"],
+                ["uv", "run", "mkdocs", "--color", "serve"],
                 cwd = self.mkdocs_path,
                 stdout = subprocess.PIPE,
-                stderr = subprocess.PIPE,
-                text = True,
+                stderr = subprocess.STDOUT,
+                universal_newlines = True,
+                bufsize = 1,
+                )
+        self.stop_logging = False
+        self.log_thread = threading.Thread(target = self.log_output, args = (self.mkdocs_process,))
+        self.log_thread.start()
+        console.print(
+                Panel("MkDocs server started at [bold blue]https://127.0.0.1:8000[/bold blue].", style = "bold green")
                 )
-        print("MkDocs server started.")
 
     def stop_mkdocs(self) :
-        """Arrête le serveur MkDocs proprement."""
+        """Stop the MkDocs server."""
         if self.mkdocs_process :
-            print("Stopping MkDocs server...")
+            console.print(Panel("Stopping MkDocs server...", style = "bold red"))
+            self.stop_logging = True
             self.mkdocs_process.terminate()
             try :
                 self.mkdocs_process.wait(timeout = 5)
             except subprocess.TimeoutExpired :
                 os.kill(self.mkdocs_process.pid, signal.SIGKILL)
-            print("MkDocs server stopped.")
+            if self.log_thread :
+                self.log_thread.join()
             self.mkdocs_process = None
+            console.print(Panel("MkDocs server stopped.", style = "bold red"))
 
     def restart_mkdocs(self) :
-        """Redémarre le serveur MkDocs."""
+        """Restart the MkDocs server."""
         self.stop_mkdocs()
         self.start_mkdocs()
 
     def on_any_event(self, event) :
-        """Réagit aux modifications de fichiers."""
+        """React to file changes."""
         if event.is_directory or not event.src_path.endswith(".py") :
             return
-        print(f"Change detected in {event.src_path}. Reinstalling package...")
-        subprocess.run(["pip", "install", "-e", self.package_path], check = True)
+        console.print(Panel(f"Change detected in {event.src_path}. Reinstalling package...", style = "bold yellow"))
+        subprocess.run(["uv", "pip", "install", "-e", self.package_path], check = True)
         self.restart_mkdocs()
 
 
@@ -66,27 +97,22 @@ def on_any_event(self, event) :
 
     # Vérifie si le dossier MkDocs existe
     if not os.path.isdir(mkdocs_path) :
-        print(f"Error: MkDocs path '{mkdocs_path}' does not exist.")
+        console.print(f"[bold red]Error:[/bold red] MkDocs path '{mkdocs_path}' does not exist.")
         exit(1)
 
     event_handler = PackageWatchHandler(package_path, mkdocs_path)
     observer = Observer()
     observer.schedule(event_handler, package_path, recursive = True)
 
-    print(f"Watching for changes in {package_path}...")
-    event_handler.start_mkdocs()  # Lancer MkDocs au début
+    console.print(f"[bold green]Watching for changes in {package_path}...[/bold green]")
+    event_handler.start_mkdocs()
     observer.start()
 
     try :
         while True :
-            # Lire les logs de MkDocs pendant que le script tourne
-            if event_handler.mkdocs_process :
-                output = event_handler.mkdocs_process.stdout.readline()
-                if output :
-                    print(f"[MkDocs]: {output.strip()}")
             time.sleep(1)
     except KeyboardInterrupt :
-        print("Shutting down...")
+        console.print("[bold red]Shutting down...[/bold red]")
         observer.stop()
         event_handler.stop_mkdocs()
-    observer.join()
+    observer.join()