StyAndCo/zeppelin
3
0
Fork 0
mirror of https://github.com/ZeppelinBot/Zeppelin.git synced 2025-05-18 23:55:02 +00:00
Code Releases Activity

Auto-generate plugin docs (WIP)

Browse source
This commit is contained in:
Dragory 2019-08-22 01:22:26 +03:00
parent 7468e5348d
commit 9e69b3bf5b
44 changed files with 599 additions and 150 deletions
Download patch file Download diff file Expand all files Collapse all files

13
src/plugins/ZeppelinPlugin.ts
View file

@ -22,12 +22,21 @@ import { mergeConfig } from "knub/dist/configUtils";
const SLOW_RESOLVE_THRESHOLD = 1500;
export interface PluginInfo {
name: string;
prettyName: string;
description?: string;
}
export interface CommandInfo {
description?: string;
basicUsage?: string;
parameterDescriptions?: {
[key: string]: string;
};
}
export class ZeppelinPlugin<TConfig extends {} = IBasePluginConfig> extends Plugin<TConfig> {
public static pluginInfo: PluginInfo;
public static showInDocs: boolean = true;
protected static configSchema: t.TypeC<any>;
public static dependencies = [];
@ -51,7 +60,7 @@ export class ZeppelinPlugin<TConfig extends {} = IBasePluginConfig> extends Plug
* we need a static version of getDefaultOptions(). This static version is then,
* by turn, called from getDefaultOptions() so everything still works as expected.
*/
protected static getStaticDefaultOptions() {
public static getStaticDefaultOptions() {
// Implemented by plugin
return {};
}