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

Package Control please.

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 would try its best to guess the dependent modules of the package. Sometimes, it may fail to detect all the dependencies. In those cases, developers could specify extra modules to be reloaded in the .package_reloader.json file.

{
  "dependencies" : ["<module1>", "<module2>"]
}

Credits

This is derived from the code of Eldar Abusalimov.