add ability to add auto-generated dotdrop header in dotfiles

dotdrop/templategen.py

@@ -35,6 +35,7 @@ class Templategen:
                                variable_end_string=VAR_END,
                                comment_start_string=COMMENT_START,
                                comment_end_string=COMMENT_END)
+        self.env.globals['header'] = self._header
         self.log = Logger()
 
     def generate(self, src, profile):
@@ -42,6 +43,10 @@ class Templategen:
             return ''
         return self._handle_file(src, profile)
 
+    def _header(self, prepend=''):
+        """add a comment usually in the header of a dotfile"""
+        return '{}{}'.format(prepend, utils.header())
+
     def _handle_file(self, src, profile):
         """generate the file content from template"""
         filetype = utils.run(['file', '-b', src], raw=False, debug=self.debug)

dotdrop/utils.py

@@ -9,10 +9,12 @@ import subprocess
 import tempfile
 import os
 import shlex
+import datetime
 from shutil import rmtree
 
 # local import
 from dotdrop.logger import Logger
+from dotdrop.version import __version__ as VERSION
 
 LOG = Logger()
 
@@ -65,3 +67,11 @@ def samefile(path1, path2):
     if not os.path.exists(path2):
         return False
     return os.path.samefile(path1, path2)
+
+
+def header():
+    header = 'This dotfile is managed using dotdrop'
+    header += ' v{}'.format(VERSION)
+    now = datetime.datetime.now().strftime("%Y-%m-%d %H:%M")
+    header += ' / last updated {}'.format(now)
+    return header