Initial work for templates when creating files

Author: skuroda

AdvancedNewFile.sublime-settings

@@ -111,5 +111,14 @@
     "rename_default": "",
 
     // Setting to control if VCS management is used when moving and removing files.
-    "vcs_management": false
+    "vcs_management": false,
+
+    // An object containing information to use for templates when creating new files.
+    // The key values for this object should be a file extension. The value may either
+    // be a string of the content to be inserted or a list of paths. If a list of paths
+    // is specified, the name of the file will be displayed during selection. The paths
+    // must either be absolute, or be from the home directory of the user (`~/`). If a
+    // string is used, or the list contains a single entry, it will be automatically
+    // inserted into any newly created files.
+    "file_templates": {}
 }

README.md

@@ -152,6 +152,14 @@ String representing permissions to be applied to newly created files. E.g. "777"
 
 Default input for renaming a file. Special value `<filename>` will be replaced with the current file name. Special value `<filepath>` will be replaced with the absolute path of the current file.
 
+`vcs_management`:
+
+Setting to control if VCS management is used when moving and removing files.
+
+`file_templates`:
+
+An object containing information to use for templates when creating new files. The key values for this object should be a file extension. The value may either be a string of the content to be inserted or a list of paths. If a list of paths is specified, the name of the file will be displayed during selection. The paths must either be absolute, or be from the home directory of the user (`~/`). If a string is used, or the list contains a single entry, it will be automatically inserted into any newly created files.
+
 ### Project Specific Settings
 All of the above settings can also be specified as part of the project specific settings. These values override any previous values set by higher level settings, with aliases being an exception. Alias settings will be merged with higher level configurations for alias. In addition, if the same alias exist for both default/user settings and project settings, the project setting will take precedence.
 

advanced_new_file/anf_util.py

@@ -26,6 +26,7 @@
 FOLDER_PERMISSIONS_SETTING = "folder_permissions"
 RENAME_DEFAULT_SETTING = "rename_default"
 VCS_MANAGEMENT_SETTING = "vcs_management"
+FILE_TEMPLATES_SETTING = "file_templates"
 
 SETTINGS = [
     ALIAS_SETTING,
@@ -51,7 +52,8 @@
     FILE_PERMISSIONS_SETTING,
     FOLDER_PERMISSIONS_SETTING,
     RENAME_DEFAULT_SETTING,
-    VCS_MANAGEMENT_SETTING
+    VCS_MANAGEMENT_SETTING,
+    FILE_TEMPLATES_SETTING
 ]
 
 NIX_ROOT_REGEX = r"^/"
@@ -100,6 +102,10 @@ def get_settings(view):
     for setting in SETTINGS:
         local_settings[setting] = settings.get(setting)
 
+    if type(project_settings) != dict:
+        print("Invalid type %s for project settings" % type(project_settings))
+        return local_settings
+
     for key in project_settings:
         if key in SETTINGS:
             if key == "alias":

advanced_new_file/commands/__init__.py

@@ -1,5 +1,5 @@
 from .helper_commands import AnfReplaceCommand, AdvancedNewFileCommand
-from .new_file_command import AdvancedNewFileNew, AdvancedNewFileNewAtCommand
+from .new_file_command import AdvancedNewFileNew, AdvancedNewFileNewAtCommand, AdvancedNewFileNewEventListener
 from .delete_file_command import AdvancedNewFileDelete
 from .move_file_command import AdvancedNewFileMove, AdvancedNewFileMoveAtCommand
 
@@ -8,6 +8,7 @@
     "AdvancedNewFileCommand",
     "AdvancedNewFileNew",
     "AdvancedNewFileNewAtCommand",
+    "AdvancedNewFileNewEventListener",
     "AdvancedNewFileMove",
     "AdvancedNewFileMoveAtCommand",
     "AdvancedNewFileDelete"

advanced_new_file/commands/new_file_command.py

@@ -1,5 +1,7 @@
 import sublime_plugin
 import os
+import xml.etree.ElementTree as ET
+
 from .command_base import AdvancedNewFileBase
 from ..anf_util import *
 
@@ -21,7 +23,8 @@ def input_panel_caption(self):
 
     def entered_file_action(self, path):
         attempt_open = True
-        if not os.path.exists(path):
+        file_exist = os.path.exists(path)
+        if not file_exist:
             try:
                 self.create(path)
             except OSError as e:
@@ -30,7 +33,9 @@ def entered_file_action(self, path):
                                       "'. See console for details")
                 print("Exception: %s '%s'" % (e.strerror, e.filename))
         if attempt_open:
-            self.open_file(path)
+            file_view = self.open_file(path)
+            if not file_exist:
+                file_view.settings().set("_anf_new", True)
 
     def update_status_message(self, creation_path):
         if self.view is not None:
@@ -50,3 +55,40 @@ def run(self, dirs):
 
     def is_visible(self, dirs):
         return len(dirs) == 1
+
+
+class AdvancedNewFileNewEventListener(sublime_plugin.EventListener):
+    def on_load(self, view):
+        if view.settings().get("_anf_new", False):
+            _, extension = os.path.splitext(view.file_name())
+            extension = extension[1:]
+            settings = get_settings(view)
+            if extension in settings.get(FILE_TEMPLATES_SETTING):
+                template = settings.get(FILE_TEMPLATES_SETTING)[extension]
+                if type(template) == list:
+                    if len(template) == 1:
+                        view.run_command("insert_snippet", {"contents": self.get_snippet_from_file(template[0])})
+                    else:
+                        entries = list(map(self.get_basename, template))
+                        self.entries = list(map(self.expand_path, template))
+                        self.view = view
+                        view.window().show_quick_panel(entries, self.quick_panel_selection)
+                else:
+                    view.run_command("insert_snippet", {"contents": template})
+            view.settings().set("_anf_new", "")
+
+    def get_basename(self, path):
+        return os.path.basename(os.path.expanduser(path))
+
+    def expand_path(self, path):
+        return os.path.expanduser(path)
+
+    def quick_panel_selection(self, index):
+        if index < 0:
+            return
+        self.view.run_command("insert_snippet", {"contents": self.get_snippet_from_file(self.entries[index])})
+
+    def get_snippet_from_file(self, path):
+        tree = ET.parse(os.path.expanduser(path))
+        content = tree.find("content")
+        return content.text