Added the "Install Local Dependency" command for package developers

Author: wbond

Default.sublime-commands

@@ -31,6 +31,10 @@
         "caption": "Package Control: Grab CA Certs",
         "command": "grab_certs"
     },
+    {
+        "caption": "Package Control: Install Local Dependency",
+        "command": "install_local_dependency"
+    },
     {
         "caption": "Package Control: Install Package",
         "command": "install_package"

package_control/commands/__init__.py

@@ -7,6 +7,7 @@
 from .disable_package_command import DisablePackageCommand
 from .discover_packages_command import DiscoverPackagesCommand
 from .enable_package_command import EnablePackageCommand
+from .install_local_dependency_command import InstallLocalDependencyCommand
 from .install_package_command import InstallPackageCommand
 from .list_packages_command import ListPackagesCommand
 from .list_unmanaged_packages_command import ListUnmanagedPackagesCommand
@@ -28,6 +29,7 @@
     'DisablePackageCommand',
     'DiscoverPackagesCommand',
     'EnablePackageCommand',
+    'InstallLocalDependencyCommand',
     'InstallPackageCommand',
     'ListPackagesCommand',
     'ListUnmanagedPackagesCommand',

package_control/commands/install_local_dependency_command.py

@@ -0,0 +1,77 @@
+import sublime
+import sublime_plugin
+
+import os
+
+from .. import text, loader
+from ..show_quick_panel import show_quick_panel
+from ..package_manager import PackageManager
+
+
+class InstallLocalDependencyCommand(sublime_plugin.WindowCommand):
+
+    """
+    A command that finds allows package developers to install a dependency that
+    exists in the Packages/ folder, but is not currently being loaded.
+    """
+
+    def run(self):
+        self.manager = PackageManager()
+        dependencies = self.manager.list_unloaded_dependencies()
+        self.dependency_list = sorted(dependencies, key=lambda s: s.lower())
+        if not self.dependency_list:
+            sublime.message_dialog(text.format(
+                u'''
+                Package Control
+
+                All local dependencies are currently loaded
+                '''
+            ))
+            return
+        show_quick_panel(self.window, self.dependency_list, self.on_done)
+
+    def on_done(self, picked):
+        """
+        Quick panel user selection handler - addds a loader for the selected
+        dependency
+
+        :param picked:
+            An integer of the 0-based package name index from the presented
+            list. -1 means the user cancelled.
+        """
+
+        if picked == -1:
+            return
+        dependency = self.dependency_list[picked]
+
+        dependency_path = self.manager.get_package_dir(dependency)
+        hidden_file_path = os.path.join(dependency_path, '.sublime-dependency')
+        loader_py_path = os.path.join(dependency_path, 'loader.py')
+        loader_code_path = os.path.join(dependency_path, 'loader.code')
+
+        priority = None
+
+        # Look in the .sublime-dependency file to see where in the dependency
+        # load order this dependency should be installed
+        if os.path.exists(hidden_file_path):
+            with open(hidden_file_path, 'rb') as f:
+                data = f.read().decode('utf-8').strip()
+                if data.isdigit():
+                    priority = int(data)
+
+        if priority is None:
+            priority = 50
+
+        code = None
+        is_py_loader = os.path.exists(loader_py_path)
+        is_code_loader = os.path.exists(loader_code_path)
+        if is_py_loader or is_code_loader:
+            loader_path = loader_code_path if is_code_loader else loader_py_path
+            with open(loader_path, 'rb') as f:
+                code = f.read()
+
+        loader.add(priority, dependency, code)
+
+        sublime.status_message(('Dependency %s successfully added to ' +
+            'dependency loader - restarting Sublime Text may be required') %
+            dependency)

package_control/package_manager.py

@@ -582,6 +582,22 @@ def list_dependencies(self):
 
         return sorted(output, key=lambda s: s.lower())
 
+    def list_unloaded_dependencies(self):
+        """
+        :return:
+            A list of the names of dependencies in the Packages/ folder that
+            are not currently being loaded
+        """
+
+        output = []
+        for name in self._list_visible_dirs(self.settings['packages_path']):
+            hidden_file_path = os.path.join(self.settings['packages_path'], name, '.sublime-dependency')
+            if not os.path.exists(hidden_file_path):
+                continue
+            if not loader.exists(name):
+                output.append(name)
+        return output
+
     def list_all_packages(self, exclude_dependencies=True):
         """
         Lists all packages on the machine

package_control/reloader.py

@@ -123,6 +123,7 @@
     '.commands.discover_packages_command',
     '.commands.enable_package_command',
     '.commands.existing_packages_command',
+    '.commands.install_local_dependency_command',
     '.commands.install_package_command',
     '.commands.list_packages_command',
     '.commands.list_unmanaged_packages_command',