[stable32] test: l10n mock standardization

src/tests/App.spec.ts

@@ -4,6 +4,7 @@
  */
 
 import { beforeEach, describe, expect, it, vi } from 'vitest'
+import { createL10nMock } from './testHelpers/l10n.js'
 import { mount } from '@vue/test-utils'
 
 import { initialActionCode, ACTION_CODES } from '../helpers/ActionMapping'
@@ -30,15 +31,7 @@ vi.mock('vue-router', async () => {
 	}
 })
 
-vi.mock('@nextcloud/l10n', () => ({
-	t: vi.fn((_app: string, text: string) => text),
-	translate: vi.fn((_app: string, text: string) => text),
-	translatePlural: vi.fn((_app: string, singular: string, plural: string, count: number) => (count === 1 ? singular : plural)),
-	n: vi.fn((_app: string, singular: string, plural: string, count: number) => (count === 1 ? singular : plural)),
-	isRTL: vi.fn(() => false),
-	getLanguage: vi.fn(() => 'en'),
-	getLocale: vi.fn(() => 'en'),
-}))
+vi.mock('@nextcloud/l10n', () => createL10nMock())
 
 vi.mock('@nextcloud/vue/components/NcContent', () => ({
 	default: { name: 'NcContent', template: '<div class="nc-content"><slot /></div>', props: ['appName'] },

src/tests/ExternalApp.spec.ts

@@ -4,6 +4,7 @@
  */
 
 import { beforeEach, describe, expect, it, vi } from 'vitest'
+import { createL10nMock } from './testHelpers/l10n.js'
 import { mount } from '@vue/test-utils'
 
 import { initialActionCode, ACTION_CODES } from '../helpers/ActionMapping'
@@ -12,15 +13,7 @@ vi.mock('@nextcloud/initial-state', () => ({
 	loadState: vi.fn((app, key, defaultValue) => defaultValue),
 }))
 
-vi.mock('@nextcloud/l10n', () => ({
-	t: vi.fn((_app: string, text: string) => text),
-	translate: vi.fn((_app: string, text: string) => text),
-	translatePlural: vi.fn((_app: string, singular: string, plural: string, count: number) => (count === 1 ? singular : plural)),
-	n: vi.fn((_app: string, singular: string, plural: string, count: number) => (count === 1 ? singular : plural)),
-	isRTL: vi.fn(() => false),
-	getLanguage: vi.fn(() => 'en'),
-	getLocale: vi.fn(() => 'en'),
-}))
+vi.mock('@nextcloud/l10n', () => createL10nMock())
 
 import ExternalApp from '../ExternalApp.vue'
 

src/tests/actions/openInLibreSignAction.spec.ts

@@ -4,6 +4,7 @@
  */
 
 import { describe, expect, it, beforeEach, vi, afterEach } from 'vitest'
+import { createL10nMock } from '../testHelpers/l10n.js'
 
 // Mock @nextcloud/logger to avoid import-time errors with @nextcloud/vue
 vi.mock('@nextcloud/logger', () => ({
@@ -82,15 +83,7 @@ vi.mock('@nextcloud/initial-state', () => ({
 	}),
 }))
 
-vi.mock('@nextcloud/l10n', () => ({
-	translate: vi.fn((_app: string, text: string) => text),
-	translatePlural: vi.fn((_app: string, singular: string, plural: string, count: number) => (count === 1 ? singular : plural)),
-	t: vi.fn((_app: string, text: string) => text),
-	n: vi.fn((_app: string, singular: string, plural: string, count: number) => (count === 1 ? singular : plural)),
-	getLanguage: vi.fn(() => 'en'),
-	getLocale: vi.fn(() => 'en'),
-	isRTL: vi.fn(() => false),
-}))
+vi.mock('@nextcloud/l10n', () => createL10nMock())
 
 vi.mock('@nextcloud/vue/functions/dialog', () => ({
 	spawnDialog: vi.fn(() => Promise.resolve('Test Envelope')),

src/tests/components/CodeEditor.spec.ts

@@ -4,19 +4,12 @@
  */
 
 import { beforeEach, describe, expect, it, vi } from 'vitest'
+import { createL10nMock } from '../testHelpers/l10n.js'
 import { mount } from '@vue/test-utils'
 
 import CodeEditor from '../../components/CodeEditor.vue'
 
-vi.mock('@nextcloud/l10n', () => ({
-	translate: vi.fn((_app: string, text: string) => text),
-	translatePlural: vi.fn((_app: string, singular: string, plural: string, count: number) => (count === 1 ? singular : plural)),
-	t: vi.fn((_app: string, text: string) => text),
-	n: vi.fn((_app: string, singular: string, plural: string, count: number) => (count === 1 ? singular : plural)),
-	getLanguage: vi.fn(() => 'en'),
-	getLocale: vi.fn(() => 'en'),
-	isRTL: vi.fn(() => false),
-}))
+vi.mock('@nextcloud/l10n', () => createL10nMock())
 
 vi.mock('@ssddanbrown/codemirror-lang-twig', () => ({
 	twig: vi.fn(() => ({ name: 'twig-extension' })),

src/tests/components/Draw/FileUpload.spec.ts

@@ -7,10 +7,6 @@ import { beforeEach, describe, expect, it, vi } from 'vitest'
 import { mount } from '@vue/test-utils'
 import FileUpload from '../../../components/Draw/FileUpload.vue'
 
-vi.mock('@nextcloud/l10n', () => ({
-	t: vi.fn((_app: string, text: string) => text),
-}))
-
 vi.mock('@nextcloud/capabilities', () => ({
 	getCapabilities: vi.fn(() => ({
 		libresign: {

src/tests/components/File/File.spec.ts

@@ -4,6 +4,7 @@
  */
 
 import { beforeEach, describe, expect, it, vi } from 'vitest'
+import { createL10nMock } from '../../testHelpers/l10n.js'
 import { mount } from '@vue/test-utils'
 
 import File from '../../../components/File/File.vue'
@@ -36,12 +37,7 @@ const sidebarStoreMock = {
 	activeRequestSignatureTab: vi.fn(),
 }
 
-vi.mock('@nextcloud/l10n', () => ({
-	t: vi.fn((_app: string, text: string) => text),
-	getLanguage: vi.fn(() => 'en'),
-	getLocale: vi.fn(() => 'en'),
-	isRTL: vi.fn(() => false),
-}))
+vi.mock('@nextcloud/l10n', () => createL10nMock())
 
 vi.mock('@nextcloud/router', () => ({
 	generateOcsUrl: vi.fn((path: string, params?: Record<string, string | number>) => {

src/tests/components/FileEntry/FileEntrySigners.spec.ts

@@ -27,11 +27,6 @@ type FileEntrySignersWrapper = VueWrapper<any> & {
 
 let FileEntrySigners: any
 
-vi.mock('@nextcloud/l10n', () => ({
-	translate: vi.fn((_app: string, text: string) => text),
-	isRTL: vi.fn(() => false),
-}))
-
 beforeAll(async () => {
 	;({ default: FileEntrySigners } = await import('../../../views/FilesList/FileEntry/FileEntrySigners.vue'))
 })

src/tests/components/FileEntry/FileEntryStatus.spec.ts

@@ -31,11 +31,6 @@ type FileEntryStatusWrapper = VueWrapper<any> & {
 
 let FileEntryStatus: any
 
-vi.mock('@nextcloud/l10n', () => ({
-	translate: vi.fn((_app: string, text: string) => text),
-	isRTL: vi.fn(() => false),
-}))
-
 vi.mock('vue-select', () => ({
 	default: {
 		name: 'VSelect',

src/tests/components/FileStatusList.spec.ts

@@ -4,16 +4,14 @@
  */
 
 import { beforeEach, describe, expect, it, vi } from 'vitest'
+import { createL10nMock } from '../testHelpers/l10n.js'
 import { mount } from '@vue/test-utils'
 
 import FileStatusList from '../../components/FileStatusList.vue'
 
 const axiosGetMock = vi.fn()
 
-vi.mock('@nextcloud/l10n', () => ({
-	t: vi.fn((_app: string, text: string) => text),
-	n: vi.fn((_app: string, singular: string, plural: string, count: number) => (count === 1 ? singular : plural)),
-}))
+vi.mock('@nextcloud/l10n', () => createL10nMock())
 
 vi.mock('@nextcloud/files', () => ({
 	formatFileSize: vi.fn((size: number) => `${size}B`),

src/tests/components/FooterTemplateEditor.spec.ts

@@ -23,10 +23,6 @@ vi.mock('debounce', () => ({
 	default: vi.fn((fn: (...args: unknown[]) => unknown) => fn),
 }))
 
-vi.mock('@nextcloud/l10n', () => ({
-	t: vi.fn((_app: string, text: string) => text),
-}))
-
 vi.mock('@nextcloud/axios', () => ({
 	default: {
 		get: vi.fn((...args: unknown[]) => axiosGetMock(...args)),

src/tests/components/LeftSidebar/LeftSidebar.spec.ts

@@ -4,6 +4,7 @@
  */
 
 import { beforeAll, beforeEach, describe, expect, it, vi } from 'vitest'
+import { createL10nMock } from '../../testHelpers/l10n.js'
 import { mount } from '@vue/test-utils'
 
 const loadStateMock = vi.fn()
@@ -18,15 +19,7 @@ vi.mock('@nextcloud/auth', () => ({
 	getCurrentUser: () => getCurrentUserMock(),
 }))
 
-vi.mock('@nextcloud/l10n', () => ({
-	t: vi.fn((_app: string, text: string) => text),
-	translate: vi.fn((_app: string, text: string) => text),
-	translatePlural: vi.fn((_app: string, singular: string, plural: string, count: number) => (count === 1 ? singular : plural)),
-	n: vi.fn((_app: string, singular: string, plural: string, count: number) => (count === 1 ? singular : plural)),
-	isRTL: vi.fn(() => false),
-	getLanguage: vi.fn(() => 'en'),
-	getLocale: vi.fn(() => 'en'),
-}))
+vi.mock('@nextcloud/l10n', () => createL10nMock())
 
 vi.mock('../../../store/files.js', () => ({
 	useFilesStore: () => ({

src/tests/components/MarkdownEditor.spec.ts

@@ -4,6 +4,7 @@
  */
 
 import { beforeAll, beforeEach, describe, expect, it, vi } from 'vitest'
+import { createL10nMock } from '../testHelpers/l10n.js'
 import { mount, flushPromises } from '@vue/test-utils'
 import type { VueWrapper } from '@vue/test-utils'
 
@@ -29,15 +30,7 @@ type MarkdownEditorWrapper = VueWrapper<any> & {
 
 let MarkdownEditor: any
 
-vi.mock('@nextcloud/l10n', () => ({
-	translate: vi.fn((_app: string, text: string) => text),
-	translatePlural: vi.fn((_app: string, singular: string, plural: string, count: number) => (count === 1 ? singular : plural)),
-	t: vi.fn((_app: string, text: string) => text),
-	n: vi.fn((_app: string, singular: string, plural: string, count: number) => (count === 1 ? singular : plural)),
-	getLanguage: vi.fn(() => 'en'),
-	getLocale: vi.fn(() => 'en'),
-	isRTL: vi.fn(() => false),
-}))
+vi.mock('@nextcloud/l10n', () => createL10nMock())
 
 beforeAll(async () => {
 	;({ default: MarkdownEditor } = await import('../../components/MarkdownEditor.vue'))

src/tests/components/PdfEditor/SignatureBox.spec.ts

@@ -4,6 +4,7 @@
  */
 
 import { describe, expect, it, vi } from 'vitest'
+import { createL10nMock, interpolateL10n } from '../../testHelpers/l10n.js'
 import { mount } from '@vue/test-utils'
 import type { SignerSummaryRecord } from '../../../types/index'
 
@@ -21,22 +22,17 @@ const createSigner = (overrides: Partial<SignerSummaryRecord> = {}): SignerSumma
 
 const usernameToColorMock = vi.fn((_seed: string) => ({ r: 10, g: 20, b: 30 }))
 
-vi.mock('@nextcloud/l10n', () => ({
-	t: vi.fn((_app: string, text: string, params?: Record<string, string>) => {
-		if (!params) {
-			return text
-		}
-
-		return Object.entries(params).reduce((message, [key, value]) => {
-			return message.replace(`{${key}}`, value)
-		}, text)
-	}),
-	translate: vi.fn((_app: string, text: string) => text),
-	translatePlural: vi.fn((_app: string, singular: string, plural: string, count: number) => (count === 1 ? singular : plural)),
-	n: vi.fn((_app: string, singular: string, plural: string, count: number) => (count === 1 ? singular : plural)),
-	getLanguage: vi.fn(() => 'en'),
-	getLocale: vi.fn(() => 'en'),
-	isRTL: vi.fn(() => false),
+vi.mock('@nextcloud/l10n', () => createL10nMock({
+	t: (_app: string, text: string, vars?: Record<string, string | number>) => interpolateL10n(text, vars),
+	n: (_app: string, singular: string, plural: string, count: number, vars?: Record<string, string | number>) => {
+		const template = count === 1 ? singular : plural
+		return interpolateL10n(template, { count, ...(vars ?? {}) })
+	},
+	translate: (_app: string, text: string, vars?: Record<string, string | number>) => interpolateL10n(text, vars),
+	translatePlural: (_app: string, singular: string, plural: string, count: number, vars?: Record<string, string | number>) => {
+		const template = count === 1 ? singular : plural
+		return interpolateL10n(template, { count, ...(vars ?? {}) })
+	},
 }))
 
 vi.mock('@nextcloud/vue/functions/usernameToColor', () => ({

src/tests/components/PreviewSignature/PreviewSignature.spec.ts

@@ -4,6 +4,7 @@
  */
 
 import { beforeEach, describe, expect, it, vi } from 'vitest'
+import { createL10nMock } from '../../testHelpers/l10n.js'
 import { mount } from '@vue/test-utils'
 
 import PreviewSignature from '../../../components/PreviewSignature/PreviewSignature.vue'
@@ -27,15 +28,7 @@ vi.mock('@nextcloud/capabilities', () => ({
 	})),
 }))
 
-vi.mock('@nextcloud/l10n', () => ({
-	t: vi.fn((_app: string, text: string) => text),
-	translate: vi.fn((_app: string, text: string) => text),
-	translatePlural: vi.fn((_app: string, singular: string, plural: string, count: number) => (count === 1 ? singular : plural)),
-	n: vi.fn((_app: string, singular: string, plural: string, count: number) => (count === 1 ? singular : plural)),
-	getLanguage: vi.fn(() => 'en'),
-	getLocale: vi.fn(() => 'en'),
-	isRTL: vi.fn(() => false),
-}))
+vi.mock('@nextcloud/l10n', () => createL10nMock())
 
 describe('PreviewSignature.vue', () => {
 	beforeEach(() => {

src/tests/components/Request/IdentifySigner.spec.ts

@@ -4,6 +4,7 @@
  */
 
 import { describe, expect, it, beforeEach, vi } from 'vitest'
+import { createL10nMock } from '../../testHelpers/l10n.js'
 import { mount } from '@vue/test-utils'
 import type { VueWrapper } from '@vue/test-utils'
 import { createPinia, setActivePinia } from 'pinia'
@@ -82,15 +83,7 @@ vi.mock('../../../store/files.js', () => ({
 	useFilesStore: vi.fn(() => filesStore),
 }))
 
-vi.mock('@nextcloud/l10n', () => ({
-	translate: vi.fn((_app: string, text: string) => text),
-	translatePlural: vi.fn((_app: string, singular: string, plural: string, count: number) => (count === 1 ? singular : plural)),
-	t: vi.fn((_app: string, text: string) => text),
-	n: vi.fn((_app: string, singular: string, plural: string, count: number) => (count === 1 ? singular : plural)),
-	getLanguage: vi.fn(() => 'en'),
-	getLocale: vi.fn(() => 'en'),
-	isRTL: vi.fn(() => false),
-}))
+vi.mock('@nextcloud/l10n', () => createL10nMock())
 
 vi.mock('@mdi/svg/svg/account.svg?raw', () => ({ default: '<svg></svg>' }))
 vi.mock('@mdi/svg/svg/email.svg?raw', () => ({ default: '<svg></svg>' }))

src/tests/components/Request/SignDetail/partials/PageNavigation.spec.ts

@@ -4,19 +4,12 @@
  */
 
 import { describe, expect, it, vi } from 'vitest'
+import { createL10nMock } from '../../../../testHelpers/l10n.js'
 import { mount } from '@vue/test-utils'
 
 import PageNavigation from '../../../../../components/Request/SignDetail/partials/PageNavigation.vue'
 
-vi.mock('@nextcloud/l10n', () => ({
-	t: vi.fn((_app: string, text: string) => text),
-	translate: vi.fn((_app: string, text: string) => text),
-	translatePlural: vi.fn((_app: string, singular: string, plural: string, count: number) => (count === 1 ? singular : plural)),
-	n: vi.fn((_app: string, singular: string, plural: string, count: number) => (count === 1 ? singular : plural)),
-	getLanguage: vi.fn(() => 'en'),
-	getLocale: vi.fn(() => 'en'),
-	isRTL: vi.fn(() => false),
-}))
+vi.mock('@nextcloud/l10n', () => createL10nMock())
 
 describe('PageNavigation.vue', () => {
 	function createWrapper(modelValue = 2) {

src/tests/components/Request/SignDetail/partials/SignerRow.spec.ts

@@ -4,19 +4,12 @@
  */
 
 import { describe, expect, it, vi } from 'vitest'
+import { createL10nMock } from '../../../../testHelpers/l10n.js'
 import { mount } from '@vue/test-utils'
 
 import SignerRow from '../../../../../components/Request/SignDetail/partials/SignerRow.vue'
 
-vi.mock('@nextcloud/l10n', () => ({
-	t: vi.fn((_app: string, text: string) => text),
-	translate: vi.fn((_app: string, text: string) => text),
-	translatePlural: vi.fn((_app: string, singular: string, plural: string, count: number) => (count === 1 ? singular : plural)),
-	n: vi.fn((_app: string, singular: string, plural: string, count: number) => (count === 1 ? singular : plural)),
-	isRTL: vi.fn(() => false),
-	getLanguage: vi.fn(() => 'en'),
-	getLocale: vi.fn(() => 'en'),
-}))
+vi.mock('@nextcloud/l10n', () => createL10nMock())
 
 vi.mock('@nextcloud/event-bus', () => ({
 	emit: vi.fn(),

src/tests/components/Request/SignerSelect.spec.ts

@@ -4,6 +4,7 @@
  */
 
 import { describe, expect, it, vi, beforeEach } from 'vitest'
+import { createL10nMock } from '../../testHelpers/l10n.js'
 import { mount } from '@vue/test-utils'
 import SignerSelect from '../../../components/Request/SignerSelect.vue'
 
@@ -31,15 +32,7 @@ vi.mock('@nextcloud/router', () => ({
 	generateOcsUrl: vi.fn((path: string) => path),
 }))
 
-vi.mock('@nextcloud/l10n', () => ({
-	t: vi.fn((_app: string, text: string) => text),
-	translate: vi.fn((_app: string, text: string) => text),
-	translatePlural: vi.fn((_app: string, singular: string, plural: string, count: number) => (count === 1 ? singular : plural)),
-	n: vi.fn((_app: string, singular: string, plural: string, count: number) => (count === 1 ? singular : plural)),
-	isRTL: vi.fn(() => false),
-	getLanguage: vi.fn(() => 'en'),
-	getLocale: vi.fn(() => 'en'),
-}))
+vi.mock('@nextcloud/l10n', () => createL10nMock())
 
 describe('SignerSelect.vue', () => {
 	beforeEach(() => {