From a3d0ec03d96285338eaad4b4b87d209f7dcfa615 Mon Sep 17 00:00:00 2001 From: Dragory <2606411+Dragory@users.noreply.github.com> Date: Wed, 22 Jul 2020 23:11:42 +0300 Subject: [PATCH] Add info types for ZeppelinPluginBlueprint --- backend/src/plugins/ZeppelinPluginBlueprint.ts | 8 ++++++++ backend/src/types.ts | 2 +- 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/backend/src/plugins/ZeppelinPluginBlueprint.ts b/backend/src/plugins/ZeppelinPluginBlueprint.ts index ac3bb54d..5e05b313 100644 --- a/backend/src/plugins/ZeppelinPluginBlueprint.ts +++ b/backend/src/plugins/ZeppelinPluginBlueprint.ts @@ -1,11 +1,19 @@ import { BasePluginType, plugin, PluginBlueprint } from "knub"; import * as t from "io-ts"; import { getPluginConfigPreprocessor } from "../pluginUtils"; +import { TMarkdown } from "../types"; export interface ZeppelinPluginBlueprint extends PluginBlueprint { configSchema?: t.TypeC; showInDocs?: boolean; + + info?: { + prettyName: string; + description?: TMarkdown; + usageGuide?: TMarkdown; + configurationGuide?: TMarkdown; + }; } export function zeppelinPlugin>( diff --git a/backend/src/types.ts b/backend/src/types.ts index 99fc3ae2..bdb7ae8c 100644 --- a/backend/src/types.ts +++ b/backend/src/types.ts @@ -15,7 +15,7 @@ export type TZeppelinKnub = Knub; /** * 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 { prettyName: string;