Automatic Package Reloader

Sublime Text package developers may find themselves have to close and re-open ST multiple times when developing a package since ST doesn't reload all the submodules of a package when the files are edited. This tiny package helps in reloading the package without the need of reopening ST. The reloading order of the modules is in the exact same order as if they are loaded by Sublime Text.

Installation

By Package Control

1. Download & Install Sublime Text 3 (https://www.sublimetext.com/3)
2. Go to the menu Tools -> Install Package Control, then, wait few seconds until the installation finishes up
3. Now, Go to the menu Preferences -> Package Control
4. Type Add Channel on the opened quick panel and press Enter
5. Then, input the following address and press Enter

   https://raw.githubusercontent.com/evandrocoan/StudioChannel/master/channel.json
   

6. Go to the menu Tools -> Command Palette... (Ctrl+Shift+P)
7. Type Preferences: Package Control Settings – User on the opened quick panel and press Enter
8. Then, find the following setting on your Package Control.sublime-settings file:

   "channels":
   [
       "https://packagecontrol.io/channel_v3.json",
       "https://raw.githubusercontent.com/evandrocoan/StudioChannel/master/channel.json",
   ],

9. And, change it to the following, i.e., put the https://raw.githubusercontent... line as first:

   "channels":
   [
       "https://raw.githubusercontent.com/evandrocoan/StudioChannel/master/channel.json",
       "https://packagecontrol.io/channel_v3.json",
   ],

   • The https://raw.githubusercontent... line must to be added before the https://packagecontrol.io... one, otherwise, you will not install this forked version of the package, but the original available on the Package Control default channel https://packagecontrol.io...

   [!WARNING] Placing this custom channel before the default channel changes Package Control's resolution globally. Packages from this channel with the same name will override versions from the default channel.

   You can review the channel contents here: https://raw.githubusercontent.com/evandrocoan/StudioChannel/master/channel.json

10. Now, go to the menu Preferences -> Package Control
11. Type Install Package on the opened quick panel and press Enter
12. Then, search for AutomaticPackageReloader and press Enter

See also:

1. ITE - Integrated Toolset Environment
2. Package control docs for details.

Usage

To reload the package in the current window, use Automatic Package Reloader: Reload Current Project.

To activate reload on saving a *py file, use Automatic Package Reloader: Toggle Reload On Save. Package Reloader will guess the package name from the file path in order to reload the submodules and to reload the package.

The console panel will be shown when reloading fails, this behavior can be modified by the settings.

Add Reload Current Package build

It is recommended to add the following in your .sublime-project file so that c+b would invoke the reload action.

    "build_systems":
    [
      {
        "name": "Reload Current Package",
        "target": "package_reloader_reload",
      }
    ]

Additional modules

APR tries to find the modules that belong to a package and its dependencies. To reload an additional loaded module, list its import name under extra_modules in the package's .package_reloader.json file. Use dependencies for package names whose modules should also be reloaded.

{
  "dependencies": ["<package name>"],
  "extra_modules": ["<module import name>"]
}

Credits

This is derived from the code of Eldar Abusalimov.