@eggjs/i18n 3.0.1 → 4.0.0-beta.17

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (60) hide show
  1. package/README.md +10 -18
  2. package/dist/app/extend/application.d.ts +12 -0
  3. package/dist/app/extend/application.js +48 -0
  4. package/dist/app/extend/context.d.ts +76 -0
  5. package/dist/app/extend/context.js +152 -0
  6. package/dist/{commonjs/app.d.ts → app.d.ts} +10 -8
  7. package/dist/app.js +96 -0
  8. package/{src/types.ts → dist/config/config.default.d.ts} +7 -33
  9. package/dist/config/config.default.js +15 -0
  10. package/dist/index.d.ts +1 -0
  11. package/dist/index.js +4 -0
  12. package/dist/locales.d.ts +7 -0
  13. package/dist/locales.js +53 -0
  14. package/dist/types.d.ts +29 -0
  15. package/dist/types.js +1 -0
  16. package/dist/utils.d.ts +5 -0
  17. package/dist/utils.js +10 -0
  18. package/package.json +54 -73
  19. package/dist/commonjs/app/extend/application.d.ts +0 -8
  20. package/dist/commonjs/app/extend/application.js +0 -80
  21. package/dist/commonjs/app/extend/context.d.ts +0 -72
  22. package/dist/commonjs/app/extend/context.js +0 -177
  23. package/dist/commonjs/app.js +0 -103
  24. package/dist/commonjs/config/config.default.d.ts +0 -5
  25. package/dist/commonjs/config/config.default.js +0 -16
  26. package/dist/commonjs/index.d.ts +0 -1
  27. package/dist/commonjs/index.js +0 -4
  28. package/dist/commonjs/locales.d.ts +0 -3
  29. package/dist/commonjs/locales.js +0 -71
  30. package/dist/commonjs/package.json +0 -3
  31. package/dist/commonjs/types.d.ts +0 -74
  32. package/dist/commonjs/types.js +0 -3
  33. package/dist/commonjs/utils.d.ts +0 -2
  34. package/dist/commonjs/utils.js +0 -12
  35. package/dist/esm/app/extend/application.d.ts +0 -8
  36. package/dist/esm/app/extend/application.js +0 -76
  37. package/dist/esm/app/extend/context.d.ts +0 -72
  38. package/dist/esm/app/extend/context.js +0 -174
  39. package/dist/esm/app.d.ts +0 -56
  40. package/dist/esm/app.js +0 -97
  41. package/dist/esm/config/config.default.d.ts +0 -5
  42. package/dist/esm/config/config.default.js +0 -14
  43. package/dist/esm/index.d.ts +0 -1
  44. package/dist/esm/index.js +0 -2
  45. package/dist/esm/locales.d.ts +0 -3
  46. package/dist/esm/locales.js +0 -65
  47. package/dist/esm/package.json +0 -3
  48. package/dist/esm/types.d.ts +0 -74
  49. package/dist/esm/types.js +0 -2
  50. package/dist/esm/utils.d.ts +0 -2
  51. package/dist/esm/utils.js +0 -8
  52. package/dist/package.json +0 -4
  53. package/src/app/extend/application.ts +0 -91
  54. package/src/app/extend/context.ts +0 -192
  55. package/src/app.ts +0 -107
  56. package/src/config/config.default.ts +0 -15
  57. package/src/index.ts +0 -1
  58. package/src/locales.ts +0 -73
  59. package/src/typings/index.d.ts +0 -4
  60. package/src/utils.ts +0 -8
package/dist/esm/app.js DELETED
@@ -1,97 +0,0 @@
1
- import path from 'node:path';
2
- import { debuglog } from 'node:util';
3
- import { loadLocaleResources } from './locales.js';
4
- import { exists } from 'utility';
5
- import { ms } from 'humanize-ms';
6
- import { formatLocale } from './utils.js';
7
- const debug = debuglog('@eggjs/i18n/app');
8
- /**
9
- * I18n 国际化
10
- *
11
- * 通过设置 Plugin 配置 `i18n: true`,开启多语言支持。
12
- *
13
- * #### 语言文件存储路径
14
- *
15
- * 统一存放在 `config/locale/*.js` 下( 兼容`config/locales/*.js` ),如包含英文,简体中文,繁体中文的语言文件:
16
- *
17
- * ```
18
- * - config/locale/
19
- * - en-US.js
20
- * - zh-CN.js
21
- * - zh-TW.js
22
- * ```
23
- * @class I18n
24
- * @param {App} app Application object.
25
- * @example
26
- *
27
- * #### I18n 文件内容
28
- *
29
- * ```js
30
- * // config/locale/zh-CN.js
31
- * module.exports = {
32
- * "Email": "邮箱",
33
- * "Welcome back, %s!": "欢迎回来, %s!",
34
- * "Hello %s, how are you today?": "你好 %s, 今天过得咋样?",
35
- * };
36
- * ```
37
- *
38
- * ```js
39
- * // config/locale/en-US.js
40
- * module.exports = {
41
- * "Email": "Email",
42
- * };
43
- * ```
44
- * 或者也可以用 JSON 格式的文件:
45
- *
46
- * ```js
47
- * // config/locale/zh-CN.json
48
- * {
49
- * "email": "邮箱",
50
- * "login": "帐号",
51
- * "createdAt": "注册时间"
52
- * }
53
- * ```
54
- */
55
- export default class I18n {
56
- app;
57
- constructor(app) {
58
- this.app = app;
59
- }
60
- async didLoad() {
61
- const i18nConfig = this.app.config.i18n;
62
- i18nConfig.defaultLocale = formatLocale(i18nConfig.defaultLocale);
63
- i18nConfig.cookieMaxAge = ms(i18nConfig.cookieMaxAge);
64
- i18nConfig.dirs = Array.isArray(i18nConfig.dirs) ? i18nConfig.dirs : [];
65
- // 按 egg > 插件 > 框架 > 应用的顺序遍历 config/locale(config/locales) 目录,加载所有配置文件
66
- for (const unit of this.app.loader.getLoadUnits()) {
67
- let localePath = path.join(unit.path, 'config/locale');
68
- /**
69
- * 优先选择 `config/locale` 目录下的多语言文件,不存在时再选择 `config/locales` 目录
70
- * 避免 2 个目录同时存在时可能导致的冲突
71
- */
72
- if (!(await exists(localePath))) {
73
- localePath = path.join(unit.path, 'config/locales');
74
- }
75
- i18nConfig.dirs.push(localePath);
76
- }
77
- debug('app.config.i18n.dirs:', i18nConfig.dirs);
78
- await loadLocaleResources(this.app, i18nConfig);
79
- const app = this.app;
80
- function gettextInContext(key, ...args) {
81
- const ctx = app.ctxStorage.getStore();
82
- return ctx.gettext(key, ...args);
83
- }
84
- // 在 view 中使用 `__(key, value, ...args)`
85
- Object.defineProperties(app.locals, {
86
- __: {
87
- value: gettextInContext,
88
- enumerable: true,
89
- },
90
- gettext: {
91
- value: gettextInContext,
92
- enumerable: true,
93
- },
94
- });
95
- }
96
- }
97
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXBwLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2FwcC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLElBQUksTUFBTSxXQUFXLENBQUM7QUFDN0IsT0FBTyxFQUFFLFFBQVEsRUFBRSxNQUFNLFdBQVcsQ0FBQztBQUNyQyxPQUFPLEVBQUUsbUJBQW1CLEVBQUUsTUFBTSxjQUFjLENBQUM7QUFDbkQsT0FBTyxFQUFFLE1BQU0sRUFBRSxNQUFNLFNBQVMsQ0FBQztBQUNqQyxPQUFPLEVBQUUsRUFBRSxFQUFFLE1BQU0sYUFBYSxDQUFDO0FBR2pDLE9BQU8sRUFBRSxZQUFZLEVBQUUsTUFBTSxZQUFZLENBQUM7QUFFMUMsTUFBTSxLQUFLLEdBQUcsUUFBUSxDQUFDLGlCQUFpQixDQUFDLENBQUM7QUFFMUM7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7R0E4Q0c7QUFFSCxNQUFNLENBQUMsT0FBTyxPQUFPLElBQUk7SUFDTixHQUFHLENBQUM7SUFFckIsWUFBWSxHQUFzRDtRQUNoRSxJQUFJLENBQUMsR0FBRyxHQUFHLEdBQUcsQ0FBQztJQUNqQixDQUFDO0lBRUQsS0FBSyxDQUFDLE9BQU87UUFDWCxNQUFNLFVBQVUsR0FBRyxJQUFJLENBQUMsR0FBRyxDQUFDLE1BQU0sQ0FBQyxJQUFJLENBQUM7UUFDeEMsVUFBVSxDQUFDLGFBQWEsR0FBRyxZQUFZLENBQUMsVUFBVSxDQUFDLGFBQWEsQ0FBQyxDQUFDO1FBQ2xFLFVBQVUsQ0FBQyxZQUFZLEdBQUcsRUFBRSxDQUFDLFVBQVUsQ0FBQyxZQUFZLENBQUMsQ0FBQztRQUV0RCxVQUFVLENBQUMsSUFBSSxHQUFHLEtBQUssQ0FBQyxPQUFPLENBQUMsVUFBVSxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQyxVQUFVLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQyxFQUFFLENBQUM7UUFDeEUsc0VBQXNFO1FBQ3RFLEtBQUssTUFBTSxJQUFJLElBQUksSUFBSSxDQUFDLEdBQUcsQ0FBQyxNQUFNLENBQUMsWUFBWSxFQUFFLEVBQUUsQ0FBQztZQUNsRCxJQUFJLFVBQVUsR0FBRyxJQUFJLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxJQUFJLEVBQUUsZUFBZSxDQUFDLENBQUM7WUFDdkQ7OztlQUdHO1lBQ0gsSUFBSSxDQUFDLENBQUMsTUFBTSxNQUFNLENBQUMsVUFBVSxDQUFDLENBQUMsRUFBRSxDQUFDO2dCQUNoQyxVQUFVLEdBQUcsSUFBSSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsSUFBSSxFQUFFLGdCQUFnQixDQUFDLENBQUM7WUFDdEQsQ0FBQztZQUNELFVBQVUsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLFVBQVUsQ0FBQyxDQUFDO1FBQ25DLENBQUM7UUFFRCxLQUFLLENBQUMsdUJBQXVCLEVBQUUsVUFBVSxDQUFDLElBQUksQ0FBQyxDQUFDO1FBRWhELE1BQU0sbUJBQW1CLENBQUMsSUFBSSxDQUFDLEdBQUcsRUFBRSxVQUFVLENBQUMsQ0FBQztRQUVoRCxNQUFNLEdBQUcsR0FBRyxJQUFJLENBQUMsR0FBRyxDQUFDO1FBQ3JCLFNBQVMsZ0JBQWdCLENBQUMsR0FBVyxFQUFFLEdBQUcsSUFBVztZQUNuRCxNQUFNLEdBQUcsR0FBRyxHQUFHLENBQUMsVUFBVSxDQUFDLFFBQVEsRUFBRyxDQUFDO1lBQ3ZDLE9BQU8sR0FBRyxDQUFDLE9BQU8sQ0FBQyxHQUFHLEVBQUUsR0FBRyxJQUFJLENBQUMsQ0FBQztRQUNuQyxDQUFDO1FBQ0QsdUNBQXVDO1FBQ3ZDLE1BQU0sQ0FBQyxnQkFBZ0IsQ0FBQyxHQUFHLENBQUMsTUFBTSxFQUFFO1lBQ2xDLEVBQUUsRUFBRTtnQkFDRixLQUFLLEVBQUUsZ0JBQWdCO2dCQUN2QixVQUFVLEVBQUUsSUFBSTthQUNqQjtZQUNELE9BQU8sRUFBRTtnQkFDUCxLQUFLLEVBQUUsZ0JBQWdCO2dCQUN2QixVQUFVLEVBQUUsSUFBSTthQUNqQjtTQUNGLENBQUMsQ0FBQztJQUNMLENBQUM7Q0FDRiJ9
@@ -1,5 +0,0 @@
1
- import type { I18nConfig } from '../types.js';
2
- declare const _default: {
3
- i18n: I18nConfig;
4
- };
5
- export default _default;
@@ -1,14 +0,0 @@
1
- export default {
2
- i18n: {
3
- defaultLocale: 'en_US',
4
- dirs: [],
5
- queryField: 'locale',
6
- cookieField: 'locale',
7
- cookieDomain: '',
8
- cookieMaxAge: '1y',
9
- localeAlias: {},
10
- writeCookie: true,
11
- dir: undefined,
12
- },
13
- };
14
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uZmlnLmRlZmF1bHQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvY29uZmlnL2NvbmZpZy5kZWZhdWx0LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUVBLGVBQWU7SUFDYixJQUFJLEVBQUU7UUFDSixhQUFhLEVBQUUsT0FBTztRQUN0QixJQUFJLEVBQUUsRUFBRTtRQUNSLFVBQVUsRUFBRSxRQUFRO1FBQ3BCLFdBQVcsRUFBRSxRQUFRO1FBQ3JCLFlBQVksRUFBRSxFQUFFO1FBQ2hCLFlBQVksRUFBRSxJQUFJO1FBQ2xCLFdBQVcsRUFBRSxFQUFFO1FBQ2YsV0FBVyxFQUFFLElBQUk7UUFDakIsR0FBRyxFQUFFLFNBQVM7S0FDRDtDQUNoQixDQUFDIn0=
@@ -1 +0,0 @@
1
- import './types.js';
package/dist/esm/index.js DELETED
@@ -1,2 +0,0 @@
1
- import './types.js';
2
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxZQUFZLENBQUMifQ==
@@ -1,3 +0,0 @@
1
- import type { I18nConfig } from './types.js';
2
- import I18nApplication from './app/extend/application.js';
3
- export declare function loadLocaleResources(app: I18nApplication, options: I18nConfig): Promise<void>;
@@ -1,65 +0,0 @@
1
- import { debuglog } from 'node:util';
2
- import fs from 'node:fs/promises';
3
- import path from 'node:path';
4
- import ini from 'ini';
5
- import yaml from 'js-yaml';
6
- import { exists, readJSON } from 'utility';
7
- import { importModule } from '@eggjs/utils';
8
- import { I18N_RESOURCES } from './app/extend/application.js';
9
- import { formatLocale, isObject } from './utils.js';
10
- const debug = debuglog('@eggjs/i18n/locales');
11
- export async function loadLocaleResources(app, options) {
12
- const localeDirs = options.dirs;
13
- const resources = {};
14
- if (options.dir && !localeDirs.includes(options.dir)) {
15
- localeDirs.push(options.dir);
16
- }
17
- for (const dir of localeDirs) {
18
- if (!(await exists(dir))) {
19
- continue;
20
- }
21
- const names = await fs.readdir(dir);
22
- for (const name of names) {
23
- const filepath = path.join(dir, name);
24
- // support en_US.js => en-US.js
25
- const locale = formatLocale(name.split('.')[0]);
26
- let resource = {};
27
- if (name.endsWith('.js') || name.endsWith('.ts')) {
28
- resource = flattening(await importModule(filepath, {
29
- importDefaultOnly: true,
30
- }));
31
- }
32
- else if (name.endsWith('.json')) {
33
- resource = flattening(await readJSON(filepath));
34
- }
35
- else if (name.endsWith('.properties')) {
36
- resource = ini.parse(await fs.readFile(filepath, 'utf8'));
37
- }
38
- else if (name.endsWith('.yml') || name.endsWith('.yaml')) {
39
- resource = flattening(yaml.load(await fs.readFile(filepath, 'utf8')));
40
- }
41
- resources[locale] = resources[locale] || {};
42
- Object.assign(resources[locale], resource);
43
- }
44
- }
45
- debug('Init locales with %j, got %j resources', options, Object.keys(resources));
46
- app[I18N_RESOURCES] = resources;
47
- }
48
- function flattening(data) {
49
- const result = {};
50
- function deepFlat(data, prefix) {
51
- for (const key in data) {
52
- const value = data[key];
53
- const k = prefix ? prefix + '.' + key : key;
54
- if (isObject(value)) {
55
- deepFlat(value, k);
56
- }
57
- else {
58
- result[k] = String(value);
59
- }
60
- }
61
- }
62
- deepFlat(data, '');
63
- return result;
64
- }
65
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibG9jYWxlcy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9sb2NhbGVzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sRUFBRSxRQUFRLEVBQUUsTUFBTSxXQUFXLENBQUM7QUFDckMsT0FBTyxFQUFFLE1BQU0sa0JBQWtCLENBQUM7QUFDbEMsT0FBTyxJQUFJLE1BQU0sV0FBVyxDQUFDO0FBQzdCLE9BQU8sR0FBRyxNQUFNLEtBQUssQ0FBQztBQUN0QixPQUFPLElBQUksTUFBTSxTQUFTLENBQUM7QUFDM0IsT0FBTyxFQUFFLE1BQU0sRUFBRSxRQUFRLEVBQUUsTUFBTSxTQUFTLENBQUM7QUFDM0MsT0FBTyxFQUFFLFlBQVksRUFBRSxNQUFNLGNBQWMsQ0FBQztBQUU1QyxPQUF3QixFQUFFLGNBQWMsRUFBRSxNQUFNLDZCQUE2QixDQUFDO0FBQzlFLE9BQU8sRUFBRSxZQUFZLEVBQUUsUUFBUSxFQUFFLE1BQU0sWUFBWSxDQUFDO0FBRXBELE1BQU0sS0FBSyxHQUFHLFFBQVEsQ0FBQyxxQkFBcUIsQ0FBQyxDQUFDO0FBRTlDLE1BQU0sQ0FBQyxLQUFLLFVBQVUsbUJBQW1CLENBQUMsR0FBb0IsRUFBRSxPQUFtQjtJQUNqRixNQUFNLFVBQVUsR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDO0lBQ2hDLE1BQU0sU0FBUyxHQUEyQyxFQUFFLENBQUM7SUFFN0QsSUFBSSxPQUFPLENBQUMsR0FBRyxJQUFJLENBQUMsVUFBVSxDQUFDLFFBQVEsQ0FBQyxPQUFPLENBQUMsR0FBRyxDQUFDLEVBQUUsQ0FBQztRQUNyRCxVQUFVLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxHQUFHLENBQUMsQ0FBQztJQUMvQixDQUFDO0lBRUQsS0FBSyxNQUFNLEdBQUcsSUFBSSxVQUFVLEVBQUUsQ0FBQztRQUM3QixJQUFJLENBQUMsQ0FBQyxNQUFNLE1BQU0sQ0FBQyxHQUFHLENBQUMsQ0FBQyxFQUFFLENBQUM7WUFDekIsU0FBUztRQUNYLENBQUM7UUFFRCxNQUFNLEtBQUssR0FBRyxNQUFNLEVBQUUsQ0FBQyxPQUFPLENBQUMsR0FBRyxDQUFDLENBQUM7UUFDcEMsS0FBSyxNQUFNLElBQUksSUFBSSxLQUFLLEVBQUUsQ0FBQztZQUN6QixNQUFNLFFBQVEsR0FBRyxJQUFJLENBQUMsSUFBSSxDQUFDLEdBQUcsRUFBRSxJQUFJLENBQUMsQ0FBQztZQUN0QywrQkFBK0I7WUFDL0IsTUFBTSxNQUFNLEdBQUcsWUFBWSxDQUFDLElBQUksQ0FBQyxLQUFLLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQztZQUNoRCxJQUFJLFFBQVEsR0FBMkIsRUFBRSxDQUFDO1lBRTFDLElBQUksSUFBSSxDQUFDLFFBQVEsQ0FBQyxLQUFLLENBQUMsSUFBSSxJQUFJLENBQUMsUUFBUSxDQUFDLEtBQUssQ0FBQyxFQUFFLENBQUM7Z0JBQ2pELFFBQVEsR0FBRyxVQUFVLENBQUMsTUFBTSxZQUFZLENBQUMsUUFBUSxFQUFFO29CQUNqRCxpQkFBaUIsRUFBRSxJQUFJO2lCQUN4QixDQUFDLENBQUMsQ0FBQztZQUNOLENBQUM7aUJBQU0sSUFBSSxJQUFJLENBQUMsUUFBUSxDQUFDLE9BQU8sQ0FBQyxFQUFFLENBQUM7Z0JBQ2xDLFFBQVEsR0FBRyxVQUFVLENBQUMsTUFBTSxRQUFRLENBQUMsUUFBUSxDQUFDLENBQUMsQ0FBQztZQUNsRCxDQUFDO2lCQUFNLElBQUksSUFBSSxDQUFDLFFBQVEsQ0FBQyxhQUFhLENBQUMsRUFBRSxDQUFDO2dCQUN4QyxRQUFRLEdBQUcsR0FBRyxDQUFDLEtBQUssQ0FBQyxNQUFNLEVBQUUsQ0FBQyxRQUFRLENBQUMsUUFBUSxFQUFFLE1BQU0sQ0FBQyxDQUFDLENBQUM7WUFDNUQsQ0FBQztpQkFBTSxJQUFJLElBQUksQ0FBQyxRQUFRLENBQUMsTUFBTSxDQUFDLElBQUksSUFBSSxDQUFDLFFBQVEsQ0FBQyxPQUFPLENBQUMsRUFBRSxDQUFDO2dCQUMzRCxRQUFRLEdBQUcsVUFBVSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsTUFBTSxFQUFFLENBQUMsUUFBUSxDQUFDLFFBQVEsRUFBRSxNQUFNLENBQUMsQ0FBQyxDQUFDLENBQUM7WUFDeEUsQ0FBQztZQUVELFNBQVMsQ0FBQyxNQUFNLENBQUMsR0FBRyxTQUFTLENBQUMsTUFBTSxDQUFDLElBQUksRUFBRSxDQUFDO1lBQzVDLE1BQU0sQ0FBQyxNQUFNLENBQUMsU0FBUyxDQUFDLE1BQU0sQ0FBQyxFQUFFLFFBQVEsQ0FBQyxDQUFDO1FBQzdDLENBQUM7SUFDSCxDQUFDO0lBRUQsS0FBSyxDQUFDLHdDQUF3QyxFQUFFLE9BQU8sRUFBRSxNQUFNLENBQUMsSUFBSSxDQUFDLFNBQVMsQ0FBQyxDQUFDLENBQUM7SUFDakYsR0FBRyxDQUFDLGNBQWMsQ0FBQyxHQUFHLFNBQVMsQ0FBQztBQUNsQyxDQUFDO0FBRUQsU0FBUyxVQUFVLENBQUMsSUFBUztJQUMzQixNQUFNLE1BQU0sR0FBMkIsRUFBRSxDQUFDO0lBRTFDLFNBQVMsUUFBUSxDQUFDLElBQVMsRUFBRSxNQUFjO1FBQ3pDLEtBQUssTUFBTSxHQUFHLElBQUksSUFBSSxFQUFFLENBQUM7WUFDdkIsTUFBTSxLQUFLLEdBQUcsSUFBSSxDQUFDLEdBQUcsQ0FBQyxDQUFDO1lBQ3hCLE1BQU0sQ0FBQyxHQUFHLE1BQU0sQ0FBQyxDQUFDLENBQUMsTUFBTSxHQUFHLEdBQUcsR0FBRyxHQUFHLENBQUMsQ0FBQyxDQUFDLEdBQUcsQ0FBQztZQUM1QyxJQUFJLFFBQVEsQ0FBQyxLQUFLLENBQUMsRUFBRSxDQUFDO2dCQUNwQixRQUFRLENBQUMsS0FBSyxFQUFFLENBQUMsQ0FBQyxDQUFDO1lBQ3JCLENBQUM7aUJBQU0sQ0FBQztnQkFDTixNQUFNLENBQUMsQ0FBQyxDQUFDLEdBQUcsTUFBTSxDQUFDLEtBQUssQ0FBQyxDQUFDO1lBQzVCLENBQUM7UUFDSCxDQUFDO0lBQ0gsQ0FBQztJQUVELFFBQVEsQ0FBQyxJQUFJLEVBQUUsRUFBRSxDQUFDLENBQUM7SUFFbkIsT0FBTyxNQUFNLENBQUM7QUFDaEIsQ0FBQyJ9
@@ -1,3 +0,0 @@
1
- {
2
- "type": "module"
3
- }
@@ -1,74 +0,0 @@
1
- /**
2
- * I18n options
3
- * @member Config#i18n
4
- */
5
- export interface I18nConfig {
6
- /**
7
- * 默认语言是美式英语,毕竟支持多语言,基本都是以英语为母板
8
- * 默认值是 `en_US`
9
- */
10
- defaultLocale: string;
11
- /**
12
- * 多语言资源文件存放路径,不建议修改
13
- * 默认值是 `[]`
14
- */
15
- dirs: string[];
16
- /**
17
- * @deprecated please use `dirs` instead
18
- */
19
- dir?: string;
20
- /**
21
- * 设置当前语言的 query 参数字段名,默认通过 `query.locale` 获取
22
- * 如果你想修改为 `query.lang`,那么请通过修改此配置实现
23
- * 默认值是 `locale`
24
- */
25
- queryField: string;
26
- /**
27
- * 如果当前请求用户语言有变化,都会设置到 cookie 中保持着,
28
- * 默认是存储在key 为 locale 的 cookie 中
29
- * 默认值是 `locale`
30
- */
31
- cookieField: string;
32
- /**
33
- * 存储 locale 的 cookie domain 配置,默认不设置,为当前域名才有效
34
- * 默认值是 `''`
35
- */
36
- cookieDomain: string;
37
- /**
38
- * cookie 默认一年后过期,如果设置为 Number,则单位为 ms
39
- * 默认值是 `'1y'`
40
- */
41
- cookieMaxAge: string | number;
42
- /**
43
- * locale 别名,比如 zh_CN => cn
44
- * 默认值是 `{}`
45
- */
46
- localeAlias: Record<string, string>;
47
- /**
48
- * 是否写入 cookie
49
- * 默认值是 `true`
50
- */
51
- writeCookie: boolean;
52
- }
53
- declare module '@eggjs/core' {
54
- interface EggAppConfig {
55
- i18n: I18nConfig;
56
- }
57
- interface Context {
58
- /**
59
- * get and set current request locale
60
- * @member Context#locale
61
- * @return {String} lower case locale string, e.g.: 'zh-cn', 'en-us'
62
- */
63
- locale: string;
64
- gettext(key: string, value?: any, ...args: any[]): string;
65
- __(key: string, value?: any, ...args: any[]): string;
66
- __getLocale(): string;
67
- __setLocale(l: string): void;
68
- }
69
- interface EggCore {
70
- isSupportLocale(locale: string): boolean;
71
- gettext(locale: string, key: string, value?: any, ...args: any[]): string;
72
- __(locale: string, key: string, value?: any, ...args: any[]): string;
73
- }
74
- }
package/dist/esm/types.js DELETED
@@ -1,2 +0,0 @@
1
- export {};
2
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvdHlwZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiJ9
@@ -1,2 +0,0 @@
1
- export declare function isObject(obj: any): boolean;
2
- export declare function formatLocale(locale: string): string;
package/dist/esm/utils.js DELETED
@@ -1,8 +0,0 @@
1
- export function isObject(obj) {
2
- return Object.prototype.toString.call(obj) === '[object Object]';
3
- }
4
- export function formatLocale(locale) {
5
- // support zh_CN, en_US => zh-CN, en-US
6
- return locale.replace('_', '-').toLowerCase();
7
- }
8
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidXRpbHMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvdXRpbHMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsTUFBTSxVQUFVLFFBQVEsQ0FBQyxHQUFRO0lBQy9CLE9BQU8sTUFBTSxDQUFDLFNBQVMsQ0FBQyxRQUFRLENBQUMsSUFBSSxDQUFDLEdBQUcsQ0FBQyxLQUFLLGlCQUFpQixDQUFDO0FBQ25FLENBQUM7QUFFRCxNQUFNLFVBQVUsWUFBWSxDQUFDLE1BQWM7SUFDekMsdUNBQXVDO0lBQ3ZDLE9BQU8sTUFBTSxDQUFDLE9BQU8sQ0FBQyxHQUFHLEVBQUUsR0FBRyxDQUFDLENBQUMsV0FBVyxFQUFFLENBQUM7QUFDaEQsQ0FBQyJ9
package/dist/package.json DELETED
@@ -1,4 +0,0 @@
1
- {
2
- "name": "@eggjs/i18n",
3
- "version": "3.0.1"
4
- }
@@ -1,91 +0,0 @@
1
- import { debuglog, format } from 'node:util';
2
- import { EggCore } from '@eggjs/core';
3
- import { isObject } from '../../utils.js';
4
-
5
- const debug = debuglog('@eggjs/i18n/app/extend/application');
6
-
7
- export const I18N_RESOURCES = Symbol('Application i18n resources');
8
-
9
- export default class I18nApplication extends EggCore {
10
- declare [I18N_RESOURCES]: Record<string, Record<string, string>>;
11
-
12
- isSupportLocale(locale: string) {
13
- return !!this[I18N_RESOURCES][locale];
14
- }
15
-
16
- gettext(locale: string, key: string, value?: any, ...args: any[]) {
17
- if (!locale || !key) {
18
- // __()
19
- // __('en')
20
- return '';
21
- }
22
-
23
- const resource = this[I18N_RESOURCES][locale] || {};
24
-
25
- let text = resource[key];
26
- if (text === undefined) {
27
- text = key;
28
- }
29
-
30
- debug('%s: %j => %j', locale, key, text);
31
- if (!text) {
32
- return '';
33
- }
34
-
35
- if (value === undefined) {
36
- // __(locale, key)
37
- return text;
38
- }
39
- if (args.length === 0) {
40
- if (isObject(value)) {
41
- // __(locale, key, object)
42
- // __('zh', '{a} {b} {b} {a}', {a: 'foo', b: 'bar'})
43
- // =>
44
- // foo bar bar foo
45
- return formatWithObject(text, value);
46
- }
47
-
48
- if (Array.isArray(value)) {
49
- // __(locale, key, array)
50
- // __('zh', '{0} {1} {1} {0}', ['foo', 'bar'])
51
- // =>
52
- // foo bar bar foo
53
- return formatWithArray(text, value);
54
- }
55
-
56
- // __(locale, key, value)
57
- return format(text, value);
58
- }
59
-
60
- // __(locale, key, value1, ...)
61
- return format(text, value, ...args);
62
- }
63
-
64
- __(locale: string, key: string, value?: any, ...args: any[]) {
65
- return this.gettext(locale, key, value, ...args);
66
- }
67
- }
68
-
69
- const ARRAY_INDEX_RE = /\{(\d+)\}/g;
70
- function formatWithArray(text: string, values: any[]) {
71
- return text.replace(ARRAY_INDEX_RE, (original, matched) => {
72
- const index = parseInt(matched);
73
- if (index < values.length) {
74
- return values[index];
75
- }
76
- // not match index, return original text
77
- return original;
78
- });
79
- }
80
-
81
- const Object_INDEX_RE = /\{(.+?)\}/g;
82
- function formatWithObject(text: string, values: Record<string, any>) {
83
- return text.replace(Object_INDEX_RE, (original, matched) => {
84
- const value = values[matched];
85
- if (value) {
86
- return value;
87
- }
88
- // not match index, return original text
89
- return original;
90
- });
91
- }
@@ -1,192 +0,0 @@
1
- import { debuglog } from 'node:util';
2
- import { Context } from '@eggjs/core';
3
- import { formatLocale } from '../../utils.js';
4
-
5
- const debug = debuglog('@eggjs/i18n/app/extend/context');
6
-
7
- export default class I18nContext extends Context {
8
- /**
9
- * get current request locale
10
- * @member Context#locale
11
- * @return {String} lower case locale string, e.g.: 'zh-cn', 'en-us'
12
- */
13
- get locale(): string {
14
- return this.__getLocale();
15
- }
16
-
17
- set locale(l: string) {
18
- this.__setLocale(l);
19
- }
20
-
21
- /**
22
- * `ctx.__` 的别名。
23
- * @see {@link Context#__}
24
- * @function Context#gettext
25
- */
26
- gettext(key: string, value?: any, ...args: any[]) {
27
- return this.app.gettext(this.locale, key, value, ...args);
28
- }
29
-
30
- /**
31
- * 如果开启了 I18n 多语言功能,那么会出现此 API,通过它可以获取到当前请求对应的本地化数据。
32
- *
33
- * 详细使用说明,请查看 {@link I18n}
34
- * - `ctx.__ = function (key, value[, value2, ...])`: 类似 `util.format` 接口
35
- * - `ctx.__ = function (key, values)`: 支持数组下标占位符方式,如
36
- * - `__` 的别名是 `gettext(key, value)`
37
- *
38
- * > NOTE: __ 是两个下划线哦!
39
- * @function Context#__
40
- * @example
41
- * ```js
42
- * ctx.__('{0} {0} {1} {1}'), ['foo', 'bar'])
43
- * ctx.gettext('{0} {0} {1} {1}'), ['foo', 'bar'])
44
- * =>
45
- * foo foo bar bar
46
- * ```
47
- * ##### Controller 下的使用示例
48
- *
49
- * ```js
50
- * module.exports = function* () {
51
- * this.body = {
52
- * message: this.__('Welcome back, %s!', this.user.name),
53
- * // 或者使用 gettext,如果觉得 __ 不好看的话
54
- * // message: this.gettext('Welcome back, %s!', this.user.name),
55
- * user: this.user,
56
- * };
57
- * };
58
- * ```
59
- *
60
- * ##### View 文件下的使用示例
61
- *
62
- * ```html
63
- * <li>{{ __('Email') }}: {{ user.email }}</li>
64
- * <li>
65
- * {{ __('Hello %s, how are you today?', user.name) }}
66
- * </li>
67
- * <li>
68
- * {{ __('{0} {0} {1} {1}'), ['foo', 'bar']) }}
69
- * </li>
70
- * ```
71
- *
72
- * ##### locale 参数获取途径
73
- *
74
- * 优先级从上到下:
75
- *
76
- * - query: `/?locale=en-US`
77
- * - cookie: `locale=zh-TW`
78
- * - header: `Accept-Language: zh-CN,zh;q=0.5`
79
- */
80
- __(key: string, value?: any, ...args: any[]) {
81
- return this.gettext(key, value, ...args);
82
- }
83
-
84
- declare __locale: string;
85
- // 1. query: /?locale=en-US
86
- // 2. cookie: locale=zh-TW
87
- // 3. header: Accept-Language: zh-CN,zh;q=0.5
88
- __getLocale(): string {
89
- if (this.__locale) {
90
- return this.__locale;
91
- }
92
-
93
- const { localeAlias, defaultLocale, cookieField, queryField, writeCookie } = this.app.config.i18n;
94
- const cookieLocale = this.cookies.get(cookieField, { signed: false });
95
-
96
- // 1. Query
97
- let locale = this.query[queryField] as string;
98
- let localeOrigin = 'query';
99
-
100
- // 2. Cookie
101
- if (!locale) {
102
- locale = cookieLocale;
103
- localeOrigin = 'cookie';
104
- }
105
-
106
- // 3. Header
107
- if (!locale) {
108
- // Accept-Language: zh-CN,zh;q=0.5
109
- // Accept-Language: zh-CN
110
- let languages = this.acceptsLanguages();
111
- if (languages) {
112
- if (Array.isArray(languages)) {
113
- if (languages[0] === '*') {
114
- languages = languages.slice(1);
115
- }
116
- if (languages.length > 0) {
117
- for (const l of languages) {
118
- const lang = formatLocale(l);
119
- if (this.app.isSupportLocale(lang) || localeAlias[lang]) {
120
- locale = lang;
121
- localeOrigin = 'header';
122
- break;
123
- }
124
- }
125
- }
126
- } else {
127
- locale = languages;
128
- localeOrigin = 'header';
129
- }
130
- }
131
-
132
- // all missing, set it to defaultLocale
133
- if (!locale) {
134
- locale = defaultLocale;
135
- localeOrigin = 'default';
136
- }
137
- }
138
-
139
- // cookie alias
140
- if (locale in localeAlias) {
141
- const originalLocale = locale;
142
- locale = localeAlias[locale];
143
- debug('Used alias, received %s but using %s', originalLocale, locale);
144
- }
145
-
146
- locale = formatLocale(locale);
147
-
148
- // validate locale
149
- if (!this.app.isSupportLocale(locale)) {
150
- debug('Locale %s is not supported. Using default (%s)', locale, defaultLocale);
151
- locale = defaultLocale;
152
- }
153
-
154
- // if header not send, set the locale cookie
155
- if (writeCookie && cookieLocale !== locale && !this.headerSent) {
156
- updateCookie(this, locale);
157
- }
158
- debug('Locale: %s from %s', locale, localeOrigin);
159
- this.__locale = locale;
160
- this.__localeOrigin = localeOrigin;
161
- return locale;
162
- }
163
-
164
- declare __localeOrigin: string;
165
- __getLocaleOrigin() {
166
- if (this.__localeOrigin) {
167
- return this.__localeOrigin;
168
- }
169
- this.__getLocale();
170
- return this.__localeOrigin;
171
- }
172
-
173
- __setLocale(locale: string) {
174
- this.__locale = locale;
175
- this.__localeOrigin = 'set';
176
- updateCookie(this, locale);
177
- }
178
- }
179
-
180
- function updateCookie(ctx: Context, locale: string) {
181
- const { cookieMaxAge, cookieField, cookieDomain } = ctx.app.config.i18n;
182
- const cookieOptions = {
183
- // make sure browser javascript can read the cookie
184
- httpOnly: false,
185
- maxAge: cookieMaxAge as number,
186
- signed: false,
187
- domain: cookieDomain,
188
- overwrite: true,
189
- };
190
- ctx.cookies.set(cookieField, locale, cookieOptions);
191
- debug('Saved cookie with locale %s, options: %j', locale, cookieOptions);
192
- }