Build your own AI office with Univer Office SDK. Bring editing, calculation, collaboration, and file processing into your product for people and AI agents. Built on an extensible open-source core.
TypeScript boardcollaborationdocdocxexceloffce365officepdfpptpptxpresentationsdksheetslidesspreadsheetuniverwordwordprocessorworkspacexlsx
refactor(cf): change plugin structure (#2614)
Wenzhao Hu07bf125e1fb5
diff --git a/packages/facade/src/apis/__tests__/create-test-bed.ts b/packages/facade/src/apis/__tests__/create-test-bed.tsindex a4a68bedf7..290e718fe9 100644--- a/packages/facade/src/apis/__tests__/create-test-bed.ts+++ b/packages/facade/src/apis/__tests__/create-test-bed.ts@@ -49,7 +49,7 @@ import { Inject, Injector } from '@wendellhu/redi';import { Engine, IRenderingEngine, IRenderManagerService, RenderManagerService } from '@univerjs/engine-render';import { ISelectionRenderService, SelectionRenderService, SheetRenderController, SheetSkeletonManagerService, SheetsRenderService } from '@univerjs/sheets-ui';import { IPlatformService, IShortcutService, PlatformService, ShortcutService } from '@univerjs/ui';-import { SheetsConditionalFormattingPlugin } from '@univerjs/sheets-conditional-formatting';+import { ConditionalFormattingFormulaService, ConditionalFormattingRuleModel, ConditionalFormattingService, ConditionalFormattingViewModel } from '@univerjs/sheets-conditional-formatting';import { FUniver } from '../facade';@@ -159,7 +159,12 @@ export function createFacadeTestBed(workbookData?: IWorkbookData, dependencies?:renderManagerService.registerRenderModule(UniverInstanceType.UNIVER_SHEET, SheetSkeletonManagerService);renderManagerService.registerRenderModule(UniverInstanceType.UNIVER_SHEET, SheetRenderController);- SheetsConditionalFormattingPlugin.dependencyList.forEach((d) => {+ ([+ [ConditionalFormattingService],+ [ConditionalFormattingFormulaService],+ [ConditionalFormattingRuleModel],+ [ConditionalFormattingViewModel],+ ] as Dependency[]).forEach((d) => {injector.add(d);});diff --git a/packages/sheets-conditional-formatting-ui/src/commands/commands/move-cf.command.ts b/packages/sheets-conditional-formatting-ui/src/commands/commands/move-cf.command.tsindex 815303f0d6..4597fa1aef 100644--- a/packages/sheets-conditional-formatting-ui/src/commands/commands/move-cf.command.ts+++ b/packages/sheets-conditional-formatting-ui/src/commands/commands/move-cf.command.ts@@ -31,7 +31,7 @@ export interface IMoveCfCommand {start: IAnchor;end: IAnchor;};-export const moveCfCommand: ICommand<IMoveCfCommand> = {+export const MoveCfCommand: ICommand<IMoveCfCommand> = {type: CommandType.COMMAND,id: 'sheet.command.move-conditional-rule',handler(accessor, params) {diff --git a/packages/sheets-conditional-formatting-ui/src/components/panel/rule-list/index.tsx b/packages/sheets-conditional-formatting-ui/src/components/panel/rule-list/index.tsxindex ff062386cf..b1687a742e 100644--- a/packages/sheets-conditional-formatting-ui/src/components/panel/rule-list/index.tsx+++ b/packages/sheets-conditional-formatting-ui/src/components/panel/rule-list/index.tsx@@ -33,7 +33,7 @@ import type { IConditionalFormattingRuleConfig, IConditionFormattingRule } fromimport type { IDeleteCfCommandParams } from '../../../commands/commands/delete-cf.command';import { DeleteCfCommand } from '../../../commands/commands/delete-cf.command';import type { IMoveCfCommand } from '../../../commands/commands/move-cf.command';-import { moveCfCommand } from '../../../commands/commands/move-cf.command';+import { MoveCfCommand } from '../../../commands/commands/move-cf.command';import 'react-grid-layout/css/styles.css';import 'react-resizable/css/styles.css';import { Preview } from '../../preview';@@ -299,7 +299,7 @@ export const RuleList = (props: IRuleListProps) => {const cfId = ruleList[getSaveIndex(from.y)].cfId;const targetCfId = ruleList[getSaveIndex(to.y)].cfId;if (cfId !== targetCfId) {- commandService.executeCommand(moveCfCommand.id, { unitId, subUnitId, start: { id: cfId, type: 'self' }, end: { id: targetCfId, type: to.y > from.y ? 'after' : 'before' } } as IMoveCfCommand);+ commandService.executeCommand(MoveCfCommand.id, { unitId, subUnitId, start: { id: cfId, type: 'self' }, end: { id: targetCfId, type: to.y > from.y ? 'after' : 'before' } } as IMoveCfCommand);}};diff --git a/packages/sheets-conditional-formatting-ui/src/controllers/cf.menu.controller.ts b/packages/sheets-conditional-formatting-ui/src/controllers/cf.menu.controller.tsindex 8d6ad40360..ba26e91fc3 100644--- a/packages/sheets-conditional-formatting-ui/src/controllers/cf.menu.controller.ts+++ b/packages/sheets-conditional-formatting-ui/src/controllers/cf.menu.controller.ts@@ -25,7 +25,6 @@ import { ConditionFormattingPanel } from '../components/panel';export interface IUniverSheetsConditionalFormattingUIConfig {menu: MenuConfig;- skipConditionalFormattingCore?: boolean;}export const DefaultSheetConditionalFormattingUiConfig = {};diff --git a/packages/sheets-conditional-formatting-ui/src/mobile-plugin.ts b/packages/sheets-conditional-formatting-ui/src/mobile-plugin.tsindex a011accf03..0c907531c4 100644--- a/packages/sheets-conditional-formatting-ui/src/mobile-plugin.ts+++ b/packages/sheets-conditional-formatting-ui/src/mobile-plugin.ts@@ -14,7 +14,7 @@* limitations under the License.*/-import { ICommandService, Plugin, Tools, UniverInstanceType } from '@univerjs/core';+import { DependentOn, ICommandService, Plugin, Tools, UniverInstanceType } from '@univerjs/core';import { Inject, Injector } from '@wendellhu/redi';import { SHEET_CONDITIONAL_FORMATTING_PLUGIN, SheetsConditionalFormattingPlugin } from '@univerjs/sheets-conditional-formatting';import { AddAverageCfCommand } from './commands/commands/add-average-cf.command';@@ -31,7 +31,7 @@ import { ClearWorksheetCfCommand } from './commands/commands/clear-worksheet-cf.import { OpenConditionalFormattingOperator } from './commands/operations/open-conditional-formatting-panel';import { DeleteCfCommand } from './commands/commands/delete-cf.command';import { SetCfCommand } from './commands/commands/set-cf.command';-import { moveCfCommand } from './commands/commands/move-cf.command';+import { MoveCfCommand } from './commands/commands/move-cf.command';import { AddCfCommand } from './commands/commands/add-cf.command';import { SheetsCfRenderController } from './controllers/cf.render.controller';@@ -41,31 +41,12 @@ import { DefaultSheetConditionalFormattingUiConfig } from './controllers/cf.menuimport { ConditionalFormattingI18nController } from './controllers/cf.i18n.controller';import { SheetsCfRefRangeController } from './controllers/cf.ref-range.controller';import { ConditionalFormattingPermissionController } from './controllers/cf.permission.controller';-import { UniverSheetsConditionalFormattingUIPlugin } from './plugin';+@DependentOn(SheetsConditionalFormattingPlugin)export class UniverSheetsConditionalFormattingMobileUIPlugin extends Plugin {static override pluginName = SHEET_CONDITIONAL_FORMATTING_PLUGIN;static override type = UniverInstanceType.UNIVER_SHEET;- static commandList = [- AddAverageCfCommand,- AddColorScaleConditionalRuleCommand,- AddDataBarConditionalRuleCommand,- AddDuplicateValuesCfCommand,- AddNumberCfCommand,- AddRankCfCommand,- AddTextCfCommand,- AddTimePeriodCfCommand,- AddUniqueValuesCfCommand,- OpenConditionalFormattingOperator,- DeleteCfCommand,- SetCfCommand,- moveCfCommand,- AddCfCommand,- ClearRangeCfCommand,- ClearWorksheetCfCommand,- ];-constructor(private readonly _config: Partial<IUniverSheetsConditionalFormattingUIConfig> = {},@Inject(Injector) override readonly _injector: Injector,@@ -75,9 +56,7 @@ export class UniverSheetsConditionalFormattingMobileUIPlugin extends Plugin {this._config = Tools.deepMerge({}, DefaultSheetConditionalFormattingUiConfig, this._config);this._initCommand();- SheetsConditionalFormattingPlugin.dependencyList.forEach((dependency) => {- this._injector.add(dependency);- });+this._injector.add([SheetsCfRenderController]);this._injector.add([SheetsCfRefRangeController]);this._injector.add([ConditionalFormattingCopyPasteController]);@@ -87,8 +66,22 @@ export class UniverSheetsConditionalFormattingMobileUIPlugin extends Plugin {private _initCommand() {[- ...SheetsConditionalFormattingPlugin.mutationList,- ...UniverSheetsConditionalFormattingUIPlugin.commandList,+ AddAverageCfCommand,+ AddColorScaleConditionalRuleCommand,+ AddDataBarConditionalRuleCommand,+ AddDuplicateValuesCfCommand,+ AddNumberCfCommand,+ AddRankCfCommand,+ AddTextCfCommand,+ AddTimePeriodCfCommand,+ AddUniqueValuesCfCommand,+ OpenConditionalFormattingOperator,+ DeleteCfCommand,+ SetCfCommand,+ MoveCfCommand,+ AddCfCommand,+ ClearRangeCfCommand,+ ClearWorksheetCfCommand,].forEach((m) => {this._commandService.registerCommand(m);});diff --git a/packages/sheets-conditional-formatting-ui/src/plugin.ts b/packages/sheets-conditional-formatting-ui/src/plugin.tsindex 765ef7707f..64472bba8b 100644--- a/packages/sheets-conditional-formatting-ui/src/plugin.ts+++ b/packages/sheets-conditional-formatting-ui/src/plugin.ts@@ -14,7 +14,7 @@* limitations under the License.*/-import { ICommandService, Plugin, Tools, UniverInstanceType } from '@univerjs/core';+import { DependentOn, ICommandService, Plugin, Tools, UniverInstanceType } from '@univerjs/core';import { Inject, Injector } from '@wendellhu/redi';import { SHEET_CONDITIONAL_FORMATTING_PLUGIN, SheetsConditionalFormattingPlugin } from '@univerjs/sheets-conditional-formatting';import { AddAverageCfCommand } from './commands/commands/add-average-cf.command';@@ -31,7 +31,7 @@ import { ClearWorksheetCfCommand } from './commands/commands/clear-worksheet-cf.import { OpenConditionalFormattingOperator } from './commands/operations/open-conditional-formatting-panel';import { DeleteCfCommand } from './commands/commands/delete-cf.command';import { SetCfCommand } from './commands/commands/set-cf.command';-import { moveCfCommand } from './commands/commands/move-cf.command';+import { MoveCfCommand } from './commands/commands/move-cf.command';import { AddCfCommand } from './commands/commands/add-cf.command';import { SheetsCfRenderController } from './controllers/cf.render.controller';@@ -45,44 +45,20 @@ import { ConditionalFormattingEditorController } from './controllers/cf.editor.cimport { ConditionalFormattingClearController } from './controllers/cf.clear.controller';import { ConditionalFormattingPermissionController } from './controllers/cf.permission.controller';+@DependentOn(SheetsConditionalFormattingPlugin)export class UniverSheetsConditionalFormattingUIPlugin extends Plugin {static override pluginName = `${SHEET_CONDITIONAL_FORMATTING_PLUGIN}_UI`;static override type = UniverInstanceType.UNIVER_SHEET;- static commandList = [- AddAverageCfCommand,- AddColorScaleConditionalRuleCommand,- AddDataBarConditionalRuleCommand,- AddDuplicateValuesCfCommand,- AddNumberCfCommand,- AddRankCfCommand,- AddTextCfCommand,- AddTimePeriodCfCommand,- AddUniqueValuesCfCommand,- OpenConditionalFormattingOperator,- DeleteCfCommand,- SetCfCommand,- moveCfCommand,- AddCfCommand,- ClearRangeCfCommand,- ClearWorksheetCfCommand,- ];-constructor(- private readonly _config: Partial<IUniverSheetsConditionalFormattingUIConfig> = {- },+ private readonly _config: Partial<IUniverSheetsConditionalFormattingUIConfig> = {},@Inject(Injector) override readonly _injector: Injector,@Inject(ICommandService) private _commandService: ICommandService) {super();this._config = Tools.deepMerge({}, DefaultSheetConditionalFormattingUiConfig, this._config);- const skipConditionalFormattingCore = this._config.skipConditionalFormattingCore ?? false;+this._initCommand();- if (!skipConditionalFormattingCore) {- SheetsConditionalFormattingPlugin.dependencyList.forEach((dependency) => {- this._injector.add(dependency);- });- }this._injector.add([SheetsCfRenderController]);this._injector.add([SheetsCfRefRangeController]);@@ -100,14 +76,25 @@ export class UniverSheetsConditionalFormattingUIPlugin extends Plugin {this._injector.add([ConditionalFormattingClearController]);}- _initCommand() {- const skipConditionalFormattingCore = this._config.skipConditionalFormattingCore ?? false;- if (!skipConditionalFormattingCore) {- SheetsConditionalFormattingPlugin.mutationList.forEach((m) => {- this._commandService.registerCommand(m);- });- }- [...UniverSheetsConditionalFormattingUIPlugin.commandList].forEach((m) => {+ private _initCommand() {+ [+ AddAverageCfCommand,+ AddColorScaleConditionalRuleCommand,+ AddDataBarConditionalRuleCommand,+ AddDuplicateValuesCfCommand,+ AddNumberCfCommand,+ AddRankCfCommand,+ AddTextCfCommand,+ AddTimePeriodCfCommand,+ AddUniqueValuesCfCommand,+ OpenConditionalFormattingOperator,+ DeleteCfCommand,+ SetCfCommand,+ MoveCfCommand,+ AddCfCommand,+ ClearRangeCfCommand,+ ClearWorksheetCfCommand,+ ].forEach((m) => {this._commandService.registerCommand(m);});}diff --git a/packages/sheets-conditional-formatting/src/plugin.ts b/packages/sheets-conditional-formatting/src/plugin.tsindex 86be7eaf94..f707ebe1c4 100644--- a/packages/sheets-conditional-formatting/src/plugin.ts+++ b/packages/sheets-conditional-formatting/src/plugin.ts@@ -33,38 +33,31 @@ export class SheetsConditionalFormattingPlugin extends Plugin {static override pluginName = SHEET_CONDITIONAL_FORMATTING_PLUGIN;static override type = UniverInstanceType.UNIVER_SHEET;- static readonly dependencyList: Dependency[] = [- [ConditionalFormattingService],- [ConditionalFormattingFormulaService],- [ConditionalFormattingRuleModel],- [ConditionalFormattingViewModel],- ];-- static readonly mutationList = [- AddConditionalRuleMutation,- DeleteConditionalRuleMutation,- SetConditionalRuleMutation,- MoveConditionalRuleMutation,- ConditionalFormattingFormulaMarkDirty,- ];-constructor(_config: unknown,@Inject(Injector) override readonly _injector: Injector,@Inject(ICommandService) private _commandService: ICommandService) {super();- this._initCommand();}override onStarting(): void {- SheetsConditionalFormattingPlugin.dependencyList.forEach((dependency) => {+ ([+ [ConditionalFormattingService],+ [ConditionalFormattingFormulaService],+ [ConditionalFormattingRuleModel],+ [ConditionalFormattingViewModel],+ ] as Dependency[]).forEach((dependency) => {this._injector.add(dependency);});- }- _initCommand() {- SheetsConditionalFormattingPlugin.mutationList.forEach((m) => {+ [+ AddConditionalRuleMutation,+ DeleteConditionalRuleMutation,+ SetConditionalRuleMutation,+ MoveConditionalRuleMutation,+ ConditionalFormattingFormulaMarkDirty,+ ].forEach((m) => {this._commandService.registerCommand(m);});}diff --git a/packages/sheets-conditional-formatting/src/services/__test__/test.util.ts b/packages/sheets-conditional-formatting/src/services/__test__/test.util.tsindex 145786b4ea..a13ef6e5bb 100644--- a/packages/sheets-conditional-formatting/src/services/__test__/test.util.ts+++ b/packages/sheets-conditional-formatting/src/services/__test__/test.util.ts@@ -25,9 +25,13 @@ import { Inject, Injector } from '@wendellhu/redi';import { IActiveDirtyManagerService } from '@univerjs/engine-formula';import { ConditionalFormattingService } from '../conditional-formatting.service';import { ConditionalFormattingFormulaService } from '../conditional-formatting-formula.service';-import { SheetsConditionalFormattingPlugin } from '../../plugin';import { ConditionalFormattingRuleModel } from '../../models/conditional-formatting-rule-model';import { ConditionalFormattingViewModel } from '../../models/conditional-formatting-view-model';+import { AddConditionalRuleMutation } from '../../commands/mutations/add-conditional-rule.mutation';+import { DeleteConditionalRuleMutation } from '../../commands/mutations/delete-conditional-rule.mutation';+import { ConditionalFormattingFormulaMarkDirty } from '../../commands/mutations/formula-mark-dirty.mutation';+import { MoveConditionalRuleMutation } from '../../commands/mutations/move-conditional-rule.mutation';+import { SetConditionalRuleMutation } from '../../commands/mutations/set-conditional-rule.mutation';const TEST_WORKBOOK_DATA_DEMO: () => IWorkbookData = () => ({id: 'test',@@ -92,7 +96,13 @@ export const createTestBed = (dependencies?: Dependency[]) => {const univerInstanceService = injector.get(IUniverInstanceService);const commandService = injector.get(ICommandService);- [...SheetsConditionalFormattingPlugin.mutationList].forEach((commandInfo) => {+ [+ AddConditionalRuleMutation,+ DeleteConditionalRuleMutation,+ SetConditionalRuleMutation,+ MoveConditionalRuleMutation,+ ConditionalFormattingFormulaMarkDirty,+ ].forEach((commandInfo) => {commandService.registerCommand(commandInfo);});const unitId = workbookJson.id;diff --git a/packages/ui/src/mobile-ui-plugin.ts b/packages/ui/src/mobile-ui-plugin.tsindex 71b0d00811..59de254207 100644--- a/packages/ui/src/mobile-ui-plugin.ts+++ b/packages/ui/src/mobile-ui-plugin.ts@@ -14,7 +14,7 @@* limitations under the License.*/-import { DependentOn, IContextService, ILocalStorageService, mergeOverrideWithDependencies, Plugin } from '@univerjs/core';+import { DependentOn, ILocalStorageService, mergeOverrideWithDependencies, Plugin } from '@univerjs/core';import type { Dependency } from '@wendellhu/redi';import { Inject, Injector } from '@wendellhu/redi';import { UniverRenderEnginePlugin } from '@univerjs/engine-render';@@ -66,7 +66,6 @@ export class UniverMobileUIPlugin extends Plugin {constructor(private _config: IUniverUIConfig,- @IContextService private readonly _contextService: IContextService,@Inject(Injector) protected readonly _injector: Injector) {super();@@ -105,7 +104,8 @@ export class UniverMobileUIPlugin extends Plugin {[IUIController, {useFactory: (injector: Injector) => injector.createInstance(MobileUIController, this._config),- deps: [Injector] },+ deps: [Injector],+ },],[SharedController,@@ -114,7 +114,7 @@ export class UniverMobileUIPlugin extends Plugin {},],[ErrorController],- ]);+ ], this._config.override);dependencies.forEach((dependency) => injector.add(dependency));}