3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-05-10 07:37:19 +02:00
Code Issues Projects Releases Packages Wiki Activity

feat(utils): JSDoc for all APIs (#6980)

Browse source 
* feat(utils): JSDoc for all APIs

* fix tests
This commit is contained in:
Joshua Chen 2022-03-24 21:34:31 +08:00 • committed by GitHub
parent b8d2a4e84d
commit 2eeb0e46a2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
31 changed files with 637 additions and 255 deletions
Download patch file Download diff file Expand all files Collapse all files

17
packages/docusaurus-utils/src/i18nUtils.ts
View file

@ -8,16 +8,21 @@
import path from 'path';
import _ from 'lodash';
import type {TranslationFileContent, TranslationFile} from '@docusaurus/types';
import {DEFAULT_PLUGIN_ID} from './constants';
import {DEFAULT_PLUGIN_ID, I18N_DIR_NAME} from './constants';
/**
* Takes a list of translation file contents, and shallow-merges them into one.
*/
export function mergeTranslations(
contents: TranslationFileContent[],
): TranslationFileContent {
return contents.reduce((acc, content) => ({...acc, ...content}), {});
}
// Useful to update all the messages of a translation file
// Used in tests to simulate translations
/**
* Useful to update all the messages of a translation file. Used in tests to
* simulate translations.
*/
export function updateTranslationFileMessages(
translationFile: TranslationFile,
updateMessage: (message: string) => string,
@ -31,6 +36,10 @@ export function updateTranslationFileMessages(
};
}
/**
* Takes everything needed and constructs a plugin i18n path. Plugins should
* expect everything it needs for translations to be found under this path.
*/
export function getPluginI18nPath({
siteDir,
locale,
@ -46,7 +55,7 @@ export function getPluginI18nPath({
}): string {
return path.join(
siteDir,
'i18n',
I18N_DIR_NAME,
// namespace first by locale: convenient to work in a single folder for a
// translator
locale,