Skip to content

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.

feat(core): add `mergeLocales` function to combine locale objects (#5598)

白熱9538bdf84b99
diff --git a/common/shared/package.json b/common/shared/package.json
index 96c7b482ec..f59ce09693 100644
--- a/common/shared/package.json
+++ b/common/shared/package.json
@@ -27,7 +27,7 @@
"dependencies": {
"@typescript-eslint/parser": "^8.38.0",
"@vitejs/plugin-react": "^4.7.0",
- "@vitejs/plugin-vue": "^6.0.0",
+ "@vitejs/plugin-vue": "^6.0.1",
"@vitest/coverage-istanbul": "^3.2.4",
"autoprefixer": "^10.4.21",
"eslint-plugin-better-tailwindcss": "^3.7.2",
diff --git a/mockdata/scripts/generate-locales.ts b/mockdata/scripts/generate-locales.ts
index c7b631b70e..4cb46fe4c7 100644
--- a/mockdata/scripts/generate-locales.ts
+++ b/mockdata/scripts/generate-locales.ts
@@ -62,14 +62,14 @@ async function generateLocales() {
fs.writeJsonSync(path.resolve(__dirname, '../package.json'), pkgJsonFile, { spaces: 4, EOL: '\n' });
locales.forEach((locale) => {
- let statements = '/* eslint-disable */\n' + 'import { merge } from \'@univerjs/core\';\n\n';
+ let statements = '/* eslint-disable */\n' + 'import { mergeLocales } from \'@univerjs/core\';\n\n';
packageNames.forEach((pkg) => {
const pkgName = pkg.replace(/@|univerjs|\/|-/g, '');
statements += `import ${pkgName}Locale from '${pkg}/locale/${locale}';\n`;
});
- statements += '\nexport default merge(\n {},\n';
+ statements += '\nexport default mergeLocales(\n';
packageNames.forEach((pkg) => {
const pkgName = pkg.replace(/@|univerjs|\/|-/g, '');
diff --git a/packages/core/src/common/lodash.ts b/packages/core/src/common/lodash.ts
new file mode 100644
index 0000000000..bdae96566e
--- /dev/null
+++ b/packages/core/src/common/lodash.ts
@@ -0,0 +1,17 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export { debounce, get, merge, mergeWith, set } from 'lodash-es';
diff --git a/packages/core/src/common/unit.ts b/packages/core/src/common/unit.ts
index 8e26d3f720..d68ce98a10 100644
--- a/packages/core/src/common/unit.ts
+++ b/packages/core/src/common/unit.ts
@@ -16,7 +16,7 @@
import type { UniverType } from '@univerjs/protocol';
import type { Observable } from 'rxjs';
-import { Disposable } from '../shared';
+import { Disposable } from '../shared/lifecycle';
export { UniverType as UniverInstanceType } from '@univerjs/protocol';
diff --git a/packages/core/src/docs/data-model/json-x/json-x.ts b/packages/core/src/docs/data-model/json-x/json-x.ts
index ffd5e28100..7aa8ec5810 100644
--- a/packages/core/src/docs/data-model/json-x/json-x.ts
+++ b/packages/core/src/docs/data-model/json-x/json-x.ts
@@ -15,7 +15,7 @@
*/
import type { Doc, JSONOp, Path } from 'ot-json1';
-import type { Nullable } from '../../../shared';
+import type { Nullable } from '../../../shared/types';
import type { IDocumentBody, IDocumentData } from '../../../types/interfaces';
import type { TextXAction } from '../text-x/action-types';
import type { TPriority } from '../text-x/text-x';
diff --git a/packages/core/src/docs/data-model/text-x/apply-utils/common.ts b/packages/core/src/docs/data-model/text-x/apply-utils/common.ts
index bf29a40102..dcf9d18f5e 100644
--- a/packages/core/src/docs/data-model/text-x/apply-utils/common.ts
+++ b/packages/core/src/docs/data-model/text-x/apply-utils/common.ts
@@ -14,7 +14,7 @@
* limitations under the License.
*/
-import type { Nullable } from '../../../../shared';
+import type { Nullable } from '../../../../shared/types';
import type {
ICustomBlock,
ICustomDecoration,
diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts
index c5df8ce97a..65c7af1c0f 100644
--- a/packages/core/src/index.ts
+++ b/packages/core/src/index.ts
@@ -33,6 +33,7 @@ export { invertColorByHSL } from './common/invert-color/invert-hsl';
export { invertColorByMatrix } from './common/invert-color/invert-rgb';
export type { RGBColorType } from './common/invert-color/utils';
export type { Serializable } from './common/json';
+export * from './common/lodash';
export { MemoryCursor } from './common/memory-cursor';
export { mixinClass } from './common/mixin';
export { isNumeric, isSafeNumeric, willLoseNumericPrecision } from './common/number';
@@ -190,4 +191,3 @@ export * from './types/interfaces';
export type { ICellCustomRender, ICellRenderContext } from './types/interfaces/i-cell-custom-render';
export type { IDataValidationRule, IDataValidationRuleBase, IDataValidationRuleInfo, IDataValidationRuleOptions, ISheetDataValidationRule } from './types/interfaces/i-data-validation';
export { type IUniverConfig, Univer } from './univer';
-export { debounce, get, merge, mergeWith, set } from 'lodash-es';
diff --git a/packages/core/src/services/__tests__/index.ts b/packages/core/src/services/__tests__/create-test-bed.ts
similarity index 100%
rename from packages/core/src/services/__tests__/index.ts
rename to packages/core/src/services/__tests__/create-test-bed.ts
diff --git a/packages/core/src/services/__tests__/permission.spec.ts b/packages/core/src/services/__tests__/permission.spec.ts
index b9c1e10e0e..32a0683196 100644
--- a/packages/core/src/services/__tests__/permission.spec.ts
+++ b/packages/core/src/services/__tests__/permission.spec.ts
@@ -20,7 +20,7 @@ import { UnitAction, UnitObject } from '@univerjs/protocol';
import { firstValueFrom } from 'rxjs';
import { beforeEach, describe, expect, it } from 'vitest';
import { PermissionService } from '../permission/permission.service';
-import { createTestBed } from './index';
+import { createTestBed } from './create-test-bed';
class TestPermissionPoint implements IPermissionPoint {
type: UnitObject.Workbook;
diff --git a/packages/core/src/services/__tests__/resources.spec.ts b/packages/core/src/services/__tests__/resources.spec.ts
index e91bd2610b..7b9c9ab31c 100644
--- a/packages/core/src/services/__tests__/resources.spec.ts
+++ b/packages/core/src/services/__tests__/resources.spec.ts
@@ -14,12 +14,12 @@
* limitations under the License.
*/
+import type { Univer } from '../../univer';
import { beforeEach, describe, expect, it } from 'vitest';
+import { UniverInstanceType } from '../../common/unit';
import { IResourceLoaderService } from '../resource-loader/type';
import { IResourceManagerService } from '../resource-manager/type';
-import type { Univer } from '../../univer';
-import { UniverInstanceType } from '../../common/unit';
-import { createTestBed } from './index';
+import { createTestBed } from './create-test-bed';
describe('Test resources service', () => {
let univer: Univer;
diff --git a/packages/core/src/services/__tests__/theme.spec.ts b/packages/core/src/services/__tests__/theme.spec.ts
new file mode 100644
index 0000000000..9d08af3c78
--- /dev/null
+++ b/packages/core/src/services/__tests__/theme.spec.ts
@@ -0,0 +1,101 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import type { Univer } from '../../univer';
+import { beforeEach, describe, expect, it } from 'vitest';
+import { ThemeService } from '../theme/theme.service';
+import { createTestBed } from './create-test-bed';
+
+describe('Test theme service', () => {
+ let univer: Univer;
+
+ beforeEach(() => {
+ univer?.dispose();
+ const instance = createTestBed();
+ univer = instance.univer;
+ });
+
+ beforeEach(() => {
+ univer?.dispose();
+ const instance = createTestBed();
+ univer = instance.univer;
+ });
+
+ it('should get default theme', () => {
+ const themeService = univer.__getInjector().get(ThemeService);
+ expect(themeService.getCurrentTheme()).toBeDefined();
+ });
+
+ it('should set and get theme', () => {
+ const themeService = univer.__getInjector().get(ThemeService);
+ const oldTheme = themeService.getCurrentTheme();
+ const theme = {
+ ...oldTheme,
+ primary: {
+ ...oldTheme.primary,
+ 600: '#123456',
+ },
+ };
+ themeService.setTheme(theme);
+ expect(themeService.getCurrentTheme().primary[600]).toBe('#123456');
+ });
+
+ it('should set and get dark mode', () => {
+ const themeService = univer.__getInjector().get(ThemeService);
+ themeService.setDarkMode(true);
+ expect(themeService.darkMode).toBe(true);
+ themeService.setDarkMode(false);
+ expect(themeService.darkMode).toBe(false);
+ });
+
+ it('should validate theme color', () => {
+ const themeService = univer.__getInjector().get(ThemeService);
+ expect(themeService.isValidThemeColor('primary.600')).toBe(true);
+ expect(themeService.isValidThemeColor('notexist')).toBe(false);
+ });
+
+ it('should get color from theme', () => {
+ const themeService = univer.__getInjector().get(ThemeService);
+ const oldTheme = themeService.getCurrentTheme();
+ const theme = {
+ ...oldTheme,
+ primary: {
+ ...oldTheme.primary,
+ 600: '#abcdef',
+ },
+ };
+ themeService.setTheme(theme);
+ expect(themeService.getColorFromTheme('primary.600')).toBe('#abcdef');
+ });
+
+ it('should tap cached theme color', () => {
+ const themeService = univer.__getInjector().get(ThemeService);
+ const oldTheme = themeService.getCurrentTheme();
+ const theme = {
+ ...oldTheme,
+ primary: {
+ ...oldTheme.primary,
+ 600: '#abcdef',
+ },
+ };
+ themeService.setTheme(theme);
+
+ expect(themeService.isValidThemeColor('primary.600')).toBe(true);
+ expect(themeService.isValidThemeColor('primary.600')).toBe(true); // Should hit the cache
+ expect(themeService.getColorFromTheme('primary.600')).toBe('#abcdef');
+ expect(themeService.getColorFromTheme('primary.600')).toBe('#abcdef'); // Should hit the cache
+ });
+});
diff --git a/packages/core/src/services/config/config.service.ts b/packages/core/src/services/config/config.service.ts
index 20bcfe2765..811578b649 100644
--- a/packages/core/src/services/config/config.service.ts
+++ b/packages/core/src/services/config/config.service.ts
@@ -16,9 +16,9 @@
import type { IDisposable } from '../../common/di';
import type { Nullable } from '../../shared/types';
-import { merge } from 'lodash-es';
import { filter, Observable, Subject } from 'rxjs';
import { createIdentifier } from '../../common/di';
+import { merge } from '../../common/lodash';
// WARNING!!! Do not set per unit config here! You can definitely find a better place to do that.
diff --git a/packages/core/src/services/locale/locale.service.ts b/packages/core/src/services/locale/locale.service.ts
index 0804585b3c..1e67f926b0 100644
--- a/packages/core/src/services/locale/locale.service.ts
+++ b/packages/core/src/services/locale/locale.service.ts
@@ -15,9 +15,8 @@
*/
import type { ILanguagePack, ILocales, LanguageValue } from '../../shared/locale';
-
-import { merge } from 'lodash-es';
import { BehaviorSubject, Subject } from 'rxjs';
+import { merge } from '../../common/lodash';
import { Disposable, toDisposable } from '../../shared/lifecycle';
import { LocaleType } from '../../types/enum/locale-type';
diff --git a/packages/core/src/services/theme/theme.service.ts b/packages/core/src/services/theme/theme.service.ts
index 565439f8df..0cf3c57bf3 100644
--- a/packages/core/src/services/theme/theme.service.ts
+++ b/packages/core/src/services/theme/theme.service.ts
@@ -16,8 +16,8 @@
import type { Observable } from 'rxjs';
import { defaultTheme } from '@univerjs/themes';
-import { get } from 'lodash-es';
import { BehaviorSubject } from 'rxjs';
+import { get } from '../../common/lodash';
import { Disposable, toDisposable } from '../../shared/lifecycle';
export type Theme = typeof defaultTheme;
diff --git a/packages/core/src/shared/__tests__/locale.spec.ts b/packages/core/src/shared/__tests__/locale.spec.ts
new file mode 100644
index 0000000000..e7d18b9d0e
--- /dev/null
+++ b/packages/core/src/shared/__tests__/locale.spec.ts
@@ -0,0 +1,55 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { describe, expect, it } from 'vitest';
+import { mergeLocales } from '../locale';
+
+describe('mergeLocales function', () => {
+ it('should merge multiple locale objects correctly', () => {
+ const locale1 = { greeting: 'Hello' };
+ const locale2 = { farewell: 'Goodbye' };
+ const locale3 = { greeting: 'Hola' };
+
+ const merged1 = mergeLocales(locale1, locale2, locale3);
+
+ expect(merged1).toEqual({
+ greeting: 'Hola',
+ farewell: 'Goodbye',
+ });
+ });
+
+ it('should merge an array of locale objects', () => {
+ const localesArray = [
+ { greeting: 'Hello' },
+ { farewell: 'Goodbye' },
+ { greeting: 'Hola' },
+ ];
+
+ const merged1 = mergeLocales(...localesArray);
+ const merged2 = mergeLocales(localesArray);
+
+ expect(merged1).toEqual(merged2);
+ });
+
+ it('should handle empty objects', () => {
+ const locale1 = {};
+ const locale2 = { key: 'value' };
+
+ const merged1 = mergeLocales(locale1, locale2);
+
+ expect(merged1).toEqual({ key: 'value' });
+ });
+});
diff --git a/packages/core/src/shared/locale.ts b/packages/core/src/shared/locale.ts
index 6ef32fc46c..cff4814297 100644
--- a/packages/core/src/shared/locale.ts
+++ b/packages/core/src/shared/locale.ts
@@ -14,6 +14,8 @@
* limitations under the License.
*/
+import { merge } from '../common/lodash';
+
export type LanguageValue = string | string[] | ILanguagePack | ILanguagePack[] | boolean;
export interface ILanguagePack {
@@ -23,3 +25,21 @@ export interface ILanguagePack {
export interface ILocales {
[key: string]: ILanguagePack;
}
+
+// eslint-disable-next-line ts/no-explicit-any
+type MergeLocalesInput = Record<string, any>;
+/**
+ * Merges multiple locale objects into a single locale object.
+ * It can accept either multiple locale objects as arguments or a single array of locale objects.
+ * @param locales - An array of locale objects or multiple locale objects.
+ * @returns A merged locale object containing all key-value pairs from the input locales.
+ */
+export function mergeLocales(...locales: (MergeLocalesInput | MergeLocalesInput[])[]): MergeLocalesInput {
+ let mergedLocales: MergeLocalesInput[];
+ if (locales.length === 1 && Array.isArray(locales[0])) {
+ mergedLocales = locales[0] as MergeLocalesInput[];
+ } else {
+ mergedLocales = locales as MergeLocalesInput[];
+ }
+ return merge({}, ...mergedLocales);
+}
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index 2b60653c97..eb4ff50f54 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -132,8 +132,8 @@ importers:
specifier: ^4.7.0
'@vitejs/plugin-vue':
- specifier: ^6.0.0
+ specifier: ^6.0.1
'@vitest/coverage-istanbul':
specifier: ^3.2.4
@@ -5316,12 +5316,12 @@ packages:
peerDependencies:
release-it: ^18.0.0 || ^19.0.0
- '@rolldown/[email protected]':
- resolution: {integrity: sha512-3FL3mnMbPu0muGOCaKAhhFEYmqv9eTfPSJRJmANrCwtgK8VuxpsZDGK+m0LYAGoyO8+0j5uRe4PeyPDK1yA/hA==}
-
'@rolldown/[email protected]':
resolution: {integrity: sha512-+d0F4MKMCbeVUJwG96uQ4SgAznZNSq93I3V+9NHA4OpvqG8mRCpGdKmK8l/dl02h2CCDHwW2FqilnTyDcAnqjA==}
+ '@rolldown/[email protected]':
+ resolution: {integrity: sha512-NIJgOsMjbxAXvoGq/X0gD7VPMQ8j9g0BiDaNjVNVjvl+iKXxL3Jre0v31RmBYeLEmkbj2s02v8vFTbUXi5XS2Q==}
+
'@rollup/[email protected]':
resolution: {integrity: sha512-USm05zrsFxYLPdWWq+K3STlWiT/3ELn3RcV5hJMghpeAIhxfsUIg6mt12CBJBInWMV4VneoV7SfGv8xIwo2qNQ==}
engines: {node: '>=14.0.0'}
@@ -5965,8 +5965,8 @@ packages:
peerDependencies:
vite: ^4.2.0 || ^5.0.0 || ^6.0.0 || ^7.0.0
- '@vitejs/[email protected]':
- resolution: {integrity: sha512-iAliE72WsdhjzTOp2DtvKThq1VBC4REhwRcaA+zPAAph6I+OQhUXv+Xu2KS7ElxYtb7Zc/3R30Hwv1DxEo7NXQ==}
+ '@vitejs/[email protected]':
+ resolution: {integrity: sha512-+MaE752hU0wfPFJEUAIxqw18+20euHHdxVtMvbFcOEpjEyfqXH/5DCoTHiVJ0J29EhTJdoTkjEv5YBKU9dnoTw==}
engines: {node: ^20.19.0 || >=22.12.0}
peerDependencies:
vite: ^5.0.0 || ^6.0.0 || ^7.0.0
@@ -13141,10 +13141,10 @@ snapshots:
- conventional-commits-filter
- conventional-commits-parser
- '@rolldown/[email protected]': {}
-
'@rolldown/[email protected]': {}
+ '@rolldown/[email protected]': {}
+
dependencies:
'@types/estree': 1.0.7
@@ -13848,9 +13848,9 @@ snapshots:
transitivePeerDependencies:
- supports-color
dependencies:
- '@rolldown/pluginutils': 1.0.0-beta.19
+ '@rolldown/pluginutils': 1.0.0-beta.29
vue: 3.5.18([email protected])