@intlayer/docs 8.4.6 → 8.4.8

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 (33) hide show
  1. package/blog/en/next-i18next_vs_next-intl_vs_intlayer.md +1 -3
  2. package/blog/en-GB/next-i18next_vs_next-intl_vs_intlayer.md +1 -3
  3. package/blog/es/next-i18next_vs_next-intl_vs_intlayer.md +1 -3
  4. package/blog/id/next-i18next_vs_next-intl_vs_intlayer.md +1 -3
  5. package/blog/it/next-i18next_vs_next-intl_vs_intlayer.md +1 -3
  6. package/blog/ja/next-i18next_vs_next-intl_vs_intlayer.md +1 -3
  7. package/blog/ko/next-i18next_vs_next-intl_vs_intlayer.md +1 -3
  8. package/blog/uk/next-i18next_vs_next-intl_vs_intlayer.md +1 -3
  9. package/blog/vi/next-i18next_vs_next-intl_vs_intlayer.md +1 -3
  10. package/blog/zh/next-i18next_vs_next-intl_vs_intlayer.md +1 -3
  11. package/docs/ar/configuration.md +300 -264
  12. package/docs/cs/configuration.md +958 -0
  13. package/docs/de/configuration.md +285 -249
  14. package/docs/en/configuration.md +115 -137
  15. package/docs/en-GB/configuration.md +272 -237
  16. package/docs/es/configuration.md +161 -125
  17. package/docs/fr/configuration.md +137 -101
  18. package/docs/it/configuration.md +294 -259
  19. package/docs/ja/configuration.md +269 -233
  20. package/docs/nl/configuration.md +958 -0
  21. package/docs/pt/configuration.md +311 -275
  22. package/docs/ru/configuration.md +287 -272
  23. package/docs/tr/configuration.md +265 -229
  24. package/package.json +6 -6
  25. package/docs/bn/configuration.md +0 -922
  26. package/docs/hi/configuration.md +0 -922
  27. package/docs/id/configuration.md +0 -922
  28. package/docs/ko/configuration.md +0 -922
  29. package/docs/pl/configuration.md +0 -922
  30. package/docs/uk/configuration.md +0 -922
  31. package/docs/ur/configuration.md +0 -922
  32. package/docs/vi/configuration.md +0 -922
  33. package/docs/zh/configuration.md +0 -922
@@ -2,7 +2,7 @@
2
2
  createdAt: 2024-08-13
3
3
  updatedAt: 2026-03-20
4
4
  title: 設定 (Configuration)
5
- description: アプリケーションにIntlayerを設定する方法を学びます。ニーズに合わせてIntlayerをカスタマイズするためのさまざまな設定とオプションを理解してください。
5
+ description: アプリケーションにIntlayerを設定する方法について説明します。ニーズに合わせてIntlayerをカスタマイズするためのさまざまな設定とオプションを理解してください。
6
6
  keywords:
7
7
  - 設定
8
8
  - セッティング
@@ -16,7 +16,7 @@ slugs:
16
16
  history:
17
17
  - version: 8.4.0
18
18
  date: 2026-03-20
19
- changes: 'compiler.output' と 'dictionary.fill' に対するロケールごとのオブジェクト表記を追加
19
+ changes: 'compiler.output' と 'dictionary.fill' にロケールごとのオブジェクト記法を追加
20
20
  - version: 8.3.0
21
21
  date: 2026-03-11
22
22
  changes: 'baseDir' を 'content' 設定から 'system' 設定に移動
@@ -28,28 +28,28 @@ history:
28
28
  changes: コンパイラオプションを更新
29
29
  - version: 8.1.5
30
30
  date: 2026-02-23
31
- changes: コンパイラオプション 'build-only' とディクショナリプレフィックスを追加
31
+ changes: 'build-only' コンパイラオプションと辞書プレフィックスを追加
32
32
  - version: 8.0.6
33
33
  date: 2026-02-12
34
34
  changes: Open Router, Alibaba, Amazon, Google Vertex Bedrock, Fireworks, Groq, Hugging Face, Together.ai プロバイダーのサポートを追加
35
35
  - version: 8.0.5
36
36
  date: 2026-02-06
37
- changes: AI 設定に `dataSerialization` を追加
37
+ changes: AI設定に `dataSerialization` を追加
38
38
  - version: 8.0.0
39
39
  date: 2026-01-24
40
- changes: 基本的なメカニズムをより適切に説明するために、インポートモード `live` `fetch` に変更。
40
+ changes: 基盤となるメカニズムをより正確に表すため、`live` インポートモードを `fetch` に名前変更。
41
41
  - version: 8.0.0
42
42
  date: 2026-01-22
43
- changes: ビルド設定 `importMode` `dictionary` 設定に移動。
43
+ changes: `importMode` ビルド設定を `dictionary` 設定に移動。
44
44
  - version: 8.0.0
45
45
  date: 2026-01-22
46
46
  changes: ルーティング設定に `rewrite` オプションを追加
47
47
  - version: 8.0.0
48
48
  date: 2026-01-18
49
- changes: システム設定をコンテンツ設定から分離。内部パスを `system` プロパティに移動。コンテンツファイルとコード変換を分離するために `codeDir` を追加。
49
+ changes: コンテンツ設定からシステム設定を分離。内部パスを `system` プロパティに移動。コンテンツファイルとコード変換を分離するため `codeDir` を追加。
50
50
  - version: 8.0.0
51
51
  date: 2026-01-18
52
- changes: ディクショナリオプション `location` と `schema` を追加
52
+ changes: `location` と `schema` 辞書オプションを追加
53
53
  - version: 7.5.1
54
54
  date: 2026-01-10
55
55
  changes: JSON5 および JSONC ファイル形式のサポートを追加
@@ -61,7 +61,7 @@ history:
61
61
  changes: `dictionary` 設定を追加
62
62
  - version: 7.0.0
63
63
  date: 2025-10-21
64
- changes: `middleware` をルーティング設定 `routing` に置き換え
64
+ changes: `middleware` `routing` 設定に置き換え
65
65
  - version: 7.0.0
66
66
  date: 2025-10-12
67
67
  changes: `formatCommand` オプションを追加
@@ -79,13 +79,13 @@ history:
79
79
  changes: `live` インポートモードを追加
80
80
  - version: 6.0.0
81
81
  date: 2025-09-04
82
- changes: `hotReload` フィールドを `liveSync` に置き換え、`liveSyncPort` および `liveSyncURL` フィールドを追加
82
+ changes: `hotReload` フィールドを `liveSync` に置き換え、`liveSyncPort` `liveSyncURL` フィールドを追加
83
83
  - version: 5.6.1
84
84
  date: 2025-07-25
85
85
  changes: `activateDynamicImport` を `importMode` オプションに置き換え
86
86
  - version: 5.6.0
87
87
  date: 2025-07-13
88
- changes: デフォルトの contentDir を `['src']` から `['.']` に変更
88
+ changes: デフォルトの `contentDir` を `['src']` から `['.']` に変更
89
89
  - version: 5.5.11
90
90
  date: 2025-06-29
91
91
  changes: `docs` コマンドを追加
@@ -95,7 +95,7 @@ history:
95
95
 
96
96
  ## 概要
97
97
 
98
- Intlayer 設定ファイルを使用すると、国際化 (internationalization)、ミドルウェア、コンテンツ処理など、プラグインのさまざまな側面をカスタマイズできます。このドキュメントでは、設定内の各プロパティについて詳しく説明します。
98
+ Intlayer 設定ファイルを使用すると、国際化、ミドルウェア、コンテンツ管理など、プラグインのさまざまな側面をカスタマイズできます。このドキュメントでは、設定内の各プロパティの詳細な説明を提供します。
99
99
 
100
100
  ---
101
101
 
@@ -105,9 +105,9 @@ Intlayer 設定ファイルを使用すると、国際化 (internationalization)
105
105
 
106
106
  ---
107
107
 
108
- ## サポートされている設定ファイル形式
108
+ ## 設定ファイルのサポート
109
109
 
110
- Intlayer は、JSON、JS、MJSTS などの設定ファイル形式を受け入れます。
110
+ Intlayer は、JSON、JS、MJS、および TS の設定ファイル形式をサポートしています。
111
111
 
112
112
  - `intlayer.config.ts`
113
113
  - `intlayer.config.js`
@@ -128,37 +128,37 @@ import { nextjsRewrite } from "intlayer/routing";
128
128
  import { z } from "zod";
129
129
 
130
130
  /**
131
- * すべての利用可能なオプションを表示する Intlayer 設定ファイルの例。
131
+ * 利用可能なすべてのオプションを示す Intlayer 設定ファイルの例。
132
132
  */
133
133
  const config: IntlayerConfig = {
134
134
  /**
135
- * 国際化設定の構成。
135
+ * 国際化設定。
136
136
  */
137
137
  internationalization: {
138
138
  /**
139
- * アプリケーションでサポートされるロケール (locales) のリスト。
139
+ * アプリケーションでサポートされるロケールのリスト。
140
140
  * デフォルト: [Locales.ENGLISH]
141
141
  */
142
142
  locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
143
143
 
144
144
  /**
145
145
  * 各辞書で定義する必要がある必須ロケールのリスト。
146
- * 空の場合、`strict` モードではすべてのロケールが必須になります。
146
+ * 空の場合、`strict` モードですべてのロケールが必須になります。
147
147
  * デフォルト: []
148
148
  */
149
149
  requiredLocales: [Locales.ENGLISH],
150
150
 
151
151
  /**
152
- * 国際化されたコンテンツの厳格さのレベル。
153
- * - "strict": 宣言されたロケールが欠落しているか、未宣言の場合はエラー。
154
- * - "inclusive": 宣言されたロケールが欠落している場合は警告。
155
- * - "loose": 既存のロケールを受け入れる。
152
+ * 国際化されたコンテンツの厳密レベル。
153
+ * - "strict": 宣言されたロケールが欠落している、または宣言されていない場合にエラーをスローします。
154
+ * - "inclusive": 宣言されたロケールが欠落している場合に警告をスローします。
155
+ * - "loose": 既存のロケールをすべて受け入れます。
156
156
  * デフォルト: "inclusive"
157
157
  */
158
158
  strictMode: "inclusive",
159
159
 
160
160
  /**
161
- * リクエストされたロケールが見つからない場合にフォールバックとして使用されるデフォルトロケール。
161
+ * 要求されたロケールが見つからない場合にフォールバックとして使用されるデフォルトロケール。
162
162
  * デフォルト: Locales.ENGLISH
163
163
  */
164
164
  defaultLocale: Locales.ENGLISH,
@@ -170,26 +170,26 @@ const config: IntlayerConfig = {
170
170
  dictionary: {
171
171
  /**
172
172
  * 辞書のインポート方法を制御します。
173
- * - "static": ビルド時に静的にインポート。
174
- * - "dynamic": Suspense を使用して動的にインポート。
175
- * - "fetch": Live Sync API を介して動的に取得。
173
+ * - "static": ビルド時に静的にインポートされます。
174
+ * - "dynamic": Suspense を使用して動的にインポートされます。
175
+ * - "fetch": Live Sync API を介して動的に取得されます。
176
176
  * デフォルト: "static"
177
177
  */
178
178
  importMode: "static",
179
179
 
180
180
  /**
181
- * AI を使用して欠落している翻訳を自動的に埋める戦略。
182
- * ブール値または埋められたコンテンツを保存するためのパスパターンを指定できます。
181
+ * AI を使用して欠落している翻訳を自動入力する戦略。
182
+ * ブール値、または入力されたコンテンツを保存するパスパターン。
183
183
  * デフォルト: true
184
184
  */
185
185
  fill: true,
186
186
 
187
187
  /**
188
188
  * 辞書ファイルの物理的な場所。
189
- * - "local": ローカルファイルシステムに保存。
190
- * - "remote": Intlayer CMS に保存。
191
- * - "hybrid": ローカルと Intlayer CMS の両方に保存。
192
- * - "plugin" (または任意のカスタム文字列): プラグインまたはカスタムソースによって提供。
189
+ * - "local": ローカルファイルシステムに保存されます。
190
+ * - "remote": Intlayer CMS に保存されます。
191
+ * - "hybrid": ローカルファイルシステムと Intlayer CMS の両方に保存されます。
192
+ * - "plugin" (または任意のカスタム文字列): プラグインやカスタムソースによって提供されます。
193
193
  * デフォルト: "local"
194
194
  */
195
195
  location: "local",
@@ -207,17 +207,17 @@ const config: IntlayerConfig = {
207
207
  routing: {
208
208
  /**
209
209
  * ロケールルーティング戦略。
210
- * - "prefix-no-default": デフォルトロケール以外にプレフィックスを付ける (例: /dashboard, /fr/dashboard)。
211
- * - "prefix-all": すべてのロケールにプレフィックスを付ける (例: /en/dashboard, /fr/dashboard)。
212
- * - "no-prefix": URL にロケールを含めない。
213
- * - "search-params": ?locale=... を使用。
210
+ * - "prefix-no-default": デフォルト以外のすべてのロケールにプレフィックスを付けます (例: /dashboard, /fr/dashboard)。
211
+ * - "prefix-all": すべてのロケールにプレフィックスを付けます (例: /en/dashboard, /fr/dashboard)。
212
+ * - "no-prefix": URL にロケールを含めません。
213
+ * - "search-params": ?locale=... を使用します。
214
214
  * デフォルト: "prefix-no-default"
215
215
  */
216
216
  mode: "prefix-no-default",
217
217
 
218
218
  /**
219
219
  * ユーザーが選択したロケールを保存する場所。
220
- * オプション: 'cookie', 'localStorage', 'sessionStorage', 'header', またはこれらの配列。
220
+ * オプション: 'cookie', 'localStorage', 'sessionStorage', 'header', またはそれらの配列。
221
221
  * デフォルト: ['cookie', 'header']
222
222
  */
223
223
  storage: ["cookie", "header"],
@@ -229,7 +229,7 @@ const config: IntlayerConfig = {
229
229
  basePath: "",
230
230
 
231
231
  /**
232
- * ロケールごとの特定のパスに対するカスタム URL リライトルール。
232
+ * 特定のロケールパスに対するカスタム URL リライトルール。
233
233
  */
234
234
  rewrite: nextjsRewrite({
235
235
  "/[locale]/about": {
@@ -244,66 +244,66 @@ const config: IntlayerConfig = {
244
244
  */
245
245
  content: {
246
246
  /**
247
- * 辞書をスキャンするためのファイル拡張子。
248
- * デフォルト: ['.content.ts', '.content.js', '.content.json' など]
247
+ * 辞書をスキャンするファイル拡張子。
248
+ * デフォルト: ['.content.ts', '.content.js', '.content.json', など]
249
249
  */
250
250
  fileExtensions: [".content.ts", ".content.js", ".content.json"],
251
251
 
252
252
  /**
253
- * .content ファイルが配置されているディレクトリ。
253
+ * .content ファイルが存在するディレクトリ。
254
254
  * デフォルト: ["."]
255
255
  */
256
256
  contentDir: ["src"],
257
257
 
258
258
  /**
259
- * ソースコードが配置されている場所。
259
+ * ソースコードが存在するディレクトリ。
260
260
  * ビルドの最適化とコード変換に使用されます。
261
261
  * デフォルト: ["."]
262
262
  */
263
263
  codeDir: ["src"],
264
264
 
265
265
  /**
266
- * スキャンから除外されるパターン。
267
- * デフォルト: ['node_modules', '.intlayer' など]
266
+ * スキャンから除外するパターン。
267
+ * デフォルト: ['node_modules', '.intlayer', など]
268
268
  */
269
269
  excludedPath: ["node_modules"],
270
270
 
271
271
  /**
272
- * 開発中に変更を監視し、辞書を再構築するかどうか。
273
- * デフォルト: 開発中は true
272
+ * 開発中に変更を監視し、辞書を再生成するかどうか。
273
+ * デフォルト: 開発環境では true
274
274
  */
275
275
  watch: true,
276
276
 
277
277
  /**
278
- * 新しく作成または更新された .content ファイルをフォーマットするために使用されるコマンド。
278
+ * 新しく作成または更新された .content ファイルをフォーマットするためのコマンド。
279
279
  */
280
280
  formatCommand: 'npx prettier --write "{{file}}"',
281
281
  },
282
282
 
283
283
  /**
284
- * ビジュアルエディターの設定。
284
+ * ビジュアルエディタの設定。
285
285
  */
286
286
  editor: {
287
287
  /**
288
- * ビジュアルエディターが有効かどうか。
288
+ * ビジュアルエディタを有効にするかどうか。
289
289
  * デフォルト: false
290
290
  */
291
291
  enabled: true,
292
292
 
293
293
  /**
294
- * オリジン検証のためのアプリケーションの URL。
294
+ * オリジン検証のためのアプリケーション URL。
295
295
  * デフォルト: ""
296
296
  */
297
297
  applicationURL: "http://localhost:3000",
298
298
 
299
299
  /**
300
- * ローカルエディターサーバーのポート。
300
+ * ローカルエディタサーバーのポート。
301
301
  * デフォルト: 8000
302
302
  */
303
303
  port: 8000,
304
304
 
305
305
  /**
306
- * エディターの公開 URL。
306
+ * エディタのパブリック URL。
307
307
  * デフォルト: "http://localhost:8000"
308
308
  */
309
309
  editorURL: "http://localhost:8000",
@@ -328,7 +328,7 @@ const config: IntlayerConfig = {
328
328
  },
329
329
 
330
330
  /**
331
- * AI ベースの翻訳および構築設定。
331
+ * AI による翻訳と生成の設定。
332
332
  */
333
333
  ai: {
334
334
  /**
@@ -339,7 +339,7 @@ const config: IntlayerConfig = {
339
339
  provider: "openai",
340
340
 
341
341
  /**
342
- * 使用する選択されたプロバイダーのモデル。
342
+ * 選択したプロバイダーで使用するモデル。
343
343
  */
344
344
  model: "gpt-4o",
345
345
 
@@ -349,7 +349,7 @@ const config: IntlayerConfig = {
349
349
  apiKey: process.env.OPENAI_API_KEY,
350
350
 
351
351
  /**
352
- * 翻訳を生成する際に AI を導くためのグローバルコンテキスト。
352
+ * 翻訳を生成する際に AI をガイドするグローバルコンテキスト。
353
353
  */
354
354
  applicationContext: "これは旅行予約アプリケーションです。",
355
355
 
@@ -359,11 +359,11 @@ const config: IntlayerConfig = {
359
359
  baseURL: "http://localhost:3000",
360
360
 
361
361
  /**
362
- * データシリアル化 (Data Serialization)
362
+ * データシリアライゼーション
363
363
  *
364
364
  * オプション:
365
- * - "json": デフォルト、堅牢、より多くのトークンを消費します。
366
- * - "toon": トークンの消費が少なく、JSON ほど一貫性がない場合があります。
365
+ * - "json": デフォルト、信頼性が高いがトークン消費が多い。
366
+ * - "toon": トークン消費が少ないが、JSON ほど一貫性がない。
367
367
  *
368
368
  * デフォルト: "json"
369
369
  */
@@ -375,9 +375,9 @@ const config: IntlayerConfig = {
375
375
  */
376
376
  build: {
377
377
  /**
378
- * ビルド実行モード。
379
- * - "auto": アプリケーションのビルド中に自動的にビルド。
380
- * - "manual": 明示的なビルドコマンドが必要。
378
+ * ビルドの実行モード。
379
+ * - "auto": アプリのビルド中に自動的にビルドされます。
380
+ * - "manual": 明示的なビルドコマンドが必要です。
381
381
  * デフォルト: "auto"
382
382
  */
383
383
  mode: "auto",
@@ -395,7 +395,7 @@ const config: IntlayerConfig = {
395
395
  outputFormat: ["cjs", "esm"],
396
396
 
397
397
  /**
398
- * ビルドが TypeScript の型をチェックするかどうかを指定します。
398
+ * ビルド時に TypeScript の型チェックを行うかどうか。
399
399
  * デフォルト: false
400
400
  */
401
401
  checkTypes: false,
@@ -407,9 +407,9 @@ const config: IntlayerConfig = {
407
407
  log: {
408
408
  /**
409
409
  * ログレベル。
410
- * - "default": 標準的なロギング。
411
- * - "verbose": 詳細なデバッグロギング。
412
- * - "disabled": ロギングを無効化。
410
+ * - "default": 標準的なログ記録。
411
+ * - "verbose": 詳細なデバッグログ。
412
+ * - "disabled": ログを記録しません。
413
413
  * デフォルト: "default"
414
414
  */
415
415
  mode: "default",
@@ -422,26 +422,26 @@ const config: IntlayerConfig = {
422
422
  },
423
423
 
424
424
  /**
425
- * システム設定 (高度な使用向け)
425
+ * システム設定 (高度なユースケース)
426
426
  */
427
427
  system: {
428
428
  /**
429
- * ローカライズされた辞書を保存するためのディレクトリ。
429
+ * ローカライズされた辞書を保存するディレクトリ。
430
430
  */
431
431
  dictionariesDir: ".intlayer/dictionary",
432
432
 
433
433
  /**
434
- * TypeScript モジュール拡張用のディレクトリ。
434
+ * モジュール拡張 (module augmentation) 用のディレクトリ。
435
435
  */
436
436
  moduleAugmentationDir: ".intlayer/types",
437
437
 
438
438
  /**
439
- * マージされていない辞書を保存するためのディレクトリ。
439
+ * マージされていない辞書を保存するディレクトリ。
440
440
  */
441
441
  unmergedDictionariesDir: ".intlayer/unmerged_dictionary",
442
442
 
443
443
  /**
444
- * 辞書の型を保存するためのディレクトリ。
444
+ * 辞書の型を保存するディレクトリ。
445
445
  */
446
446
  typesDir: ".intlayer/types",
447
447
 
@@ -451,7 +451,7 @@ const config: IntlayerConfig = {
451
451
  mainDir: ".intlayer/main",
452
452
 
453
453
  /**
454
- * 設定ファイルが保存されるディレクトリ。
454
+ * コンパイルされた設定ファイルが保存されるディレクトリ。
455
455
  */
456
456
  configDir: ".intlayer/config",
457
457
 
@@ -462,44 +462,44 @@ const config: IntlayerConfig = {
462
462
  },
463
463
 
464
464
  /**
465
- * コンパイラ設定 (高度な使用向け)
465
+ * コンパイラ設定 (高度なユースケース)
466
466
  */
467
467
  compiler: {
468
468
  /**
469
- * コンパイラを有効にするかどうかを指定します。
469
+ * コンパイラを有効にするかどうか。
470
470
  *
471
- * - false: コンパイラを無効にします。
472
- * - true: コンパイラを有効にします。
473
- * - "build-only": 開発中のコンパイラをスキップし、起動速度を上げます。
471
+ * - false: コンパイラを無効にする。
472
+ * - true: コンパイラを有効にする。
473
+ * - "build-only": 起動時間を短縮するため、開発中はコンパイラをスキップする。
474
474
  *
475
475
  * デフォルト: false
476
476
  */
477
477
  enabled: true,
478
478
 
479
479
  /**
480
- * 出力ファイルのパスを定義します。`outputDir` を置き換えます。
480
+ * 出力ファイルのパスを定義します。`outputDir` を上書きします。
481
481
  *
482
- * - `./` パスはコンポーネントディレクトリを基準に解決されます。
483
- * - `/` パスはプロジェクトルート (`baseDir`) を基準に解決されます。
482
+ * - `./` で始まるパスは、コンポーネントのディレクトリを基準に解決されます。
483
+ * - `/` で始まるパスは、プロジェクトのルート (`baseDir`) を基準に解決されます。
484
484
  *
485
- * - パスに `{{locale}}` 変数を含めると、言語ごとに個別の辞書が作成されます。
485
+ * - パスに `{{locale}}` 変数を含めると、ロケールごとに個別の辞書生成が有効になります。
486
486
  *
487
487
  * 例:
488
488
  * ```ts
489
489
  * {
490
- * // コンポーネントの隣に多言語の .content.ts ファイルを作成
490
+ * // コンポーネントの近くに多言語対応の .content.ts ファイルを作成する
491
491
  * output: ({ fileName, extension }) => `./${fileName}${extension}`,
492
492
  *
493
- * // output: './{{fileName}}{{extension}}', // テンプレート文字列を使用した同等の設定
493
+ * // output: './{{fileName}}{{extension}}', // テンプレート文字列を使用した同等の記述
494
494
  * }
495
495
  * ```
496
496
  *
497
497
  * ```ts
498
498
  * {
499
- * // プロジェクトルートに言語ごとの一元化された JSON を作成
499
+ * // プロジェクトのルートにロケールごとに集約された JSON を作成する
500
500
  * output: ({ key, locale }) => `/locales/${locale}/${key}.content.json`,
501
501
  *
502
- * // output: '/locales/{{locale}}/{{key}}.content.json', // テンプレート文字列を使用した同等の設定
502
+ * // output: '/locales/{{locale}}/{{key}}.content.json', // テンプレート文字列を使用した同等の記述
503
503
  * }
504
504
  * ```
505
505
  *
@@ -510,31 +510,31 @@ const config: IntlayerConfig = {
510
510
  * - `extension`: ファイル拡張子。
511
511
  * - `componentFileName`: コンポーネントファイル名。
512
512
  * - `componentExtension`: コンポーネントファイル拡張子。
513
- * - `format`: 辞書形式。
514
- * - `componentFormat`: コンポーネント辞書形式。
513
+ * - `format`: 辞書フォーマット。
514
+ * - `componentFormat`: コンポーネント辞書フォーマット。
515
515
  * - `componentDirPath`: コンポーネントディレクトリパス。
516
516
  */
517
517
  output: ({ locale, key }) => `compiler/${locale}/${key}.json`,
518
518
 
519
519
  /**
520
- * コンポーネントを変換した後に保存するかどうか。
521
- * これにより、アプリケーションを変換するためにコンパイラを一度だけ実行し、その後削除することができます。
520
+ * 変換後のコンポーネントを保存するかどうか。
521
+ * これにより、コンパイラを一度だけ実行してアプリケーションを変換し、その後削除することが可能になります。
522
522
  */
523
523
  saveComponents: false,
524
524
 
525
525
  /**
526
- * 生成されたファイルにコンテンツのみを挿入します。i18next または ICU MessageFormat 形式の言語ごとの JSON 出力に役立ちます。
526
+ * 生成されたファイルにコンテンツのみを挿入します。ロケールごとの i18next または ICU MessageFormat JSON 出力に有用です。
527
527
  */
528
528
  noMetadata: false,
529
529
 
530
530
  /**
531
531
  * 辞書キープレフィックス
532
532
  */
533
- dictionaryKeyPrefix: "", // 抽出された辞書キーにオプションのプレフィックスを追加
533
+ dictionaryKeyPrefix: "", // 抽出された辞書キーにオプションのプレフィックスを追加します
534
534
  },
535
535
 
536
536
  /**
537
- * 辞書コンテンツを検証するためのカスタムスキーマ。
537
+ * 辞書のコンテンツを検証するためのカスタムスキーマ。
538
538
  */
539
539
  schemas: {
540
540
  "my-schema": z.object({
@@ -555,52 +555,54 @@ export default config;
555
555
 
556
556
  ## 設定リファレンス
557
557
 
558
- 以下のセクションでは、Intlayer で利用可能なさまざまな設定項目について説明します。
558
+ 以下のセクションでは、Intlayer で利用可能なさまざまな設定項目について詳しく説明します。
559
559
 
560
560
  ---
561
561
 
562
- ### 国際化設定 (Internationalization Configuration)
562
+ ### 国際化設定 (Internationalization)
563
563
 
564
- 利用可能なロケールやアプリケーションのデフォルトロケールなど、国際化に関する設定を定義します。
564
+ 使用可能なロケールやアプリケーションのデフォルトロケールなど、国際化に関連する設定を定義します。
565
565
 
566
- | フィールド | 型 | 説明 | 例 | 備考 |
567
- | ----------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
568
- | `locales` | `string[]` | アプリケーションでサポートされるロケールのリスト。デフォルト: `[Locales.ENGLISH]` | `['en', 'fr', 'es']` | |
569
- | `requiredLocales` | `string[]` | アプリケーションにおける必須ロケールのリスト。デフォルト: `[]` | `[]` | 空の場合、`strict` モードではすべてのロケールが必須になります。必須ロケールが `locales` フィールドでも定義されていることを確認してください。 |
570
- | `strictMode` | `string` | TypeScript を使用した堅牢な国際化コンテンツの実装を保証します。デフォルト: `inclusive` | | `"strict"` の場合: `t` 関数は宣言されたすべてのロケールが定義されていることを要求します。欠落しているか未宣言の場合はエラーをスローします。 `"inclusive"` の場合: ロケールの欠落を警告しますが、既存の未宣言ロケールを受け入れます。 `"loose"` の場合: 既存の任意のロケールを受け入れます。 |
571
- | `defaultLocale` | `string` | リクエストされたロケールが見つからない場合にフォールバックとして使用されるデフォルトロケール。デフォルト: `Locales.ENGLISH` | `'en'` | URL、クッキー、またはヘッダーでロケールが指定されていない場合にロケールを決定するために使用されます。 |
566
+ | フィールド | 説明 | | デフォルト | 例 | 備考 |
567
+ | --- | --- | --- | --- | --- | --- |
568
+ | `locales` | アプリケーションでサポートされるロケールのリスト。 | `string[]` | `[Locales.ENGLISH]` | `['en', 'fr', 'es']` | |
569
+ | `requiredLocales` | アプリケーションで必須とされるロケールのリスト。 | `string[]` | `[]` | `[]` | 空の場合、`strict` モードではすべてのロケールが必須になります。<br/>• 必須ロケールが `locales` フィールドにも定義されていることを確認してください。 |
570
+ | `strictMode` | TypeScript を使用して、国際化コンテンツの堅牢な実装を保証します。 | `string` | `'inclusive'` | | `"strict"` の場合: `t` 関数は、宣言されたすべてのロケールが定義されていることを要求します。不足している場合や宣言されていない場合にエラーをスローします。<br/>• `"inclusive"` の場合: ロケールが不足している場合に警告を出しますが、宣言されていない既存のロケールの使用も許可します。<br/>• `"loose"` の場合: 既存のすべてのロケールを受け入れます。 |
571
+ | `defaultLocale` | 要求されたロケールが見つからない場合にフォールバックとして使用されるデフォルトロケール。 | `string` | `Locales.ENGLISH` | `'en'` | URL、Cookie、またはヘッダーでロケールが指定されていない場合にロケールを決定するために使用されます。 |
572
572
 
573
573
  ---
574
574
 
575
- ### エディター設定 (Editor Configuration)
575
+ ### エディタ設定 (Editor)
576
+
577
+ サーバーポートや有効化ステータスなど、組み込みのビジュアルエディタの設定を定義します。
578
+
579
+ | フィールド | 説明 | 型 | デフォルト | 例 | 備考 |
580
+ | --- | --- | --- | --- | --- | --- |
581
+ | `applicationURL` | アプリケーションの URL。 | `string` | `undefined` | `'http://localhost:3000'` <br/> `'https://example.com'` <br/> `process.env.INTLAYER_EDITOR_URL` | • セキュリティ上の理由から、エディタのオリジンを制限するために使用されます。<br/>• `'*'` に設定すると、任意のオリジンからエディタにアクセス可能になります。 |
582
+ | `port` | ビジュアルエディタサーバーが使用するポート。 | `number` | `8000` | | |
583
+ | `editorURL` | エディタサーバーの URL。 | `string` | `'http://localhost:8000'` | `'http://localhost:3000'` <br/> `'https://example.com'` <br/> `process.env.INTLAYER_EDITOR_URL` | • アプリケーションと対話可能なオリジンを制限するために使用されます。<br/>• `'*'` に設定すると、任意のオリジンからアクセス可能になります。<br/>• ポートが変更された場合や、エディタが別のドメインでホストされている場合に設定する必要があります。 |
584
+ | `cmsURL` | Intlayer CMS の URL。 | `string` | `'https://app.intlayer.org'` | `'https://app.intlayer.org'` | |
585
+ | `backendURL` | バックエンドサーバーの URL。 | `string` | `https://back.intlayer.org` | `http://localhost:4000` | |
586
+ | `enabled` | アプリケーションがビジュアルエディタと対話するかどうか。 | `boolean` | `false` | `process.env.NODE_ENV !== 'production'` | • `false` の場合、エディタはアプリケーションと対話できません。<br/>• 特定の環境で無効にすることでセキュリティが向上します。 |
587
+ | `clientId` | intlayer パッケージが oAuth2 を介してバックエンドで認証できるようにします。アクセストークンを取得するには、[intlayer.org/project](https://app.intlayer.org/project) にアクセスしてください。 | `string` &#124; <br/> `undefined` | `undefined` | | 秘密にする必要があるため、環境変数に保存してください。 |
588
+ | `clientSecret` | intlayer パッケージが oAuth2 を介してバックエンドで認証できるようにします。アクセストークンを取得するには、[intlayer.org/project](https://app.intlayer.org/project) にアクセスしてください。 | `string` &#124; <br/> `undefined` | `undefined` | | 秘密にする必要があるため、環境変数に保存してください。 |
589
+ | `dictionaryPriorityStrategy` | ローカル辞書とリモート辞書の両方が存在する場合の、辞書の優先順位戦略。 | `string` | `'local_first'` | `'distant_first'` | • `'distant_first'`: ローカルよりもリモートを優先します。<br/>• `'local_first'`: リモートよりもローカルを優先します。 |
590
+ | `liveSync` | CMS、ビジュアルエディタ、バックエンドでの変更が検出されたときに、アプリサーバーがコンテンツを即座にリロードするかどうか。 | `boolean` | `true` | `true` | • 辞書が追加または更新されると、アプリはページコンテンツを更新します。<br/>• Live Sync はコンテンツを別のサーバーにオフロードするため、パフォーマンスにわずかな影響を与える可能性があります。<br/>• 両方を同じマシンでホストすることをお勧めします。 |
591
+ | `liveSyncPort` | Live Sync サーバーのポート。 | `number` | `4000` | `4000` | |
592
+ | `liveSyncURL` | Live Sync サーバーの URL。 | `string` | `'http://localhost:{liveSyncPort}'` | `'https://example.com'` | デフォルトで localhost を指します。リモートの Live Sync サーバーを使用する場合は変更可能です。 |
576
593
 
577
- サーバーポートやアクティビティ状態など、統合エディターに関連する設定を定義します。
578
-
579
- | フィールド | 型 | 説明 | 例 | 備考 |
580
- | ---------------------------- | ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
581
- | `applicationURL` | `string` | アプリケーションの URL。デフォルト: `''` | `'http://localhost:3000'`, `'https://example.com'`, `process.env.INTLAYER_EDITOR_URL` | セキュリティ上の理由からエディターのオリジンを制限するために使用されます。 `'*'` に設定すると、任意のオリジンからエディターにアクセスできます。 |
582
- | `port` | `number` | ビジュアルエディターサーバーで使用されるポート。デフォルト: `8000` | | |
583
- | `editorURL` | `string` | エディターサーバーの URL。デフォルト: `'http://localhost:8000'` | `'http://localhost:3000'`, `'https://example.com'`, `process.env.INTLAYER_EDITOR_URL` | アプリケーションと対話できるオリジンを制限するために使用されます。 `'*'` に設定すると、任意のオリジンからアクセス可能です。ポートを変更する場合や、エディターが別のドメインでホストされている場合は、設定する必要があります。 |
584
- | `cmsURL` | `string` | Intlayer CMS の URL。デフォルト: `'https://intlayer.org'` | `'https://intlayer.org'` | |
585
- | `backendURL` | `string` | バックエンドサーバーの URL。デフォルト: `https://back.intlayer.org` | `http://localhost:4000` | |
586
- | `enabled` | `boolean` | アプリがビジュアルエディターと対話するかどうかを指定します。デフォルト: `true` | `process.env.NODE_ENV !== 'production'` | `false` の場合、エディターはアプリと対話できません。特定の環境で無効にすることでセキュリティを強化できます。 |
587
- | `clientId` | `string &#124; undefined` | oAuth2 を使用してバックエンドで認証できるようにします。アクセストークンを取得するには、[intlayer.org/project](https://app.intlayer.org/project) にアクセスしてください。デフォルト: `undefined` | | 秘密に保管し、環境変数に保存してください。 |
588
- | `clientSecret` | `string &#124; undefined` | oAuth2 を使用してバックエンドで認証できるようにします。アクセストークンを取得するには、[intlayer.org/project](https://app.intlayer.org/project) にアクセスしてください。デフォルト: `undefined` | | 秘密に保管し、環境変数に保存してください。 |
589
- | `dictionaryPriorityStrategy` | `string` | ローカル辞書とリモート辞書の両方が存在する場合の辞書の優先順位付け戦略。デフォルト: `'local_first'` | `'distant_first'` | `'distant_first'`: ローカルよりもリモートを優先します。 `'local_first'`: リモートよりもローカルを優先します。 |
590
- | `liveSync` | `boolean` | CMS / ビジュアルエディター / バックエンドで変更が検出されたときに、アプリサーバーがコンテンツをホットリロードするかどうかを指定します。デフォルト: `true` | `true` | 辞書が追加または更新されると、アプリはページコンテンツを更新します。ライブ同期はコンテンツを別のサーバーにアウトソーシングするため、パフォーマンスにわずかな影響を与える可能性があります。両方を同じマシンでホストすることをお勧めします。 |
591
- | `liveSyncPort` | `number` | ライブ同期サーバーのポート。デフォルト: `4000` | `4000` | |
592
- | `liveSyncURL` | `string` | ライブ同期サーバーの URL。デフォルト: `'http://localhost:{liveSyncPort}'` | `'https://example.com'` | デフォルトでは localhost を指しますが、リモートのライブ同期サーバーに変更可能です。 |
594
+ ---
593
595
 
594
- ### ルーティング設定 (Routing Configuration)
596
+ ### ルーティング設定 (Routing)
595
597
 
596
- URL 構造、ロケールストレージ、ミドルウェア処理など、ルーティングの動作を制御する設定。
598
+ URL 構造、ロケール保存、ミドルウェア管理など、ルーティングの動作を制御する設定。
597
599
 
598
- | フィールド | 型 | 説明 | 例 | 備考 |
599
- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
600
- | `mode` | `'prefix-no-default' &#124; 'prefix-all' &#124; 'no-prefix' &#124; 'search-params'` | ロケール処理のための URL ルーティングモード。デフォルト: `'prefix-no-default'` | `'prefix-no-default'`: `/dashboard` (en) または `/fr/dashboard` (fr)。 `'prefix-all'`: `/en/dashboard`。 `'no-prefix'`: 他の方法でロケールが処理される。 `'search-params'`: `/dashboard?locale=fr` | クッキーやロケールストレージの管理には影響しません。 |
601
- | `storage` | `false &#124; 'cookie' &#124; 'localStorage' &#124; 'sessionStorage' &#124; 'header' &#124; CookiesAttributes &#124; StorageAttributes &#124; Array` | クライアントにロケールを保存するための構成。デフォルト: `['cookie', 'header']` | `'localStorage'`, `[{ type: 'cookie', name: 'custom-locale', secure: true }]` | 下記の「ストレージオプション」の表を参照してください。 |
602
- | `basePath` | `string` | アプリケーション URL のベースパス。デフォルト: `''` | `'/my-app'` | アプリが `https://example.com/my-app` にある場合、basePath は `'/my-app'` となり、URL は `https://example.com/my-app/en` のようになります。 |
603
- | `rewrite` | `Record<string, StrictModeLocaleMap<string>>` | 特定のパスに対してデフォルトのルーティングモードを上書きするカスタム URL リライトルール。動的パラメータ `[param]` をサポートします。デフォルト: `undefined` | 下記の例を参照 | リライトルールは `mode` よりも優先されます。Next.js および Vite で動作します。 `getLocalizedUrl()` は一致するルールを自動的に適用します。 [カスタム URL リライト](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ja/custom_url_rewrites.md) を参照してください。 |
600
+ | フィールド | 説明 | | デフォルト | 例 | 備考 |
601
+ | --- | --- | --- | --- | --- | --- |
602
+ | `mode` | ロケール管理のための URL ルーティングモード。 | `'prefix-no-default'` &#124; <br/> `'prefix-all'` &#124; <br/> `'no-prefix'` &#124; <br/> `'search-params'` | `'prefix-no-default'` | `'prefix-no-default'`: `/dashboard` (en) または `/fr/dashboard` (fr)。 `'prefix-all'`: `/en/dashboard`。 `'no-prefix'`: ロケールは他の手段で管理されます。 `'search-params'`: `/dashboard?locale=fr` | Cookie やロケール保存の管理には影響しません。 |
603
+ | `storage` | クライアントでのロケール保存の設定。 | `false` &#124; <br/> `'cookie'` &#124; <br/> `'localStorage'` &#124; <br/> `'sessionStorage'` &#124; <br/> `'header'` &#124; <br/> `CookiesAttributes` &#124; <br/> `StorageAttributes` &#124; <br/> `Array` | `['cookie', 'header']` | `'localStorage'` <br/> `[{ type: 'cookie', name: 'custom-locale', secure: true }]` | 下記の「保存オプション」の表を参照してください。 |
604
+ | `basePath` | アプリケーション URL のベースパス。 | `string` | `''` | `'/my-app'` | アプリが `https://example.com/my-app` にある場合、basePath は `'/my-app'` となり、URL は `https://example.com/my-app/en` のようになります。 |
605
+ | `rewrite` | 特定のパスに対してデフォルトのルーティングモードを上書きするカスタム URL リライトルール。動的パラメータ `[param]` をサポートします。 | `Record<string, StrictModeLocaleMap<string>>` | `undefined` | 下記の例を参照してください | リライトルールは `mode` よりも優先されます。<br/>• Next.js および Vite で動作します。<br/>• `getLocalizedUrl()` は一致するルールを自動的に適用します。<br/>• [カスタム URL リライト](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/custom_url_rewrites.md)を参照してください。 |
604
606
 
605
607
  **`rewrite` の例**:
606
608
 
@@ -624,37 +626,37 @@ routing: {
624
626
  }
625
627
  ```
626
628
 
627
- #### ストレージオプション (Storage Options)
629
+ #### 保存オプション (Storage Options)
628
630
 
629
- | 値 | 説明 | 備考 |
630
- | ------------------ | -------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
631
- | `'cookie'` | クッキーにロケールを保存します。クライアント側とサーバー側の両方からアクセス可能です。 | GDPR 準拠のため、適切なユーザーの同意が得られていることを確認してください。 `CookiesAttributes` でカスタマイズ可能です (`{ type: 'cookie', name: 'custom-locale', secure: true, httpOnly: false }`) |
632
- | `'localStorage'` | ブラウザにロケールを保存します。有効期限はありません。クライアント側のみ。 | 明示的にクリアされない限り期限切れになりません。 Intlayer プロキシはアクセスできません。 `StorageAttributes` でカスタマイズ可能です (`{ type: 'localStorage', name: 'custom-locale' }`)|
633
- | `'sessionStorage'` | ページセッションの間、ロケールを保存します。クライアント側のみ。 | タブまたはウィンドウを閉じるとクリアされます。 Intlayer プロキシはアクセスできません。 `StorageAttributes` でカスタマイズ可能です (`{ type: 'sessionStorage', name: 'custom-locale' }`)|
634
- | `'header'` | HTTP ヘッダーを介してロケールを保存または送信します。サーバー側のみ。 | API 呼び出しに役立ちます。クライアント側からはアクセスできません。 `StorageAttributes` でカスタマイズ可能です (`{ type: 'header', name: 'custom-locale' }`)|
631
+ | 値 | 備考 | 説明 |
632
+ | --- | --- | --- |
633
+ | `'cookie'` | GDPR コンプライアンスのため、適切なユーザーの同意を確保してください。<br/>• `CookiesAttributes` (`{ type: 'cookie', name: 'custom-locale', secure: true, httpOnly: false }`) を介してカスタマイズ可能です。 | ロケールを Cookie に保存します。クライアントとサーバーの両方からアクセス可能です。 |
634
+ | `'localStorage'` | 明示的にクリアされない限り期限切れになりません。<br/>• Intlayer プロキシからはアクセスできません。<br/>• `StorageAttributes` (`{ type: 'localStorage', name: 'custom-locale' }`) を介してカスタマイズ可能です。 | ブラウザにロケールを無期限に保存します。クライアントサイドのみ。 |
635
+ | `'sessionStorage'` | タブやウィンドウが閉じられるとクリアされます。<br/>• Intlayer プロキシからはアクセスできません。<br/>• `StorageAttributes` (`{ type: 'sessionStorage', name: 'custom-locale' }`) を介してカスタマイズ可能です。 | ページセッションの間、ロケールを保存します。クライアントサイドのみ。 |
636
+ | `'header'` | API 呼び出しに有用です。<br/>• クライアントサイドからはアクセスできません。<br/>• `StorageAttributes` (`{ type: 'header', name: 'custom-locale' }`) を介してカスタマイズ可能です。 | HTTP ヘッダーを介してロケールを保存または送信します。サーバーサイドのみ。 |
635
637
 
636
- #### クッキー属性 (Cookie Attributes)
638
+ #### Cookie 属性 (Cookies Attributes)
637
639
 
638
- クッキーによるストレージを使用する場合、追加のクッキー属性を設定できます。
640
+ Cookie 保存を使用する場合、追加のアトリビュートを設定できます。
639
641
 
640
- | フィールド | | 説明 |
641
- | ---------- | ------------------------------------- | --------------------------------------------- |
642
- | `name` | `string` | クッキー名。デフォルト: `'INTLAYER_LOCALE'` |
643
- | `domain` | `string` | クッキーのドメイン。デフォルト: `undefined` |
644
- | `path` | `string` | クッキーのパス。デフォルト: `undefined` |
645
- | `secure` | `boolean` | HTTPS を必須にします。デフォルト: `undefined` |
646
- | `httpOnly` | `boolean` | HTTP-only フラグ。デフォルト: `undefined` |
647
- | `sameSite` | `'strict' &#124; 'lax' &#124; 'none'` | SameSite ポリシー。 |
648
- | `expires` | `Date &#124; number` | 有効期限または日数。デフォルト: `undefined` |
642
+ | フィールド | 説明 | |
643
+ | --- | --- | --- |
644
+ | `name` | Cookie の名前。デフォルト: `'INTLAYER_LOCALE'` | `string` |
645
+ | `domain` | Cookie のドメイン。デフォルト: `undefined` | `string` |
646
+ | `path` | Cookie のパス。デフォルト: `undefined` | `string` |
647
+ | `secure` | HTTPS を必須にします。デフォルト: `undefined` | `boolean` |
648
+ | `httpOnly` | HTTP-only フラグ。デフォルト: `undefined` | `boolean` |
649
+ | `sameSite` | SameSite ポリシー。 | `'strict'` &#124; <br/> `'lax'` &#124; <br/> `'none'` |
650
+ | `expires` | 有効期限または日数。デフォルト: `undefined` | `Date` &#124; <br/> `number` |
649
651
 
650
- #### ロケールストレージ属性 (Locale Storage Attributes)
652
+ #### 保存属性 (Storage Attributes)
651
653
 
652
- localStorage または sessionStorage を使用する場合:
654
+ localStorage または sessionStorage を使用する場合。
653
655
 
654
- | フィールド | | 説明 |
655
- | ---------- | ---------------------------------------- | ----------------------------------------------------- |
656
- | `type` | `'localStorage' &#124; 'sessionStorage'` | ストレージの種類。 |
657
- | `name` | `string` | ストレージキーの名前。デフォルト: `'INTLAYER_LOCALE'` |
656
+ | フィールド | 説明 | |
657
+ | --- | --- | --- |
658
+ | `type` | 保存方法のタイプ。 | `'localStorage'` &#124; <br/> `'sessionStorage'` |
659
+ | `name` | 保存キーの名前。デフォルト: `'INTLAYER_LOCALE'` | `string` |
658
660
 
659
661
  #### 設定例
660
662
 
@@ -680,7 +682,7 @@ const config: IntlayerConfig = {
680
682
  export default config;
681
683
  ```
682
684
 
683
- **GDPR 準拠の設定**:
685
+ **GDPR 準拠設定**:
684
686
 
685
687
  ```typescript
686
688
  import { Locales, type IntlayerConfig } from "intlayer";
@@ -712,7 +714,7 @@ const config: IntlayerConfig = {
712
714
  export default config;
713
715
  ```
714
716
 
715
- **検索パラメータモード (Search Parameters Mode)**:
717
+ **検索パラメータモード**:
716
718
 
717
719
  ```typescript
718
720
  import { Locales, type IntlayerConfig } from "intlayer";
@@ -732,7 +734,7 @@ const config: IntlayerConfig = {
732
734
  export default config;
733
735
  ```
734
736
 
735
- **カスタムストレージを使用したプレフィックスなしモード (No Prefix Mode)**:
737
+ **カスタム保存を使用したプレフィックスなしモード**:
736
738
 
737
739
  ```typescript
738
740
  import { Locales, type IntlayerConfig } from "intlayer";
@@ -791,132 +793,166 @@ export default config;
791
793
 
792
794
  ---
793
795
 
794
- ### コンテンツ設定 (Content Configuration)
796
+ ### コンテンツ設定 (Content)
795
797
 
796
- アプリケーション内でのコンテンツの処理に関する設定 (ディレクトリ名、ファイル拡張子、派生設定)。
798
+ ディレクトリ名、ファイル拡張子、派生設定など、アプリケーション内でのコンテンツ管理方法に関連する設定。
797
799
 
798
- | フィールド | 型 | 説明 | 例 | 備考 |
799
- | ---------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | ---------------------------------------------------------------------------------------------------------- |
800
- | `watch` | `boolean` | Intlayer が辞書を再構築するためにコンテンツ宣言ファイルの変更を監視するかどうかを指定します。デフォルト: `process.env.NODE_ENV === 'development'` | | |
801
- | `fileExtensions` | `string[]` | コンテンツ宣言ファイルをスキャンするために使用されるファイル拡張子。デフォルト: `['.content.ts', '.content.js', '.content.mjs', '.content.cjs', '.content.json', '.content.json5', '.content.jsonc']` | `['.content.ts', '.content.js']` | |
802
- | `contentDir` | `string[]` | コンテンツ宣言ファイルが配置されているディレクトリへのパス。デフォルト: `['.']` | `['src/content']` | |
803
- | `codeDir` | `string[]` | アプリケーションのソースコードファイルが配置されているディレクトリへのパス。デフォルト: `['.']` | `['src']` | ビルドを最適化し、コード変換とホットリロードが必要なファイルにのみ適用されるようにするために使用されます。 |
804
- | `excludedPath` | `string[]` | コンテンツスキャンから除外されるパス。デフォルト: `['node_modules', '.intlayer', '.next', 'dist', 'build']` | `['src/styles']` | |
805
- | `formatCommand` | `string` | 新しく作成または更新されたコンテンツファイルをフォーマットするために実行されるコマンド。デフォルト: `undefined` | `'npx prettier --write "{{file}}"'` | コンテンツ抽出時やビジュアルエディターを介して使用されます。 |
800
+ | フィールド | 説明 | | デフォルト | 例 | 備考 |
801
+ | --- | --- | --- | --- | --- | --- |
802
+ | `watch` | Intlayer がコンテンツ宣言ファイルの変更を監視して辞書を再生成するかどうか。 | `boolean` | `true` | | |
803
+ | `fileExtensions` | 辞書をコンパイルする際にスキャンするファイル拡張子。 | `string[]` | `['.content.ts', '.content.js', '.content.cjs', '.content.mjs', '.content.json', '.content.json5', '.content.jsonc', '.content.tsx', '.content.jsx']` | `['.data.ts', '.data.js', '.data.json']` | カスタマイズすることで競合を回避できる場合があります。 |
804
+ | `contentDir` | コンテンツ定義ファイル (`.content.*`) が保存されているディレクトリパス。 | `string[]` | `['.']` | `['src', '../../ui-library', require.resolve("@my-package/content")]` | コンテンツファイルの監視と辞書の再生成に使用されます。 |
805
+ | `codeDir` | コードが保存されているベースディレクトリからの相対ディレクトリパス。 | `string[]` | `['.']` | `['src', '../../ui-library']` | コード変換 (プルーニング、最適化) のためにコードファイルを監視するために使用されます。<br/>• `contentDir` と分離することでパフォーマンスが向上する場合があります。 |
806
+ | `excludedPath` | コンテンツスキャンから除外するディレクトリ。 | `string[]` | `['**/node_modules/**', '**/dist/**', '**/build/**', '**/.intlayer/**', '**/.next/**', '**/.nuxt/**', '**/.expo/**', '**/.vercel/**', '**/.turbo/**', '**/.tanstack/**']` | | 未使用。将来の実装のために計画されています。 |
807
+ | `formatCommand` | Intlayer がローカルにファイルを書き込む際のコンテンツファイルのフォーマッタコマンド。 | `string` | `undefined` | `'npx prettier --write "{{file}}" --log-level silent'` (Prettier), `'npx biome format "{{file}}" --write --log-level none'` (Biome), `'npx eslint --fix "{{file}}" --quiet'` (ESLint) | • `{{file}}` はファイルパスに置き換えられます。<br/>• 未定義の場合、Intlayer は自動的に検出を試みます (prettier、biome、eslint をテスト)。 |
806
808
 
807
809
  ---
808
810
 
809
- ### 辞書設定 (Dictionary Configuration)
810
-
811
- 自動入力動作やコンテンツ生成など、辞書操作を制御する設定。
812
-
813
- この辞書設定には、主に 2 つの目的があります:
814
-
815
- 1. **デフォルト値**: コンテンツ宣言ファイルを作成する際のデフォルト値を定義します。
816
- 2. **フォールバック動作**: 特定のフィールドが定義されていない場合にフォールバック値を提供し、辞書操作の動作をグローバルに定義できるようにします。
817
-
818
- コンテンツ宣言ファイルと設定値の適用方法の詳細については、[コンテンツファイルのドキュメント](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ja/dictionary/content_file.md)を参照してください。
819
-
820
- | フィールド | | 説明 | | 備考 |
821
- | --------------------------- | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ | -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
822
- | `fill` | `boolean &#124; FilePathPattern &#124; Partial<Record<Locale, boolean &#124; FilePathPattern>>` | 自動入力(AI 翻訳)出力ファイルの生成方法を制御します。デフォルト: `true` | 下記の例を参照 | `true`: デフォルトパス(ソースと同じファイル)。 `false`: 無効。文字列/関数テンプレートはロケールごとにファイルを生成します。ロケールごとのオブジェクト:各ロケールが独自のパターンにマップされます。 `false` はそのロケールをスキップします。 `{{locale}}` を含めると、ロケールごとの生成がトリガーされます。辞書レベルの `fill` は、常にこのグローバル設定よりも優先されます。 |
823
- | `importMode` | `'static' &#124; 'dynamic' &#124; 'fetch'` | 辞書のインポート方法を制御します。デフォルト: `'static'` | `'dynamic'` | `'static'`: 静的にインポートされます。 `'dynamic'`: Suspense を使用して動的にインポートされます。 `'fetch'`: Live Sync API を介して動的に取得されます。 `getIntlayer`, `getDictionary`, `useDictionary` などには影響しません。 |
824
- | `location` | `'local' &#124; 'remote' &#124; 'hybrid' &#124; string` | 辞書の保存場所。デフォルト: `'local'` | `'remote'` | `'local'`: ファイルシステム。 `'remote'`: Intlayer CMS。 `'hybrid'`: 両方。 |
825
- | `contentAutoTransformation` | `boolean` | コンテンツファイルを自動的に変換するかどうか (例: Markdown から HTML)。デフォルト: `false` | `true` | @intlayer/markdown を介して Markdown フィールドを処理するのに役立ちます。 |
811
+ ### 辞書設定 (Dictionary)
812
+
813
+ 自動入力動作やコンテンツ生成など、辞書操作を制御するパラメータ。
814
+
815
+ | フィールド | 説明 | 型 | デフォルト | 例 | 備考 |
816
+ | --- | --- | --- | --- | --- | --- |
817
+ | `fill` | 自動入力 (AI 翻訳) の出力ファイルがどのように生成されるかを制御します。 | `boolean` &#124; <br/> `FilePathPattern` &#124; <br/> `Partial<Record<Locale, boolean &#124; FilePathPattern>>` | `true` | `{ en: '/locales/en/{{key}}.json', fr: ({ key }) => '/locales/fr/${key}.json', es: false }` | • `true`: デフォルトパス (ソースと同じファイル)。<br/>• `false`: 無効化。<br/>• 文字列/関数パターンは、ロケールごとのファイルを生成します。<br/>• ロケールごとのオブジェクト: 各ロケールが独自のパターンに対応します。`false` はそのロケールを無視します。<br/>• `{{locale}}` を含めると、ロケールごとの生成がトリガーされます。<br/>• 辞書レベルの `fill` は、常にこのグローバル設定よりも優先されます。 |
818
+ | `description` | エディタや CMS が辞書の目的を理解するのに役立ちます。AI による翻訳生成のコンテキストとしても使用されます。 | `string` | `undefined` | `'User profile section'` | |
819
+ | `locale` | 辞書をロケールごとの形式に変換します。宣言された各フィールドが翻訳ノードになります。存在しない場合、辞書は多言語対応として扱われます。 | `LocalesValues` | `undefined` | `'en'` | 辞書が複数の言語の翻訳を含むのではなく、特定のロケール専用である場合に使用します。 |
820
+ | `contentAutoTransformation` | コンテンツの文字列を型付きノード (markdown, HTML, または insertion) に自動変換します。 | `boolean` &#124; <br/> `{ markdown?: boolean; html?: boolean; insertion?: boolean }` | `false` | `true` | • Markdown : `### Title` → `md('### Title')`。<br/>• HTML : `<div>Title</div>` → `html('<div>Title</div>')`。<br/>• 挿入 (Insertion) : `Hello {{name}}` → `insert('Hello {{name}}')`。 |
821
+ | `location` | 辞書ファイルの保存場所と CMS との同期方法を指定します。 | `'local'` &#124; <br/> `'remote'` &#124; <br/> `'hybrid'` &#124; <br/> `'plugin'` &#124; <br/> `string` | `'local'` | `'hybrid'` | • `'local'`: ローカルでのみ管理。<br/>• `'remote'`: リモート (CMS) でのみ管理。<br/>• `'hybrid'`: ローカルとリモートの両方で管理。<br/>• `'plugin'` またはカスタム文字列: プラグインやカスタムソースによって管理。 |
822
+ | `importMode` | 辞書のインポート方法を制御します。 | `'static'` &#124; <br/> `'dynamic'` &#124; <br/> `'fetch'` | `'static'` | `'dynamic'` | • `'static'`: 静的インポート。<br/>• `'dynamic'`: Suspense を介した動的インポート。<br/>• `'fetch'`: Live Sync API を介して取得。失敗した場合は `'dynamic'` にフォールバック。<br/>• `@intlayer/babel` および `@intlayer/swc` プラグインが必要。<br/>• キーは静的に宣言される必要があります。<br/>• `optimize` がオフの場合は無視されます。<br/>• `getIntlayer`、`getDictionary` などには影響しません。 |
823
+ | `priority` | 辞書の優先順位。辞書間の競合を解決する際、高い値が低い値に優先されます。 | `number` | `undefined` | `1` | |
824
+ | `live` | 非推奨 代わりに `importMode: 'fetch'` を使用してください。辞書コンテンツを Live Sync API を介して動的に取得するかどうかを指定していました。 | `boolean` | `undefined` | | v8.0.0 `importMode: 'fetch'` に名前変更。 |
825
+ | `schema` | JSON スキーマ検証のために Intlayer によって自動生成されます。 | `'https://intlayer.org/schema.json'` | 自動生成 | | 手動で編集しないでください。 |
826
+ | `title` | エディタや CMS で辞書を識別するのに役立ちます。 | `string` | `undefined` | `'User Profile'` | |
827
+ | `tags` | 辞書をカテゴリ化し、エディタや AI にコンテキストや指示を提供します。 | `string[]` | `undefined` | `['user', 'profile']` | |
828
+ | `version` | リモート辞書のバージョン。現在使用されているバージョンを追跡するのに役立ちます。 | `string` | `undefined` | `'1.0.0'` | • CMS で管理可能。<br/>• ローカルで編集しないでください。 |
826
829
 
827
830
  **`fill` の例**:
828
831
 
829
832
  ```ts
830
833
  dictionary: {
831
834
  fill: {
832
- en: '/locales/en/{{key}}.content.json',
835
+ en: "/locales/en/{{key}}.content.json",
833
836
  fr: ({ key }) => `/locales/fr/${key}.content.json`,
834
837
  es: false,
835
- }
836
- }
838
+ },
839
+ };
837
840
  ```
838
841
 
839
842
  ---
840
843
 
841
- ### AI 設定 (AI Configuration)
844
+ ### ロガー設定 (Logger)
842
845
 
843
- 翻訳構築などの Intlayer の AI 搭載機能の設定を定義します。
846
+ Intlayer からのログ出力をカスタマイズするためのパラメータ。
844
847
 
845
- | フィールド | 型 | 説明 | 例 | 備考 |
846
- | -------------------- | ---------------------- | --------------------------------------------------------------- | ------------------------------------------- | ------------------------------------------------------------------------------------------------- |
847
- | `provider` | `string` | 使用する AI プロバイダー。 | `'openai'`, `'anthropic'`, `'googlevertex'` | |
848
- | `model` | `string` | 使用する AI モデル。 | `'gpt-4o'`, `'claude-3-5-sonnet-20240620'` | |
849
- | `apiKey` | `string` | 選択したプロバイダーの API キー。 | `process.env.OPENAI_API_KEY` | |
850
- | `applicationContext` | `string` | AI 翻訳の精度を向上させるためのアプリに関する追加コンテキスト。 | `'子供向けの学習プラットフォーム。'` | |
851
- | `baseURL` | `string` | API 呼び出し用のオプションのベース URL。 | | プロキシやローカル AI デプロイメントを使用している場合に役立ちます。 |
852
- | `dataSerialization` | `'json' &#124; 'toon'` | AI にデータを送信する方法を定義します。デフォルト: `'json'` | `'json'` | `'json'`: より堅牢で正確。 `'toon'`: トークンの消費は少ないですが、安定性に欠ける場合があります。 |
848
+ | フィールド | 説明 | | デフォルト | 例 | 備考 |
849
+ | --- | --- | --- | --- | --- | --- |
850
+ | `mode` | ロガーのモードを指定します。 | `'default'` &#124; <br/> `'verbose'` &#124; <br/> `'disabled'` | `'default'` | `'verbose'` | • `'verbose'`: デバッグ用により多くの情報を出力します。<br/>• `'disabled'`: ロガーを完全に無効にします。 |
851
+ | `prefix` | ログメッセージのプレフィックス。 | `string` | `'[intlayer] '` | `'[my prefix] '` | |
853
852
 
854
853
  ---
855
854
 
856
- ### ビルド設定 (Build Configuration)
855
+ ### AI 設定 (AI)
856
+
857
+ プロバイダー、モデル、API キーなど、Intlayer の AI 機能を制御する設定。
858
+
859
+ アクセストークンを使用して [Intlayer ダッシュボード](https://app.intlayer.org/project) に登録されている場合、この設定はオプションです。Intlayer は、ニーズに合わせて最も効率的で費用対効果の高い AI ソリューションを自動的に管理します。デフォルトのオプションを使用することで、Intlayer が常に最適なモデルを使用するように更新されるため、長期的なメンテナンス性が向上します。
860
+
861
+ 独自の API キーや特定のモデルを使用したい場合は、カスタム AI 設定を定義できます。
862
+ この AI 設定は、Intlayer 環境内でグローバルに使用されます。CLI コマンド (例: `fill`) はデフォルトでこれらの設定を使用します。また、SDK、ビジュアルエディタ、CMS も同様です。コマンドパラメータを介して、特定のユースケースに対してこれらのデフォルト値を上書きできます。
863
+
864
+ Intlayer は、柔軟性を最大限に高めるために複数の AI プロバイダーをサポートしています。現在サポートされているプロバイダーは次のとおりです。
865
+
866
+ - **OpenAI** (デフォルト)
867
+ - **Anthropic Claude**
868
+ - **Mistral AI**
869
+ - **DeepSeek**
870
+ - **Google Gemini**
871
+ - **Google AI Studio**
872
+ - **Google Vertex**
873
+ - **Meta Llama**
874
+ - **Ollama**
875
+ - **OpenRouter**
876
+ - **Alibaba Cloud**
877
+ - **Fireworks**
878
+ - **Hugging Face**
879
+ - **Groq**
880
+ - **Amazon Bedrock**
881
+ - **Together.ai**
882
+
883
+ | フィールド | 説明 | 型 | デフォルト | 例 | 備考 |
884
+ | --- | --- | --- | --- | --- | --- |
885
+ | `provider` | Intlayer の AI 機能に使用するプロバイダー。 | `'openai'` &#124; <br/> `'anthropic'` &#124; <br/> `'mistral'` &#124; <br/> `'deepseek'` &#124; <br/> `'gemini'` &#124; <br/> `'ollama'` &#124; <br/> `'openrouter'` &#124; <br/> `'alibaba'` &#124; <br/> `'fireworks'` &#124; <br/> `'groq'` &#124; <br/> `'huggingface'` &#124; <br/> `'bedrock'` &#124; <br/> `'googleaistudio'` &#124; <br/> `'googlevertex'` &#124; <br/> `'togetherai'` | `undefined` | `'anthropic'` | プロバイダーによって、必要な API キーや価格が異なります。 |
886
+ | `model` | AI 機能に使用するモデル。 | `string` | なし | `'gpt-4o-2024-11-20'` | 特定のモデルはプロバイダーによって異なります。 |
887
+ | `temperature` | AI の応答のランダム性を制御します。 | `number` | なし | `0.1` | 温度が高いほど、創造的で予測しにくくなります。 |
888
+ | `apiKey` | 選択したプロバイダーの API キー。 | `string` | なし | `process.env.OPENAI_API_KEY` | 秘密にする必要があるため、環境変数に保存してください。 |
889
+ | `applicationContext` | AI がより正確な翻訳を生成できるようにするための、アプリケーションに関する追加のコンテキスト (ドメイン、ターゲットオーディエンス、トーン、用語)。 | `string` | なし | `'旅行予約アプリのコンテキスト'` | ルールを追加するためにも使用できます (例: `"URL を変換しないでください"`)。 |
890
+ | `baseURL` | AI API のベース URL。 | `string` | なし | `'https://api.openai.com/v1'` <br/> `'http://localhost:5000'` | ローカルまたはカスタムの AI API エンドポイントを指すことができます。 |
891
+ | `dataSerialization` | AI 機能のデータシリアライゼーション形式。 | `'json'` &#124; <br/> `'toon'` | `undefined` | `'toon'` | • `'json'`: デフォルト、信頼性が高いがトークン消費が多い。<br/>• `'toon'`: トークン消費が少ないが、一貫性に欠ける。<br/>• 推論の努力 (reasoning effort) などの追加パラメータがコンテキストとしてモデルに渡されます。 |
857
892
 
858
- Intlayer のビルドプロセスと最適化に関する設定。
893
+ ---
859
894
 
860
- | フィールド | 型 | 説明 | 例 | 備考 |
861
- | -------------- | ------------------------ | ---------------------------------------------------------------------------------------------------- | --- | ---- |
862
- | `mode` | `'auto' &#124; 'manual'` | アプリのプリビルドステップ中に Intlayer を自動的に実行するかどうかを指定します。デフォルト: `'auto'` | | |
863
- | `optimize` | `boolean` | コンパイルされた辞書を実行時用に最適化するかどうかを指定します。デフォルト: 本番環境では `true` | | |
864
- | `outputFormat` | `('cjs' &#124; 'esm')[]` | 生成された辞書ファイルの出力形式。デフォルト: `['cjs', 'esm']` | | |
865
- | `checkTypes` | `boolean` | Intlayer が生成されたファイルの型をチェックするかどうかを指定します。デフォルト: `false` | | |
895
+ ### ビルド設定 (Build)
866
896
 
867
- ---
897
+ Intlayer がアプリケーションの国際化をどのように最適化およびコンパイルするかを制御するパラメータ。
898
+
899
+ ビルドオプションは、`@intlayer/babel` および `@intlayer/swc` プラグインに適用されます。
868
900
 
869
- ### システム設定 (System Configuration)
901
+ > 開発モードでは、Intlayer は開発体験を簡素化するために辞書の静的インポートを使用します。
870
902
 
871
- これらは高度なユースケースおよび Intlayer の内部構成用の設定です。
903
+ > 最適化中、Intlayer はチャンキングを最適化するために辞書の呼び出しを置き換え、最終的なバンドルが実際に使用される辞書のみをインポートするようにします。
872
904
 
873
- | フィールド | | 説明 | デフォルト |
874
- | ------------------------- | -------- | -------------------------------------------- | --------------------------------- |
875
- | `dictionariesDir` | `string` | コンパイルされた辞書のディレクトリ。 | `'.intlayer/dictionary'` |
876
- | `moduleAugmentationDir` | `string` | TypeScript モジュール拡張ディレクトリ。 | `'.intlayer/types'` |
877
- | `unmergedDictionariesDir` | `string` | マージされていない辞書のディレクトリ。 | `'.intlayer/unmerged_dictionary'` |
878
- | `typesDir` | `string` | 生成された型のディレクトリ。 | `'.intlayer/types'` |
879
- | `mainDir` | `string` | メインの Intlayer ファイルディレクトリ。 | `'.intlayer/main'` |
880
- | `configDir` | `string` | コンパイルされた設定ファイルのディレクトリ。 | `'.intlayer/config'` |
881
- | `cacheDir` | `string` | キャッシュファイルのディレクトリ。 | `'.intlayer/cache'` |
905
+ | フィールド | 説明 | 型 | デフォルト | 例 | 備考 |
906
+ | --- | --- | --- | --- | --- | --- |
907
+ | `mode` | ビルドモードを制御します。 | `'auto'` &#124; <br/> `'manual'` | `'auto'` | `'manual'` | • `'auto'`: アプリのビルド中にビルドが自動的にトリガーされます。<br/>• `'manual'`: ビルドコマンドが明示的に呼び出されたときにのみ実行されます。<br/>• 辞書のビルドを無効にするためにも使用できます (例: Node.js 環境での実行を停止する場合)。 |
908
+ | `optimize` | ビルドの最適化を行うかどうかを制御します。 | `boolean` | `undefined` | `process.env.NODE_ENV === 'production'` | • 未定義の場合、フレームワークのビルド (Vite/Next.js) 時に最適化がトリガーされます。<br/>• `true` の場合、開発モードでも強制的に最適化を行います。<br/>• `false` の場合、無効化されます。<br/>• 有効な場合、チャンキングを最適化するために辞書の呼び出しを置き換えます。<br/>• `@intlayer/babel` および `@intlayer/swc` プラグインが必要。 |
909
+ | `checkTypes` | ビルド時に TypeScript の型チェックを行い、エラーを記録するかどうかを指定します。 | `boolean` | `false` | | ビルドプロセスが遅くなる可能性があります。 |
910
+ | `outputFormat` | 辞書の出力形式を制御します。 | `('esm' &#124; 'cjs')[]` | `['esm', 'cjs']` | `['cjs']` | |
911
+ | `traversePattern` | 最適化中にスキャンするファイルを定義するパターン。 | `string[]` | `['**/*.{tsx,ts,js,mjs,cjs,jsx,vue,svelte,svte}', '!**/node_modules/**', '!**/dist/**', '!**/.intlayer/**', '!**/*.config.*', '!**/*.test.*', '!**/*.spec.*', '!**/*.stories.*']` | `['src/**/*.{ts,tsx}', '../ui-library/**/*.{ts,tsx}', '!**/node_modules/**']` | • ビルドパフォーマンスを向上させるために、最適化対象を関連するファイルに限定します。<br/>• `optimize` がオフの場合は無視されます。<br/>• glob パターンを使用します。 |
882
912
 
883
913
  ---
884
914
 
885
- ### コンパイラ設定 (Compiler Configuration)
915
+ ### システム設定 (System)
886
916
 
887
- Intlayer コンパイラ (`intlayer compiler`) の設定。
917
+ これらの設定は、高度なユースケースおよび Intlayer の内部設定用です。
888
918
 
889
- | フィールド | | 説明 | デフォルト |
890
- | --------------------- | ------------------------ | -------------------------------------------------------------------------------- | ---------- |
891
- | `enabled` | `boolean` | コンパイラがアクティブかどうかを指定します。 | `false` |
892
- | `output` | `string &#124; Function` | 抽出された辞書の出力パス。 | |
893
- | `saveComponents` | `boolean` | オリジナルのソースファイルを変換後のバージョンで上書きするかどうかを指定します。 | `false` |
894
- | `noMetadata` | `boolean` | `true` の場合、コンパイラは生成されたファイルにメタデータを含めません。 | `false` |
895
- | `dictionaryKeyPrefix` | `string` | オプションの辞書キープレフィックス。 | `''` |
919
+ | フィールド | 説明 | 型 | デフォルト | 例 | 備考 |
920
+ | --- | --- | --- | --- | --- | --- |
921
+ | `dictionariesDir` | コンパイルされた辞書用のディレクトリ。 | `string` | `'.intlayer/dictionary'` | | |
922
+ | `moduleAugmentationDir` | TypeScript のモジュール拡張用ディレクトリ。 | `string` | `'.intlayer/types'` | | |
923
+ | `unmergedDictionariesDir` | マージされていない辞書用のディレクトリ。 | `string` | `'.intlayer/unmerged_dictionary'` | | |
924
+ | `typesDir` | 生成された型用のディレクトリ。 | `string` | `'.intlayer/types'` | | |
925
+ | `mainDir` | Intlayer メインファイル用のディレクトリ。 | `string` | `'.intlayer/main'` | | |
926
+ | `configDir` | コンパイルされた設定ファイル用のディレクトリ。 | `string` | `'.intlayer/config'` | | |
927
+ | `cacheDir` | キャッシュファイル用のディレクトリ。 | `string` | `'.intlayer/cache'` | | |
896
928
 
897
929
  ---
898
930
 
899
- ### ロガー設定 (Logger Configuration)
931
+ ### コンパイラ設定 (Compiler)
900
932
 
901
- Intlayer のログ出力をカスタマイズするための設定。
933
+ コンポーネントから直接辞書を抽出する Intlayer コンパイラを制御する設定。
902
934
 
903
- | フィールド | | 説明 | デフォルト |
904
- | ---------- | ---------------------------------------------- | -------------------------------- | -------------- |
905
- | `mode` | `'default' &#124; 'verbose' &#124; 'disabled'` | ロギングモード。 | `'default'` |
906
- | `prefix` | `string` | ログメッセージのプレフィックス。 | `'[intlayer]'` |
935
+ | フィールド | 説明 | | デフォルト | 例 | 備考 |
936
+ | --- | --- | --- | --- | --- | --- |
937
+ | `enabled` | 辞書の抽出のためにコンパイラを有効にするかどうかを指定します。 | `boolean` &#124; <br/> `'build-only'` | `true` | `'build-only'` | `'build-only'` は起動時間を短縮するため、開発中はコンパイラをスキップします。ビルドコマンドでのみ実行されます。 |
938
+ | `dictionaryKeyPrefix` | 抽出された辞書キーのプレフィックス。 | `string` | `''` | `'my-prefix-'` | 競合を避けるために、(ファイル名に基づいた) 生成されたキーに追加されます。 |
939
+ | `saveComponents` | 変換後のコンポーネントを保存するかどうか。 | `boolean` | `false` | | • `true` の場合、元のファイルを変換後のバージョンで上書きします。<br/>• 実行後、コンパイラを削除することが可能になります。 |
940
+ | `output` | 出力ファイルのパスを定義します。`outputDir` を上書きします。変数テンプレートをサポート: `{{fileName}}`, <br/> `{{key}}`, <br/> `{{locale}}`, <br/> `{{extension}}`, <br/> `{{componentFileName}}`, <br/> `{{componentExtension}}`, <br/> `{{format}}`, <br/> `{{componentFormat}}`, <br/> `{{componentDirPath}}`。 | `boolean` &#124; <br/> `FilePathPattern` &#124; <br/> `Partial<Record<Locale, boolean &#124; FilePathPattern>>` | `undefined` | `'./{{fileName}}{{extension}}'` <br/> `'/locales/{{locale}}/{{key}}.json'` <br/> `{ en: ({ key }) => './locales/en/${key}.json', fr: '...', es: false }` | • `./` はコンポーネントディレクトリ基準。<br/>• `/` はルート基準。<br/>• `{{locale}}` を含めるとロケールごとの生成がトリガーされます。<br/>• ロケールごとのオブジェクト記法をサポート。 |
941
+ | `noMetadata` | `true` の場合、出力から辞書のメタデータ (キー、コンテンツラッパー) を除外します。 | `boolean` | `false` | `false` → `{"key":"my-key","content":{"key":"value"}}` <br/> `true` → `{"key":"value"}` | • i18next や ICU MessageFormat JSON 出力に有用。<br/>• `loadJSON` プラグインと組み合わせて使用。 |
942
+ | `dictionaryKeyPrefix` | 辞書のキープレフィックス | `string` | `''` | | 抽出された辞書キーにオプションのプレフィックスを追加します。 |
907
943
 
908
944
  ---
909
945
 
910
946
  ### カスタムスキーマ (Custom Schemas)
911
947
 
912
- | フィールド | | 説明 |
913
- | ---------- | --------------------------- | ------------------------------------------------------- |
914
- | `schemas` | `Record<string, ZodSchema>` | 辞書の構造を検証するための Zod スキーマを定義できます。 |
948
+ | フィールド | 説明 | |
949
+ | --- | --- | --- |
950
+ | `schemas` | 辞書の構造を検証するための Zod スキーマを定義できます。 | `Record<string, ZodSchema>` |
915
951
 
916
952
  ---
917
953
 
918
954
  ### プラグイン (Plugins)
919
955
 
920
- | フィールド | | 説明 |
921
- | ---------- | ------------------ | ---------------------------------------- |
922
- | `plugins` | `IntlayerPlugin[]` | 有効にする Intlayer プラグインのリスト。 |
956
+ | フィールド | 説明 | |
957
+ | --- | --- | --- |
958
+ | `plugins` | 有効にする Intlayer プラグインのリスト。 | `IntlayerPlugin[]` |