Refactor logging in GenerateCommand and FileItem for improved clarity and structure

Author: httpdss

struct_module/commands/generate.py

@@ -22,7 +22,9 @@ def __init__(self, parser):
     parser.set_defaults(func=self.execute)
 
   def execute(self, args):
-    self.logger.info(f"Generating structure at {args.base_path} with config {args.structure_definition}")
+    self.logger.info(f"Generating structure")
+    self.logger.info(f"  Structure definition: {args.structure_definition}")
+    self.logger.info(f"  Base path: {args.base_path}")
 
     if args.backup and not os.path.exists(args.backup):
       os.makedirs(args.backup)
@@ -96,11 +98,14 @@ def _create_structure(self, args):
           self.logger.info(f"[DRY RUN] Would create folder: {folder_path}")
           continue
         os.makedirs(folder_path, exist_ok=True)
-        self.logger.info(f"Created folder: {folder_path}")
+        self.logger.info(f"Created folder")
+        self.logger.info(f"  Folder: {folder_path}")
 
         # check if content has struct value
         if 'struct' in content:
-          self.logger.info(f"Generating structure in folder: {folder} with struct {content['struct']}")
+          self.logger.info(f"Generating structure")
+          self.logger.info(f"  Folder: {folder}")
+          self.logger.info(f"  Struct: {content['struct']}")
 
           # get vars from with param. this will be a dict of key value pairs
           merged_vars = ""

struct_module/file_item.py

@@ -121,7 +121,8 @@ def create(self, base_path, dry_run=False, backup_path=None, file_strategy='over
       file_path = os.path.join(base_path, self.name)
 
       if self.skip:
-        self.logger.info(f"Skipping file creation: {file_path}")
+        self.logger.info(f"Skipping file creation")
+        self.logger.info(f"  File path: {file_path}")
         return
 
       if dry_run:
@@ -141,7 +142,7 @@ def create(self, base_path, dry_run=False, backup_path=None, file_strategy='over
           return
         elif file_strategy == 'append':
           with open(file_path, 'a') as f:
-              f.write(self.content)
+              f.write(f"{self.content}\n")
           self.logger.info(f"Appended to existing file: {file_path}")
           return
         elif file_strategy == 'rename':
@@ -150,9 +151,13 @@ def create(self, base_path, dry_run=False, backup_path=None, file_strategy='over
           self.logger.info(f"Renamed existing file: {file_path} to {new_name}")
 
       with open(file_path, 'w') as f:
-        f.write(self.content)
-      self.logger.debug(f"Created file: {file_path} with content: \n\n{self.content}")
+        f.write(f"{self.content}\n")
+      self.logger.debug(f"Created file with content")
+      self.logger.debug(f"  File path: {file_path}")
+      self.logger.debug(f"  Content: \n\n{self.content}")
 
       if self.permissions:
         os.chmod(file_path, int(self.permissions, 8))
-        self.logger.info(f"Set permissions {self.permissions} for file: {file_path}")
+        self.logger.info(f"Set permissions to file")
+        self.logger.info(f"  File path: {file_path}")
+        self.logger.info(f"  Permissions: {self.permissions}")