New 0.2.0 version

Author: fsoft72

maid.py

@@ -1,5 +1,13 @@
 #!/usr/bin/env python3
 
+"""
+Program Name: Maid
+Usage: Aggregates Markdown files from directories and files.
+Author: Fabio Rotondo
+License: MIT License
+"""
+
+
 import argparse
 import os
 import mimetypes
@@ -8,6 +16,8 @@
 from pathlib import Path
 import fnmatch
 
+VERSION = "0.2.0"
+
 # default blacklist
 BLACKLIST = [
     ".git",
@@ -20,6 +30,53 @@
 ]
 
 
+def _ext2markdown(fname):
+    ext = os.path.splitext(fname)[1]
+    ext = ext.lower()
+    return {
+        ".py": "python",
+        ".sh": "bash",
+        ".js": "javascript",
+        ".json": "json",
+        ".html": "html",
+        ".css": "css",
+        ".md": "markdown",
+        ".txt": "text",
+        ".yml": "yaml",
+        ".yaml": "yaml",
+        ".xml": "xml",
+        ".csv": "csv",
+        ".ts": "typescript",
+        ".sql": "sql",
+        ".java": "java",
+        ".c": "c",
+        ".cpp": "cpp",
+        ".h": "c",
+        ".hpp": "cpp",
+        ".cs": "csharp",
+        ".php": "php",
+        ".rb": "ruby",
+        ".go": "go",
+        ".rs": "rust",
+        ".kt": "kotlin",
+        ".swift": "swift",
+        ".m": "objectivec",
+        ".pl": "perl",
+        ".r": "r",
+        ".lua": "lua",
+        ".ps1": "powershell",
+        ".bat": "batch",
+        ".cmd": "batch",
+        ".psm1": "powershell",
+        ".psd1": "powershell",
+        ".ps1xml": "powershell",
+        ".pssc": "powershell",
+        ".psrc": "powershell",
+        ".gd": "gdscript",
+        ".tscn": "gdscript",
+    }.get(ext, "text")
+
+
 def is_binary(file_path):
     """
     Check if a file is binary.
@@ -40,28 +97,25 @@ def process_file(file_path, markdown_content):
     if is_binary(file_path):
         file_type = mimetypes.guess_type(file_path)[0] or "Unknown"
         file_size = file_path.stat().st_size
-        markdown_content.append(
-            "---------------------------------------------------------------------\n"
-        )
-        markdown_content.append(f"## {file_path}\n")
-        markdown_content.append(
-            "---------------------------------------------------------------------\n"
-        )
+        markdown_content.append(("-" * 40) + "\n")
+        markdown_content.append(f"## FILE: {file_path}\n")
         markdown_content.append(f"- Type: {file_type}\n")
         markdown_content.append(f"- Size: {file_size} bytes\n\n")
     else:
+        logging.info(f"Processing file: {file_path}")
+
         with open(file_path, "r", encoding="utf-8", errors="ignore") as f:
             content = f.read()
-        markdown_content.append(
-            "---------------------------------------------------------------------\n"
-        )
-        markdown_content.append(f"## {file_path}\n")
-        markdown_content.append("```\n")
+
+        ext = _ext2markdown(file_path)
+        markdown_content.append(("-" * 40) + "\n\n")
+        markdown_content.append(f"## FILE: {file_path}\n\n")
+        markdown_content.append("```%s\n" % ext)
+        if ext == "markdown":
+            content = content.replace("```", "'''")
+
         markdown_content.append(content)
-        markdown_content.append("\n```\n")
-        markdown_content.append(
-            "---------------------------------------------------------------------\n\n\n"
-        )
+        markdown_content.append("```\n\n")
 
 
 def is_blacklisted(file_path, blacklist):
@@ -78,22 +132,22 @@ def load_maidignore(directory):
     """
     maidignore_path = os.path.join(directory, ".maidignore")
     if os.path.exists(maidignore_path):
+        logging.info(f"Found .maidignore in {directory}")
         with open(maidignore_path, "r") as f:
             return [
                 line.strip() for line in f if line.strip() and not line.startswith("#")
             ]
     return []
 
 
-def scan_directory(directory, markdown_content, global_blacklist, use_local_maidignore):
+def scan_directory(directory, markdown_content, global_blacklist):
     """
     Recursively scan a directory and process all files.
     """
     for root, dirs, files in os.walk(directory):
         local_blacklist = global_blacklist.copy()
 
-        if use_local_maidignore:
-            local_blacklist.extend(load_maidignore(root))
+        local_blacklist.extend(load_maidignore(root))
 
         # Filter out blacklisted directories
         dirs[:] = [d for d in dirs if not is_blacklisted(d, local_blacklist)]
@@ -114,12 +168,38 @@ def load_blacklist(blacklist_file):
         return [line.strip() for line in f if line.strip() and not line.startswith("#")]
 
 
+def _blacklist_init(args):
+    blacklist = args.blacklist
+
+    if args.blacklist_file:
+        blacklist.extend(load_blacklist(args.blacklist_file))
+
+    # load global blacklist from home directory '.maidignore' if exists
+    home = str(Path.home())
+    dirs = [
+        home,
+        os.path.join(home, ".maid"),
+        os.path.join(home, ".local", "share", "maid"),
+        os.path.join(home, ".config", "maid"),
+    ]
+    for d in dirs:
+        global_blacklist = load_maidignore(d)
+        blacklist.extend(global_blacklist)
+
+    return blacklist
+
+
 def main():
     parser = argparse.ArgumentParser(
         description="Create an aggregated Markdown file from directories and files."
     )
     parser.add_argument("paths", nargs="+", help="Directories or files to process")
-    parser.add_argument("-o", "--output", required=True, help="Output Markdown file")
+    parser.add_argument(
+        "-o",
+        "--output",
+        help="Output Markdown file full path (default: _content.md)",
+        default="_content.md",
+    )
     parser.add_argument("--log", action="store_true", help="Enable logging")
     parser.add_argument(
         "--blacklist",
@@ -130,11 +210,9 @@ def main():
     parser.add_argument(
         "--blacklist-file", help="File containing blacklist glob patterns"
     )
-    parser.add_argument(
-        "--local-maidignore",
-        action="store_true",
-        help="Enable reading of .maidignore files in directories",
-    )
+
+    parser.add_argument("--version", action="version", version=f"%(prog)s {VERSION}")
+
     args = parser.parse_args()
 
     if args.log:
@@ -144,19 +222,19 @@ def main():
             format="%(asctime)s - %(levelname)s - %(message)s",
         )
 
-    blacklist = args.blacklist
-
-    if args.blacklist_file:
-        blacklist.extend(load_blacklist(args.blacklist_file))
+    blacklist = _blacklist_init(args)
 
-    logging.info(f"Using global blacklist patterns: {blacklist}")
+    logging.info(f"Blacklist patterns: {blacklist}")
 
-    markdown_content = []
+    markdown_content = [
+        "# Content\n\nThis file was generated by [Maid](https://github.com/fsoft72/maid) v%s - by [Fabio Rotondo](https://github.com/fsoft72)\n\n"
+        % VERSION
+    ]
 
     for path in args.paths:
         if os.path.isdir(path):
             logging.info(f"Scanning directory: {path}")
-            scan_directory(path, markdown_content, blacklist, args.local_maidignore)
+            scan_directory(path, markdown_content, blacklist)
         elif os.path.isfile(path):
             if not is_blacklisted(path, blacklist):
                 logging.info(f"Processing file: {path}")