feat: export aliases t and n for translate and translatePlural

README.md

@@ -21,7 +21,9 @@ You can use helpers in this package in order generate code that also works when
 In order to not break the l10n string extraction scripts, make sure to alias the imported function to match the legacy syntax:
 
 ```js
-import {translate as t, translatePlural as n} from '@nextcloud/l10n'
+import { t, n } from '@nextcloud/l10n'
+// Or
+import { translate as t, translatePlural as n } from '@nextcloud/l10n'
 
 t('myapp', 'Hello!')
 n('myapp', '%n cloud', '%n clouds', 100)

lib/translation.ts

@@ -34,7 +34,7 @@
 	text: string,
 	vars?: Record<string, string | number>,
 	number?: number,
 	options?: TranslationOptions
 ): string {
 	const defaultOptions = {
 		escape: true,
@@ -76,7 +76,7 @@
 		return optSanitize(_build(
 			translation,
 			vars,
 			number
 		))
 	} else {
 		return optSanitize(translation)
@@ -99,7 +99,7 @@
 	textPlural: string,
 	number: number,
 	vars?: Record<string, string | number>,
 	options?: TranslationOptions
 ): string {
 	const identifier = '_' + textSingular + '_::_' + textPlural + '_'
 	const bundle = getAppTranslations(app)
@@ -175,7 +175,7 @@
  * Register an app's translation bundle.
  *
  * @param {string} appName name of the app
  * @param {Object<string, string>} bundle translation bundle
  */
 export function register(appName: string, bundle: Translations) {
 	registerAppTranslations(appName, bundle, getPlural)
@@ -399,3 +399,10 @@
 		return 0
 	}
 }
+
+// Export short-hand
+
+export {
+	translate as t,
+	translatePlural as n,
+}

tests/translation.test.ts

@@ -5,6 +5,8 @@ import {
 	translate,
 	translatePlural,
 	unregister,
+	t,
+	n,
 } from '../lib/translation'
 
 declare const window: NextcloudWindowWithRegistry
@@ -139,6 +141,14 @@ describe('translate', () => {
 		expect(translatePlural('core', ...text, 1)).toBe('Lade 1 Datei von {url} herunter')
 		expect(translatePlural('core', ...text, 2)).toBe('Lade 2 Dateien von {url} herunter')
 	})
+
+	it('has "t" alias for "translate"', () => {
+		expect(t).toBe(translate)
+	})
+
+	it('has "n" alias for "translatePlural"', () => {
+		expect(n).toBe(translatePlural)
+	})
 })
 
 describe('register', () => {