From ff8c507d58d2d5536feac8a9645fbf60ba46aa5a Mon Sep 17 00:00:00 2001 From: Wing-Kam Wong Date: Sat, 29 Oct 2022 16:57:11 +0800 Subject: [PATCH] refactor(nc-plugin): prettier source code --- packages/nc-plugin/src/index.ts | 14 ++++++------- packages/nc-plugin/src/lib/IEmailAdapter.ts | 21 +++++++------------ packages/nc-plugin/src/lib/IStorageAdapter.ts | 17 ++++++--------- .../nc-plugin/src/lib/IStorageAdapterV2.ts | 9 +++++--- .../src/lib/IWebhookNotificationAdapter.ts | 16 +++++++------- packages/nc-plugin/src/lib/XcEmailPlugin.ts | 11 ++++------ packages/nc-plugin/src/lib/XcPlugin.ts | 16 ++++++-------- packages/nc-plugin/src/lib/XcPluginConfig.ts | 13 ++++++------ packages/nc-plugin/src/lib/XcPluginHooks.ts | 21 +++++-------------- .../nc-plugin/src/lib/XcPluginMigration.ts | 5 +---- packages/nc-plugin/src/lib/XcStoragePlugin.ts | 9 +++----- .../src/lib/XcWebhookNotificationPlugin.ts | 10 ++++----- 12 files changed, 65 insertions(+), 97 deletions(-) diff --git a/packages/nc-plugin/src/index.ts b/packages/nc-plugin/src/index.ts index 723c6b9194..2f97977a35 100644 --- a/packages/nc-plugin/src/index.ts +++ b/packages/nc-plugin/src/index.ts @@ -1,13 +1,13 @@ +import IEmailAdapter, { XcEmail } from './lib/IEmailAdapter'; +import IStorageAdapter, { XcFile } from './lib/IStorageAdapter'; +import IStorageAdapterV2 from './lib/IStorageAdapterV2'; +import IWebhookNotificationAdapter from './lib/IWebhookNotificationAdapter'; +import XcEmailPlugin from './lib/XcEmailPlugin'; import XcPlugin from './lib/XcPlugin'; import XcPluginConfig from './lib/XcPluginConfig'; import XcPluginHooks from './lib/XcPluginHooks'; import XcPluginMigration from './lib/XcPluginMigration'; import XcStoragePlugin from './lib/XcStoragePlugin'; -import XcEmailPlugin from './lib/XcEmailPlugin'; -import IStorageAdapter, {XcFile} from './lib/IStorageAdapter'; -import IStorageAdapterV2 from './lib/IStorageAdapterV2'; -import IEmailAdapter, {XcEmail} from './lib/IEmailAdapter'; -import IWebhookNotificationAdapter from './lib/IWebhookNotificationAdapter'; import XcWebhookNotificationPlugin from './lib/XcWebhookNotificationPlugin'; export { @@ -23,5 +23,5 @@ export { XcEmail, IWebhookNotificationAdapter, XcWebhookNotificationPlugin, - IStorageAdapterV2 -} + IStorageAdapterV2, +}; diff --git a/packages/nc-plugin/src/lib/IEmailAdapter.ts b/packages/nc-plugin/src/lib/IEmailAdapter.ts index 05c9f22cbf..0e49f30f72 100644 --- a/packages/nc-plugin/src/lib/IEmailAdapter.ts +++ b/packages/nc-plugin/src/lib/IEmailAdapter.ts @@ -1,20 +1,15 @@ export default interface IEmailAdapter { - init(): Promise - mailSend(mail:XcEmail): Promise - test(email): Promise + init(): Promise; + mailSend(mail: XcEmail): Promise; + test(email): Promise; } - interface XcEmail { // from?:string; - to:string; - subject:string; - html?:string; - text?:string; -} - -export { - XcEmail + to: string; + subject: string; + html?: string; + text?: string; } - +export { XcEmail }; diff --git a/packages/nc-plugin/src/lib/IStorageAdapter.ts b/packages/nc-plugin/src/lib/IStorageAdapter.ts index 572157561a..7fa643f95c 100644 --- a/packages/nc-plugin/src/lib/IStorageAdapter.ts +++ b/packages/nc-plugin/src/lib/IStorageAdapter.ts @@ -1,12 +1,11 @@ export default interface IStorageAdapter { - init(): Promise - fileCreate(destPath: string, file: XcFile): Promise - fileDelete(filePath: string): Promise - fileRead(filePath: string): Promise - test(): Promise + init(): Promise; + fileCreate(destPath: string, file: XcFile): Promise; + fileDelete(filePath: string): Promise; + fileRead(filePath: string): Promise; + test(): Promise; } - interface XcFile { originalname: string; path: string; @@ -14,8 +13,4 @@ interface XcFile { size: number | string; } -export { - XcFile -} - - +export { XcFile }; diff --git a/packages/nc-plugin/src/lib/IStorageAdapterV2.ts b/packages/nc-plugin/src/lib/IStorageAdapterV2.ts index bbf90d68ce..c8563bc5c5 100644 --- a/packages/nc-plugin/src/lib/IStorageAdapterV2.ts +++ b/packages/nc-plugin/src/lib/IStorageAdapterV2.ts @@ -1,10 +1,13 @@ -import IStorageAdapter from "./IStorageAdapter"; +import IStorageAdapter from './IStorageAdapter'; export default interface IStorageAdapterV2 extends IStorageAdapter { - fileCreateByUrl(destPath: string, url: string, fileMeta?: FileMeta): Promise + fileCreateByUrl( + destPath: string, + url: string, + fileMeta?: FileMeta + ): Promise; } - interface FileMeta { fileName?: string; mimetype?: string; diff --git a/packages/nc-plugin/src/lib/IWebhookNotificationAdapter.ts b/packages/nc-plugin/src/lib/IWebhookNotificationAdapter.ts index 931e26f487..9a7e225d18 100644 --- a/packages/nc-plugin/src/lib/IWebhookNotificationAdapter.ts +++ b/packages/nc-plugin/src/lib/IWebhookNotificationAdapter.ts @@ -1,10 +1,10 @@ export default interface IWebhookNotificationAdapter { - init(): Promise - - sendMessage(content: string, webhooks: Array<{ - webhook_url: string - }>): Promise; + init(): Promise; + + sendMessage( + content: string, + webhooks: Array<{ + webhook_url: string; + }> + ): Promise; } - - - diff --git a/packages/nc-plugin/src/lib/XcEmailPlugin.ts b/packages/nc-plugin/src/lib/XcEmailPlugin.ts index 92825e56e4..06aa38e8f0 100644 --- a/packages/nc-plugin/src/lib/XcEmailPlugin.ts +++ b/packages/nc-plugin/src/lib/XcEmailPlugin.ts @@ -1,11 +1,8 @@ -import XcPlugin from "./XcPlugin"; -import IEmailAdapter from "./IEmailAdapter"; - -abstract class XcEmailPlugin extends XcPlugin{ - - abstract getAdapter():IEmailAdapter +import IEmailAdapter from './IEmailAdapter'; +import XcPlugin from './XcPlugin'; +abstract class XcEmailPlugin extends XcPlugin { + abstract getAdapter(): IEmailAdapter; } - export default XcEmailPlugin; diff --git a/packages/nc-plugin/src/lib/XcPlugin.ts b/packages/nc-plugin/src/lib/XcPlugin.ts index b6b28e55bf..ed61550d39 100644 --- a/packages/nc-plugin/src/lib/XcPlugin.ts +++ b/packages/nc-plugin/src/lib/XcPlugin.ts @@ -1,24 +1,20 @@ -import XcPluginHooks from "./XcPluginHooks"; +import XcPluginHooks from './XcPluginHooks'; -abstract class XcPlugin extends XcPluginHooks{ +abstract class XcPlugin extends XcPluginHooks { + protected readonly app: any; + public readonly config: any; - protected readonly app:any; - public readonly config:any; - - constructor(app:any, config:any) { + constructor(app: any, config: any) { super(); this.app = app; this.config = config; } - - abstract init(config:any):Promise; - + abstract init(config: any): Promise; // public getHooks(): XcPluginHooks{ // return null; // } } - export default XcPlugin; diff --git a/packages/nc-plugin/src/lib/XcPluginConfig.ts b/packages/nc-plugin/src/lib/XcPluginConfig.ts index c9bd30348e..4b87239352 100644 --- a/packages/nc-plugin/src/lib/XcPluginConfig.ts +++ b/packages/nc-plugin/src/lib/XcPluginConfig.ts @@ -1,6 +1,7 @@ -import XcPlugin from "./XcPlugin"; -import XcPluginMigration from "./XcPluginMigration"; -import {XcForm} from "nc-common"; +import { XcForm } from 'nc-common'; + +import XcPlugin from './XcPlugin'; +import XcPluginMigration from './XcPluginMigration'; export default interface XcPluginConfig { title: string; @@ -11,7 +12,7 @@ export default interface XcPluginConfig { category?: string; permissions?: string[]; inputs?: XcForm; - price?:string; + price?: string; builder: Constructor; migrations?: XcPluginMigration[]; msgOnInstall?: string; @@ -19,5 +20,5 @@ export default interface XcPluginConfig { } type Constructor = { - new(...args: any[]): T; -} + new (...args: any[]): T; +}; diff --git a/packages/nc-plugin/src/lib/XcPluginHooks.ts b/packages/nc-plugin/src/lib/XcPluginHooks.ts index 7ce311e2d6..5dc8e8135d 100644 --- a/packages/nc-plugin/src/lib/XcPluginHooks.ts +++ b/packages/nc-plugin/src/lib/XcPluginHooks.ts @@ -1,24 +1,13 @@ /* eslint-disable @typescript-eslint/no-empty-function */ abstract class XcPluginHooks { + public async appStart(): Promise {} - public async appStart(): Promise { + public async projectStart(): Promise {} - } + public async projectStop(): Promise {} - public async projectStart(): Promise { + public async projectDelete(): Promise {} - } - - public async projectStop(): Promise { - - } - - public async projectDelete(): Promise { - - } - - public async syncMigrations(): Promise { - - } + public async syncMigrations(): Promise {} } export default XcPluginHooks; diff --git a/packages/nc-plugin/src/lib/XcPluginMigration.ts b/packages/nc-plugin/src/lib/XcPluginMigration.ts index a0650482e3..45973ec3c2 100644 --- a/packages/nc-plugin/src/lib/XcPluginMigration.ts +++ b/packages/nc-plugin/src/lib/XcPluginMigration.ts @@ -1,10 +1,7 @@ abstract class XcPluginMigration { - public abstract up(): Promise; public abstract down(): Promise; - } - -export default XcPluginMigration +export default XcPluginMigration; diff --git a/packages/nc-plugin/src/lib/XcStoragePlugin.ts b/packages/nc-plugin/src/lib/XcStoragePlugin.ts index 4ccf09480a..b633cda332 100644 --- a/packages/nc-plugin/src/lib/XcStoragePlugin.ts +++ b/packages/nc-plugin/src/lib/XcStoragePlugin.ts @@ -1,11 +1,8 @@ -import XcPlugin from "./XcPlugin"; -import IStorageAdapter from "./IStorageAdapter"; +import IStorageAdapter from './IStorageAdapter'; +import XcPlugin from './XcPlugin'; abstract class XcStoragePlugin extends XcPlugin { - - abstract getAdapter(): IStorageAdapter - + abstract getAdapter(): IStorageAdapter; } - export default XcStoragePlugin; diff --git a/packages/nc-plugin/src/lib/XcWebhookNotificationPlugin.ts b/packages/nc-plugin/src/lib/XcWebhookNotificationPlugin.ts index f7180c01d8..c858ac7eb5 100644 --- a/packages/nc-plugin/src/lib/XcWebhookNotificationPlugin.ts +++ b/packages/nc-plugin/src/lib/XcWebhookNotificationPlugin.ts @@ -1,11 +1,9 @@ -import XcPlugin from "./XcPlugin"; -import {IWebhookNotificationAdapter} from "../index"; +import { IWebhookNotificationAdapter } from '../index'; -abstract class XcStoragePlugin extends XcPlugin { - - abstract getAdapter(): IWebhookNotificationAdapter +import XcPlugin from './XcPlugin'; +abstract class XcStoragePlugin extends XcPlugin { + abstract getAdapter(): IWebhookNotificationAdapter; } - export default XcStoragePlugin;