From 41dab54df3a5d3a4ddd36529483941fd410ffa2b Mon Sep 17 00:00:00 2001
From: Artemy <artegoser@gmail.com>
Date: Tue, 14 May 2024 14:51:22 +0300
Subject: [PATCH] doc: plugin config comments

---
 packages/server/src/config/pluginConfig.ts                  | 2 +-
 packages/server/src/types/{appConfig.ts => pluginConfig.ts} | 6 ++++++
 2 files changed, 7 insertions(+), 1 deletion(-)
 rename packages/server/src/types/{appConfig.ts => pluginConfig.ts} (61%)

diff --git a/packages/server/src/config/pluginConfig.ts b/packages/server/src/config/pluginConfig.ts
index 349e6af..1e7b139 100644
--- a/packages/server/src/config/pluginConfig.ts
+++ b/packages/server/src/config/pluginConfig.ts
@@ -1,4 +1,4 @@
-import { IAppConfig } from '../types/appConfig';
+import { IAppConfig } from '../types/pluginConfig';
 import { engineList } from '@txtdot/plugins';
 import { compile } from 'html-to-text';
 
diff --git a/packages/server/src/types/appConfig.ts b/packages/server/src/types/pluginConfig.ts
similarity index 61%
rename from packages/server/src/types/appConfig.ts
rename to packages/server/src/types/pluginConfig.ts
index efad8af..634d48c 100644
--- a/packages/server/src/types/appConfig.ts
+++ b/packages/server/src/types/pluginConfig.ts
@@ -3,6 +3,12 @@ import { Engine } from '@txtdot/sdk';
 type Html2TextConverter = (html: string) => string;
 
 export interface IAppConfig {
+  /**
+   * List of engines, ordered
+   */
   engines: Engine[];
+  /**
+   * HTML to text converter, if engine doesn't support text
+   */
   html2text?: Html2TextConverter;
 }