Add info types for ZeppelinPluginBlueprint
This commit is contained in:
parent
cc320728f0
commit
a3d0ec03d9
2 changed files with 9 additions and 1 deletions
|
@ -1,11 +1,19 @@
|
||||||
import { BasePluginType, plugin, PluginBlueprint } from "knub";
|
import { BasePluginType, plugin, PluginBlueprint } from "knub";
|
||||||
import * as t from "io-ts";
|
import * as t from "io-ts";
|
||||||
import { getPluginConfigPreprocessor } from "../pluginUtils";
|
import { getPluginConfigPreprocessor } from "../pluginUtils";
|
||||||
|
import { TMarkdown } from "../types";
|
||||||
|
|
||||||
export interface ZeppelinPluginBlueprint<TPluginType extends BasePluginType = BasePluginType>
|
export interface ZeppelinPluginBlueprint<TPluginType extends BasePluginType = BasePluginType>
|
||||||
extends PluginBlueprint<TPluginType> {
|
extends PluginBlueprint<TPluginType> {
|
||||||
configSchema?: t.TypeC<any>;
|
configSchema?: t.TypeC<any>;
|
||||||
showInDocs?: boolean;
|
showInDocs?: boolean;
|
||||||
|
|
||||||
|
info?: {
|
||||||
|
prettyName: string;
|
||||||
|
description?: TMarkdown;
|
||||||
|
usageGuide?: TMarkdown;
|
||||||
|
configurationGuide?: TMarkdown;
|
||||||
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
export function zeppelinPlugin<TPartialBlueprint extends Omit<ZeppelinPluginBlueprint, "name">>(
|
export function zeppelinPlugin<TPartialBlueprint extends Omit<ZeppelinPluginBlueprint, "name">>(
|
||||||
|
|
|
@ -15,7 +15,7 @@ export type TZeppelinKnub = Knub<IZeppelinGuildConfig, IZeppelinGlobalConfig>;
|
||||||
/**
|
/**
|
||||||
* Wrapper for the string type that indicates the text will be parsed as Markdown later
|
* Wrapper for the string type that indicates the text will be parsed as Markdown later
|
||||||
*/
|
*/
|
||||||
type TMarkdown = string;
|
export type TMarkdown = string;
|
||||||
|
|
||||||
export interface ZeppelinPluginInfo {
|
export interface ZeppelinPluginInfo {
|
||||||
prettyName: string;
|
prettyName: string;
|
||||||
|
|
Loading…
Add table
Reference in a new issue