chore: formating src by ruff

Author: virtualguard101

src/mkdocs_note/cli.py

@@ -13,7 +13,7 @@
 
 def get_version():
 	"""Get the version of mkdocs-note package.
-	
+
 	Returns:
 	    str: Version string from package metadata
 	"""
@@ -92,7 +92,7 @@ def format_commands(self, ctx, formatter):
 @click.pass_context
 def cli(ctx):
 	"""MkDocs Note CLI - Manage notes and their assets structure.
-	
+
 	A command-line interface for managing MkDocs notes with co-located assets.
 	"""
 	ctx.ensure_object(dict)
@@ -103,12 +103,12 @@ def cli(ctx):
 @click.pass_context
 def new_command(ctx, file_path):
 	"""Create a new note file with proper asset structure.
-	
+
 	\b
 	Examples:
 	    mkdocs-note new docs/notes/my-note.md
 	    mkdocs-note new docs/notes/python/intro.md
-	
+
 	FILE_PATH: Path where the new note file should be created
 	"""
 	click.echo("⚠️  'new' command is not yet implemented")
@@ -121,15 +121,15 @@ def new_command(ctx, file_path):
 @click.pass_context
 def remove_command(ctx, file_path):
 	"""Remove a note file and its corresponding asset directory.
-	
+
 	\b
 	Aliases: rm
-	
+
 	\b
 	Examples:
 	    mkdocs-note remove docs/notes/test.md
 	    mkdocs-note rm docs/notes/test.md --yes
-	
+
 	FILE_PATH: Path to the note file to remove
 	"""
 	click.echo("⚠️  'remove' command is not yet implemented")
@@ -151,15 +151,15 @@ def rm_command(ctx, file_path):
 @click.pass_context
 def move_command(ctx, source, destination):
 	"""Move or rename a note file/directory and its asset directory.
-	
+
 	\b
 	Aliases: mv
-	
+
 	\b
 	Examples:
 	    mkdocs-note move docs/notes/old.md docs/notes/new.md
 	    mkdocs-note mv docs/notes/test.md docs/notes/archive
-	
+
 	\b
 	Arguments:
 	    SOURCE: Current path of the note file or directory
@@ -183,7 +183,7 @@ def mv_command(ctx, source, destination):
 @click.pass_context
 def clean_command(ctx):
 	"""Clean up orphaned asset directories without corresponding notes.
-	
+
 	\b
 	Examples:
 	    mkdocs-note clean --dry-run
@@ -198,10 +198,10 @@ def clean_command(ctx):
 @click.pass_context
 def template_command(ctx):
 	"""Manage the note template file.
-	
+
 	This command helps you check and create the template file
 	configured in your mkdocs.yml.
-	
+
 	\b
 	Examples:
 	    mkdocs-note template

src/mkdocs_note/config.py

@@ -15,7 +15,7 @@ class MkdocsNoteConfig(Config):
     """
 
 	recent_notes_config = config_opt.Type(
-		dict, 
+		dict,
 		default={
 			"enabled": False,
 			"insert_marker": "<!-- recent_notes -->",

src/mkdocs_note/graph.py

@@ -16,6 +16,7 @@
 
 logger = get_plugin_logger(__name__)
 
+
 class Graph:
 	"""Represents the connection graph between files."""
 
@@ -121,6 +122,7 @@ def to_dict(self):
 		"""Return the graph as a dictionary."""
 		return {"nodes": self.nodes, "edges": self.edges}
 
+
 def add_static_resouces(config: MkDocsConfig) -> None:
 	"""Add static resources into mkdocs config for network graph.
 
@@ -134,9 +136,10 @@ def add_static_resouces(config: MkDocsConfig) -> None:
 	if "css/graph.css" not in config["extra_css"]:
 		config["extra_css"].append("css/graph.css")
 
+
 def inject_graph_script(output: str, config: MkDocsConfig, debug: bool = False) -> str:
 	"""Inject the graph script into the HTML page.
-	
+
 	Args:
 		output (str): The HTML output.
 		config (MkDocsConfig): The MkDocs configuration.
@@ -166,9 +169,10 @@ def inject_graph_script(output: str, config: MkDocsConfig, debug: bool = False)
 		return output.replace("</body>", f"{options_script}</body>")
 	return output
 
+
 def copy_static_assets(static_dir: str, config: MkDocsConfig) -> None:
 	"""Copy static assets into the site directory.
-	
+
 	Args:
 		config (MkDocsConfig): The MkDocs configuration.
 	"""

src/mkdocs_note/plugin.py

@@ -12,16 +12,21 @@
 from mkdocs_note.config import MkdocsNoteConfig
 from mkdocs_note.utils import scanner
 from mkdocs_note.utils.meta import extract_title, extract_date
-from mkdocs_note.graph import Graph, add_static_resouces, inject_graph_script, copy_static_assets
+from mkdocs_note.graph import (
+	Graph,
+	add_static_resouces,
+	inject_graph_script,
+	copy_static_assets,
+)
 
 
 log = get_plugin_logger(__name__)
 
+
 class MkdocsNotePlugin(BasePlugin[MkdocsNoteConfig]):
 	"""Mkdocs Note Plugin entry point."""
 
 	notes_list: list[File] = []
-	
 
 	@event_priority(100)
 	def on_files(self, files: Files, config: MkDocsConfig) -> Files:
@@ -46,12 +51,7 @@ def on_config(self, config: MkDocsConfig) -> MkDocsConfig:
 
 		return config
 
-	def on_pre_build(
-		self,
-		*,
-		config: dict,
-		**kwagrs
-	) -> None:
+	def on_pre_build(self, *, config: dict, **kwagrs) -> None:
 		"""Handle pre-build."""
 		if self.config.graph_config["enabled"]:
 			self._graph = Graph(self.config.graph_config)
@@ -121,7 +121,7 @@ def on_post_build(
 			config (MkDocsConfig): The MkDocs configuration.
 		"""
 		# Build graph if enabled
-		if hasattr(self, '_graph') and hasattr(self, '_files'):
+		if hasattr(self, "_graph") and hasattr(self, "_files"):
 			self._graph(self._files)
 			self._write_graph_file(config=config)
 
@@ -150,7 +150,9 @@ def on_page_markdown(
 			str: The markdown content.
 		"""
 		# Only process recent notes on the note index page
-		if self.config.recent_notes_config["enabled"] and self.is_note_index_page(page.file):
+		if self.config.recent_notes_config["enabled"] and self.is_note_index_page(
+			page.file
+		):
 			markdown = insert_recent_note_links(
 				markdown=markdown,
 				notes_list=self.notes_list,
@@ -161,7 +163,6 @@ def on_page_markdown(
 
 		return markdown
 
-
 	def is_note_index_page(self, f: File) -> bool:
 		"""Check if the page is a note index page.
 
@@ -177,30 +178,30 @@ def is_note_index_page(self, f: File) -> bool:
 
 
 def insert_recent_note_links(
-    markdown: str,
-    notes_list: list[File],
-    insert_num: int,
-    replace_marker: str,
+	markdown: str,
+	notes_list: list[File],
+	insert_num: int,
+	replace_marker: str,
 ) -> str:
-    """Insert recent note links into the markdown.
-
-    Args:
-        markdown (str): The markdown content.
-        notes_list (list[File]): The list of valid notes.
-        insert_num (int): The number of recent notes to insert.
-        replace_marker (str): The marker to replace.
-
-    Returns:
-        str: The markdown content with recent note links inserted.
-    """
-
-    content = "<ul>\n"
-    for f in notes_list[:insert_num]:
-        title = extract_title(f)
-        date = extract_date(f).strftime("%Y-%m-%d %H:%M:%S")
-        # Use f.url (relative URL) or f.page.url if page is available
-        url = f.page.url if hasattr(f, 'page') and f.page else f.url
-        # No indentation to avoid Markdown treating it as code block
-        content += f'<li><div style="display:flex; justify-content:space-between; align-items:center;"><a href="{url}">{title}</a><span style="font-size:0.8em; color:#888;">{date}</span></div></li>\n'
-    content += "</ul>\n"
-    return markdown.replace(replace_marker, content)
+	"""Insert recent note links into the markdown.
+
+	Args:
+	    markdown (str): The markdown content.
+	    notes_list (list[File]): The list of valid notes.
+	    insert_num (int): The number of recent notes to insert.
+	    replace_marker (str): The marker to replace.
+
+	Returns:
+	    str: The markdown content with recent note links inserted.
+	"""
+
+	content = "<ul>\n"
+	for f in notes_list[:insert_num]:
+		title = extract_title(f)
+		date = extract_date(f).strftime("%Y-%m-%d %H:%M:%S")
+		# Use f.url (relative URL) or f.page.url if page is available
+		url = f.page.url if hasattr(f, "page") and f.page else f.url
+		# No indentation to avoid Markdown treating it as code block
+		content += f'<li><div style="display:flex; justify-content:space-between; align-items:center;"><a href="{url}">{title}</a><span style="font-size:0.8em; color:#888;">{date}</span></div></li>\n'
+	content += "</ul>\n"
+	return markdown.replace(replace_marker, content)

src/mkdocs_note/utils/meta.py

@@ -8,73 +8,79 @@
 
 logger = get_plugin_logger(__name__)
 
+
 def validate_frontmatter(f: File) -> bool:
-		"""Validate the frontmatter of the file
+	"""Validate the frontmatter of the file
+
+	Args:
+	    file (File): The file to validate
 
-		Args:
-		    file (File): The file to validate
+	Returns:
+	    bool: True if the frontmatter is valid, False otherwise
+	"""
+	try:
+		_, frontmatter = meta.get_data(f.content_string)
 
-		Returns:
-		    bool: True if the frontmatter is valid, False otherwise
-		"""
-		try:
-			_, frontmatter = meta.get_data(f.content_string)
+		if not frontmatter.get("publish", False):
+			logger.debug(f"Skipping {f.src_uri} because it is not published")
+			return False
 
-			if not frontmatter.get("publish", False):
-				logger.debug(f"Skipping {f.src_uri} because it is not published")
-				return False
+		if "date" not in frontmatter:
+			logger.error(f"Invalid frontmatter for {f.src_uri}: 'date' is required")
+			return False
 
-			if "date" not in frontmatter:
-				logger.error(f"Invalid frontmatter for {f.src_uri}: 'date' is required")
-				return False
+		date = frontmatter["date"]
+		if not isinstance(date, datetime):
+			logger.error(
+				f"Invalid frontmatter for {f.src_uri}: 'date' must be a datetime object"
+			)
+			return False
 
-			date = frontmatter["date"]
-			if not isinstance(date, datetime):
-				logger.error(f"Invalid frontmatter for {f.src_uri}: 'date' must be a datetime object")
-				return False
+		setattr(f, "note_date", date)
 
-			setattr(f, "note_date", date)
+		if "title" not in frontmatter:
+			logger.error(f"Invalid frontmatter for {f.src_uri}: 'title' is required")
+			return False
 
-			if "title" not in frontmatter:
-				logger.error(f"Invalid frontmatter for {f.src_uri}: 'title' is required")
-				return False
+		title = frontmatter["title"]
+		if not isinstance(title, str):
+			logger.error(
+				f"Invalid frontmatter for {f.src_uri}: 'title' must be a string"
+			)
+			return False
 
-			title = frontmatter["title"]
-			if not isinstance(title, str):
-				logger.error(f"Invalid frontmatter for {f.src_uri}: 'title' must be a string")
-				return False
+		setattr(f, "note_title", title)
+		return True
 
-			setattr(f, "note_title", title)
-			return True
+	except Exception as e:
+		logger.error(f"Error validating frontmatter for {f.src_uri}: {e}")
+		raise e
 
-		except Exception as e:
-			logger.error(f"Error validating frontmatter for {f.src_uri}: {e}")
-			raise e
 
 def extract_date(f: File) -> Optional[datetime]:
-		"""Extract date from docs file
-		Args:
-		    f (File): The file to extract date from
+	"""Extract date from docs file
+	Args:
+	    f (File): The file to extract date from
 
-		Returns:
-		    Optional[datetime]: The date if successful, None otherwise
-		"""
-		try:
-			return f.note_date
-		except Exception:
-			return None
+	Returns:
+	    Optional[datetime]: The date if successful, None otherwise
+	"""
+	try:
+		return f.note_date
+	except Exception:
+		return None
 
 
 def extract_title(f: File) -> Optional[str]:
-		"""Extract title from docs file
-
-		Args:
-		    f (File): The file to extract title from
-
-		Returns:
-		    Optional[str]: The title if successful, None otherwise
-		"""
-		try:
-			return f.note_title
-		except Exception:
-			return None
+	"""Extract title from docs file
+
+	Args:
+	    f (File): The file to extract title from
+
+	Returns:
+	    Optional[str]: The title if successful, None otherwise
+	"""
+	try:
+		return f.note_title
+	except Exception:
+		return None