@gravity-ui/i18n-优化-plugin
用于优化翻译文件交付的插件 。 可用于网络包装,rspack,和活地.
盖下,用 i18n-babel-plugin。 。 。 .
变换 i18n.ts 文件(其他名称可通过 filenameMatcher:
- 从信件中删除元( id, 描述等)
- 将下标记转换为 html( 当
meta.markdown === true(中文(简体) ) - 对关键内容应用打字规则
- 每个本地块创建并优化其运行时间加载
东都:
- 根据 ICU 信件格式验证语法
- 编译 ICU 信件格式到 AST
- 将原始密钥替换为散列( 允许缩短密钥长度)
使用量
安装插件 :
npm install @gravity-ui/i18n-optimize-plugin --save-dev
连接插件到构建中 。 实例,如果你在使用 app-builder 与 rspack数字 :
import {defineConfig} from '@gravity-ui/app-builder';
import applyI18nOptimizePlugin from '@gravity-ui/i18n-optimize-plugin/rspack';
export default defineConfig({
client: {
rspack: (config) => {
const plugins = config.plugins ? [...config.plugins] : [];
return applyI18nOptimizePlugin(config);
}
},
});
实例,如果你在使用 app-builder 与 webpack数字 :
import {defineConfig} from '@gravity-ui/app-builder';
import applyI18nOptimizePlugin from '@gravity-ui/i18n-optimize-plugin/webpack';
export default defineConfig({
client: {
webpack: (config) => {
const plugins = config.plugins ? [...config.plugins] : [];
return applyI18nOptimizePlugin(config);
}
},
});
设置
配置
工程配置本地端, 插件可以优化翻译 .
默认 i18n.config.ts 从当前工作目录搜索到仓库
或工作空间根。 通过此选项可以将插件明确指向配置
对象或配置文件的路径 :
import i18nConfig from './i18n.config';
applyI18nOptimizePlugin(webpackConfig, {
config: i18nConfig,
})
applyI18nOptimizePlugin(webpackConfig, {
config: require.resolve('./i18n.config.ts'),
})
通过配置作为对象也会完全跳过配置的取景.
文件名Matcher
允许使用自定义名称处理翻译文件 。 镜像
filenameMatcher 选项 i18n-babel-plugin。 。 。 .
类型 : FilenameMatcher | FilenameMatcher[]时 FilenameMatcher 为:
string—— 与文件路径的结尾相比, 所以i18n.ts匹配两者Component/i18n.ts财务报告和审定财务报表Component/component.i18n.ts· ;RegExp——按常态化路径进行考核(\→/(三);{type: 'regexp', pattern: string, flags?: string}——以可序列形式出现的同一种正则说明.
默认 : 'i18n.ts'。 。 。 .
applyI18nOptimizePlugin(webpackConfig, {
filenameMatcher: ['i18n.ts', 'keysets.ts'],
})
applyI18nOptimizePlugin(webpackConfig, {
filenameMatcher: /\.translations\.tsx?$/,
})
匹配的文件如果包含无则仍然被跳过 createMessages 或者说 declareMessages 电话.
错误
允许配置 类型规则。 。 。 .
默认使用 DEFAULT_TYPOGRAF_CONFIG 规则.
定制打字规则的例子:
applyI18nOptimizePlugin(webpackConfig, {
typograf: {
enabled: ['common/nbsp/afterNumber', 'common/nbsp/afterParagraphMark'],
disabled: ['common/symbols/cf', 'common/space/trimRight', 'common/space/trimLeft'],
}
})
无效打字的例子:
applyI18nOptimizePlugin(webpackConfig, {
typograf: false,
})
优化本地商家
在运行时优化块加载:只有当前语言的翻译才加载到客户端.
只在网络包装/软件包装的生产模式中工作。 默认禁用( 假) .
如何启动?
-
对于适当的块装入,需要定义
runtimeLanguageVariableName变量,在窗口中使用当前用户语言.例如,如果你在使用
core你可以做到这一点通过inlineScripts数字 :return res.renderLayout2({ inlineScripts: [ `window.I18N_LANG = "${userLanguage}";`, 'window.YC = window.__DATA__;' ], })
By default, `window.I18N_LANG` is used for `runtimeLanguageVariableName`.
-
根据用户语言配置动态表(仅生产).
例如,当使用时
core这可以通过中间软件实现 :import {createMiddleware, getDefaultManifestPath} from '@gravity-ui/ui-core-layout'; export const layoutMiddleware = createMiddleware(({lang}) => { let manifestName = 'assets-manifest.json'; if (process.env.NODE_ENV === 'production' && lang) { manifestName = `assets-manifest.${lang}.json`; } return getDefaultManifestPath(manifestName); }); -
启用
optimizeLocaleChunks选项. -
添加行号
.compiled-locales*改为.arcignore。 。 。 .
优化战略
这个 strategy 参数决定语言块的形成方式 :
-
by-module(默认) - 为每个创建单独的语言块i18n.ts模块。 这只允许为页面中使用的模块加载翻译. -
all-in-one- 为每种语言建立一个包含所有项目翻译的共同块。 适用于翻译量小的小项目. -
custom- 自定义策略,允许您通过getChunkName函数.
语言可变配置
这个 runtimeLanguageVariableName 参数允许指定存储当前语言的变量名称。 默认, window.I18N_LANG 已使用.
实现优化的实例:
// Default by-module strategy
applyI18nOptimizePlugin(webpackConfig, {
optimizeLocaleChunks: true,
})
// all-in-one strategy
applyI18nOptimizePlugin(webpackConfig, {
optimizeLocaleChunks: {
strategy: 'all-in-one',
},
})
// Changing runtime variable that stores user language
applyI18nOptimizePlugin(webpackConfig, {
optimizeLocaleChunks: {
strategy: 'by-module',
runtimeLanguageVariableName: 'window.USER_LANG',
},
})