https://github.com/randy3k/AutomaticPackageReloader

Automatically reload submodules while developing a Sublime Text package.
https://github.com/randy3k/AutomaticPackageReloader

Last synced: 15 days ago
JSON representation

Automatically reload submodules while developing a Sublime Text package.

• Host: GitHub
• URL: https://github.com/randy3k/AutomaticPackageReloader
• Owner: randy3k
• License: mit
• Created: 2016-07-11T08:24:16.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2024-08-15T19:31:22.000Z (3 months ago)
• Last Synced: 2024-10-28T11:23:20.940Z (15 days ago)
• Language: Python
• Homepage:
• Size: 699 KB
• Stars: 37
• Watchers: 7
• Forks: 13
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# 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](https://packagecontrol.io/) 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.

![](shot.png)

### 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.

```js

{

  "dependencies" : ["", ""]

}

```

### Credits

This is derived from the [code](https://github.com/divmain/GitSavvy/blob/599ba3cdb539875568a96a53fafb033b01708a67/common/util/reload.py) of Eldar Abusalimov.