Class PluginManagement

Defined in:	lib/mixins/plugin-management.coffee
Inherits:	Mixin

Overview

Provides methods to manage minimap plugins.

Minimap plugins are Atom packages that will augment the minimap. They have a secondary activation cycle going on constrained by the minimap package activation. A minimap plugin life cycle will generally look like this:

The plugin module is activated by Atom through the activate method
The plugin then register itself as a minimap plugin using registerPlugin
The plugin is activated/deactivated according to the minimap settings.
On the plugin module deactivation, the plugin must unregisters itself from the minimap using the unregisterPlugin.

Instance Method Summary

::registerPlugin(name, plugin) Registers a minimap plugin with the given name.
::unregisterPlugin(name) Unregisters a plugin from the minimap.

Instance Method Details

::registerPlugin(name, plugin) Source

Registers a minimap plugin with the given name.

Parameters:

(String) name — The identifying String name of the plugin. It will be used as activation settings name as well as the key to unregister the module.
(Object) plugin — The plugin Object to register.

::unregisterPlugin(name) Source

Unregisters a plugin from the minimap.

Parameters:

(String) name — The identifying String name of the plugin to unregister.