feat(core): add PluginConfig interface

closes #996
danielsogl · Jan 22, 2017 · b983de2 · b983de2
1 parent 9f98f8e
commit b983de2
Showing 1 changed file with 31 additions and 1 deletion.
diff --git a/src/plugins/plugin.ts b/src/plugins/plugin.ts
@@ -320,6 +320,36 @@ export const wrap = function(pluginObj: any, methodName: string, opts: any = {})
   };
 };
 
+/**
+ * @private
+ */
+export interface PluginConfig {
+  /**
+   * Plugin name, this should match the class name
+   */
+  pluginName: string;
+  /**
+   * Plugin NPM package name
+   */
+  plugin: string;
+  /**
+   * Plugin object reference
+   */
+  pluginRef: string;
+  /**
+   * Github repository URL
+   */
+  repo: string;
+  /**
+   * Custom install command
+   */
+  install?: string;
+  /**
+   * Supported platforms
+   */
+  platforms?: string[];
+}
+
 /**
  * @private
  *
@@ -339,7 +369,7 @@ export const wrap = function(pluginObj: any, methodName: string, opts: any = {})
  *  }
  * ```
  */
-export function Plugin(config) {
+export function Plugin(config: PluginConfig) {
   return function(cls) {
 
     // Add these fields to the class