@intlayer/docs 8.4.7 → 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.
- package/docs/ar/configuration.md +958 -0
- package/docs/cs/configuration.md +958 -0
- package/docs/de/configuration.md +958 -0
- package/docs/en-GB/configuration.md +957 -0
- package/docs/es/configuration.md +161 -133
- package/docs/fr/configuration.md +137 -109
- package/docs/it/configuration.md +958 -0
- package/docs/ja/configuration.md +958 -0
- package/docs/nl/configuration.md +958 -0
- package/docs/pt/configuration.md +958 -0
- package/docs/ru/configuration.md +958 -0
- package/docs/tr/configuration.md +958 -0
- package/package.json +6 -6
|
@@ -0,0 +1,958 @@
|
|
|
1
|
+
---
|
|
2
|
+
createdAt: 2024-08-13
|
|
3
|
+
updatedAt: 2026-03-20
|
|
4
|
+
title: 設定 (Configuration)
|
|
5
|
+
description: アプリケーションにIntlayerを設定する方法について説明します。ニーズに合わせてIntlayerをカスタマイズするためのさまざまな設定とオプションを理解してください。
|
|
6
|
+
keywords:
|
|
7
|
+
- 設定
|
|
8
|
+
- セッティング
|
|
9
|
+
- カスタマイズ
|
|
10
|
+
- Intlayer
|
|
11
|
+
- オプション
|
|
12
|
+
slugs:
|
|
13
|
+
- doc
|
|
14
|
+
- concept
|
|
15
|
+
- configuration
|
|
16
|
+
history:
|
|
17
|
+
- version: 8.4.0
|
|
18
|
+
date: 2026-03-20
|
|
19
|
+
changes: 'compiler.output' と 'dictionary.fill' にロケールごとのオブジェクト記法を追加
|
|
20
|
+
- version: 8.3.0
|
|
21
|
+
date: 2026-03-11
|
|
22
|
+
changes: 'baseDir' を 'content' 設定から 'system' 設定に移動
|
|
23
|
+
- version: 8.2.0
|
|
24
|
+
date: 2026-03-09
|
|
25
|
+
changes: コンパイラオプションを更新し、'output' と 'noMetadata' のサポートを追加
|
|
26
|
+
- version: 8.1.7
|
|
27
|
+
date: 2026-02-25
|
|
28
|
+
changes: コンパイラオプションを更新
|
|
29
|
+
- version: 8.1.5
|
|
30
|
+
date: 2026-02-23
|
|
31
|
+
changes: 'build-only' コンパイラオプションと辞書プレフィックスを追加
|
|
32
|
+
- version: 8.0.6
|
|
33
|
+
date: 2026-02-12
|
|
34
|
+
changes: Open Router, Alibaba, Amazon, Google Vertex Bedrock, Fireworks, Groq, Hugging Face, Together.ai プロバイダーのサポートを追加
|
|
35
|
+
- version: 8.0.5
|
|
36
|
+
date: 2026-02-06
|
|
37
|
+
changes: AI設定に `dataSerialization` を追加
|
|
38
|
+
- version: 8.0.0
|
|
39
|
+
date: 2026-01-24
|
|
40
|
+
changes: 基盤となるメカニズムをより正確に表すため、`live` インポートモードを `fetch` に名前変更。
|
|
41
|
+
- version: 8.0.0
|
|
42
|
+
date: 2026-01-22
|
|
43
|
+
changes: `importMode` ビルド設定を `dictionary` 設定に移動。
|
|
44
|
+
- version: 8.0.0
|
|
45
|
+
date: 2026-01-22
|
|
46
|
+
changes: ルーティング設定に `rewrite` オプションを追加
|
|
47
|
+
- version: 8.0.0
|
|
48
|
+
date: 2026-01-18
|
|
49
|
+
changes: コンテンツ設定からシステム設定を分離。内部パスを `system` プロパティに移動。コンテンツファイルとコード変換を分離するため `codeDir` を追加。
|
|
50
|
+
- version: 8.0.0
|
|
51
|
+
date: 2026-01-18
|
|
52
|
+
changes: `location` と `schema` 辞書オプションを追加
|
|
53
|
+
- version: 7.5.1
|
|
54
|
+
date: 2026-01-10
|
|
55
|
+
changes: JSON5 および JSONC ファイル形式のサポートを追加
|
|
56
|
+
- version: 7.5.0
|
|
57
|
+
date: 2025-12-17
|
|
58
|
+
changes: `buildMode` オプションを追加
|
|
59
|
+
- version: 7.0.0
|
|
60
|
+
date: 2025-10-25
|
|
61
|
+
changes: `dictionary` 設定を追加
|
|
62
|
+
- version: 7.0.0
|
|
63
|
+
date: 2025-10-21
|
|
64
|
+
changes: `middleware` を `routing` 設定に置き換え
|
|
65
|
+
- version: 7.0.0
|
|
66
|
+
date: 2025-10-12
|
|
67
|
+
changes: `formatCommand` オプションを追加
|
|
68
|
+
- version: 6.2.0
|
|
69
|
+
date: 2025-10-12
|
|
70
|
+
changes: `excludedPath` オプションを更新
|
|
71
|
+
- version: 6.0.2
|
|
72
|
+
date: 2025-09-23
|
|
73
|
+
changes: `outputFormat` オプションを追加
|
|
74
|
+
- version: 6.0.0
|
|
75
|
+
date: 2025-09-21
|
|
76
|
+
changes: `dictionaryOutput` フィールドと `i18nextResourcesDir` フィールドを削除
|
|
77
|
+
- version: 6.0.0
|
|
78
|
+
date: 2025-09-16
|
|
79
|
+
changes: `live` インポートモードを追加
|
|
80
|
+
- version: 6.0.0
|
|
81
|
+
date: 2025-09-04
|
|
82
|
+
changes: `hotReload` フィールドを `liveSync` に置き換え、`liveSyncPort` と `liveSyncURL` フィールドを追加
|
|
83
|
+
- version: 5.6.1
|
|
84
|
+
date: 2025-07-25
|
|
85
|
+
changes: `activateDynamicImport` を `importMode` オプションに置き換え
|
|
86
|
+
- version: 5.6.0
|
|
87
|
+
date: 2025-07-13
|
|
88
|
+
changes: デフォルトの `contentDir` を `['src']` から `['.']` に変更
|
|
89
|
+
- version: 5.5.11
|
|
90
|
+
date: 2025-06-29
|
|
91
|
+
changes: `docs` コマンドを追加
|
|
92
|
+
---
|
|
93
|
+
|
|
94
|
+
# Intlayer 設定ドキュメント
|
|
95
|
+
|
|
96
|
+
## 概要
|
|
97
|
+
|
|
98
|
+
Intlayer 設定ファイルを使用すると、国際化、ミドルウェア、コンテンツ管理など、プラグインのさまざまな側面をカスタマイズできます。このドキュメントでは、設定内の各プロパティの詳細な説明を提供します。
|
|
99
|
+
|
|
100
|
+
---
|
|
101
|
+
|
|
102
|
+
## 目次
|
|
103
|
+
|
|
104
|
+
<TOC/>
|
|
105
|
+
|
|
106
|
+
---
|
|
107
|
+
|
|
108
|
+
## 設定ファイルのサポート
|
|
109
|
+
|
|
110
|
+
Intlayer は、JSON、JS、MJS、および TS の設定ファイル形式をサポートしています。
|
|
111
|
+
|
|
112
|
+
- `intlayer.config.ts`
|
|
113
|
+
- `intlayer.config.js`
|
|
114
|
+
- `intlayer.config.json`
|
|
115
|
+
- `intlayer.config.json5`
|
|
116
|
+
- `intlayer.config.jsonc`
|
|
117
|
+
- `intlayer.config.cjs`
|
|
118
|
+
- `intlayer.config.mjs`
|
|
119
|
+
- `.intlayerrc`
|
|
120
|
+
|
|
121
|
+
---
|
|
122
|
+
|
|
123
|
+
## 設定ファイルの例
|
|
124
|
+
|
|
125
|
+
````typescript fileName="intlayer.config.ts" codeFormat="typescript"
|
|
126
|
+
import { Locales, type IntlayerConfig } from "intlayer";
|
|
127
|
+
import { nextjsRewrite } from "intlayer/routing";
|
|
128
|
+
import { z } from "zod";
|
|
129
|
+
|
|
130
|
+
/**
|
|
131
|
+
* 利用可能なすべてのオプションを示す Intlayer 設定ファイルの例。
|
|
132
|
+
*/
|
|
133
|
+
const config: IntlayerConfig = {
|
|
134
|
+
/**
|
|
135
|
+
* 国際化設定。
|
|
136
|
+
*/
|
|
137
|
+
internationalization: {
|
|
138
|
+
/**
|
|
139
|
+
* アプリケーションでサポートされるロケールのリスト。
|
|
140
|
+
* デフォルト: [Locales.ENGLISH]
|
|
141
|
+
*/
|
|
142
|
+
locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
|
|
143
|
+
|
|
144
|
+
/**
|
|
145
|
+
* 各辞書で定義する必要がある必須ロケールのリスト。
|
|
146
|
+
* 空の場合、`strict` モードですべてのロケールが必須になります。
|
|
147
|
+
* デフォルト: []
|
|
148
|
+
*/
|
|
149
|
+
requiredLocales: [Locales.ENGLISH],
|
|
150
|
+
|
|
151
|
+
/**
|
|
152
|
+
* 国際化されたコンテンツの厳密レベル。
|
|
153
|
+
* - "strict": 宣言されたロケールが欠落している、または宣言されていない場合にエラーをスローします。
|
|
154
|
+
* - "inclusive": 宣言されたロケールが欠落している場合に警告をスローします。
|
|
155
|
+
* - "loose": 既存のロケールをすべて受け入れます。
|
|
156
|
+
* デフォルト: "inclusive"
|
|
157
|
+
*/
|
|
158
|
+
strictMode: "inclusive",
|
|
159
|
+
|
|
160
|
+
/**
|
|
161
|
+
* 要求されたロケールが見つからない場合にフォールバックとして使用されるデフォルトロケール。
|
|
162
|
+
* デフォルト: Locales.ENGLISH
|
|
163
|
+
*/
|
|
164
|
+
defaultLocale: Locales.ENGLISH,
|
|
165
|
+
},
|
|
166
|
+
|
|
167
|
+
/**
|
|
168
|
+
* 辞書操作とフォールバック動作を制御する設定。
|
|
169
|
+
*/
|
|
170
|
+
dictionary: {
|
|
171
|
+
/**
|
|
172
|
+
* 辞書のインポート方法を制御します。
|
|
173
|
+
* - "static": ビルド時に静的にインポートされます。
|
|
174
|
+
* - "dynamic": Suspense を使用して動的にインポートされます。
|
|
175
|
+
* - "fetch": Live Sync API を介して動的に取得されます。
|
|
176
|
+
* デフォルト: "static"
|
|
177
|
+
*/
|
|
178
|
+
importMode: "static",
|
|
179
|
+
|
|
180
|
+
/**
|
|
181
|
+
* AI を使用して欠落している翻訳を自動入力する戦略。
|
|
182
|
+
* ブール値、または入力されたコンテンツを保存するパスパターン。
|
|
183
|
+
* デフォルト: true
|
|
184
|
+
*/
|
|
185
|
+
fill: true,
|
|
186
|
+
|
|
187
|
+
/**
|
|
188
|
+
* 辞書ファイルの物理的な場所。
|
|
189
|
+
* - "local": ローカルファイルシステムに保存されます。
|
|
190
|
+
* - "remote": Intlayer CMS に保存されます。
|
|
191
|
+
* - "hybrid": ローカルファイルシステムと Intlayer CMS の両方に保存されます。
|
|
192
|
+
* - "plugin" (または任意のカスタム文字列): プラグインやカスタムソースによって提供されます。
|
|
193
|
+
* デフォルト: "local"
|
|
194
|
+
*/
|
|
195
|
+
location: "local",
|
|
196
|
+
|
|
197
|
+
/**
|
|
198
|
+
* コンテンツを自動的に変換するかどうか (例: Markdown から HTML)。
|
|
199
|
+
* デフォルト: false
|
|
200
|
+
*/
|
|
201
|
+
contentAutoTransformation: false,
|
|
202
|
+
},
|
|
203
|
+
|
|
204
|
+
/**
|
|
205
|
+
* ルーティングとミドルウェアの設定。
|
|
206
|
+
*/
|
|
207
|
+
routing: {
|
|
208
|
+
/**
|
|
209
|
+
* ロケールルーティング戦略。
|
|
210
|
+
* - "prefix-no-default": デフォルト以外のすべてのロケールにプレフィックスを付けます (例: /dashboard, /fr/dashboard)。
|
|
211
|
+
* - "prefix-all": すべてのロケールにプレフィックスを付けます (例: /en/dashboard, /fr/dashboard)。
|
|
212
|
+
* - "no-prefix": URL にロケールを含めません。
|
|
213
|
+
* - "search-params": ?locale=... を使用します。
|
|
214
|
+
* デフォルト: "prefix-no-default"
|
|
215
|
+
*/
|
|
216
|
+
mode: "prefix-no-default",
|
|
217
|
+
|
|
218
|
+
/**
|
|
219
|
+
* ユーザーが選択したロケールを保存する場所。
|
|
220
|
+
* オプション: 'cookie', 'localStorage', 'sessionStorage', 'header', またはそれらの配列。
|
|
221
|
+
* デフォルト: ['cookie', 'header']
|
|
222
|
+
*/
|
|
223
|
+
storage: ["cookie", "header"],
|
|
224
|
+
|
|
225
|
+
/**
|
|
226
|
+
* アプリケーション URL のベースパス。
|
|
227
|
+
* デフォルト: ""
|
|
228
|
+
*/
|
|
229
|
+
basePath: "",
|
|
230
|
+
|
|
231
|
+
/**
|
|
232
|
+
* 特定のロケールパスに対するカスタム URL リライトルール。
|
|
233
|
+
*/
|
|
234
|
+
rewrite: nextjsRewrite({
|
|
235
|
+
"/[locale]/about": {
|
|
236
|
+
en: "/[locale]/about",
|
|
237
|
+
fr: "/[locale]/a-propos",
|
|
238
|
+
},
|
|
239
|
+
}),
|
|
240
|
+
},
|
|
241
|
+
|
|
242
|
+
/**
|
|
243
|
+
* コンテンツファイルの検索と処理に関する設定。
|
|
244
|
+
*/
|
|
245
|
+
content: {
|
|
246
|
+
/**
|
|
247
|
+
* 辞書をスキャンするファイル拡張子。
|
|
248
|
+
* デフォルト: ['.content.ts', '.content.js', '.content.json', など]
|
|
249
|
+
*/
|
|
250
|
+
fileExtensions: [".content.ts", ".content.js", ".content.json"],
|
|
251
|
+
|
|
252
|
+
/**
|
|
253
|
+
* .content ファイルが存在するディレクトリ。
|
|
254
|
+
* デフォルト: ["."]
|
|
255
|
+
*/
|
|
256
|
+
contentDir: ["src"],
|
|
257
|
+
|
|
258
|
+
/**
|
|
259
|
+
* ソースコードが存在するディレクトリ。
|
|
260
|
+
* ビルドの最適化とコード変換に使用されます。
|
|
261
|
+
* デフォルト: ["."]
|
|
262
|
+
*/
|
|
263
|
+
codeDir: ["src"],
|
|
264
|
+
|
|
265
|
+
/**
|
|
266
|
+
* スキャンから除外するパターン。
|
|
267
|
+
* デフォルト: ['node_modules', '.intlayer', など]
|
|
268
|
+
*/
|
|
269
|
+
excludedPath: ["node_modules"],
|
|
270
|
+
|
|
271
|
+
/**
|
|
272
|
+
* 開発中に変更を監視し、辞書を再生成するかどうか。
|
|
273
|
+
* デフォルト: 開発環境では true
|
|
274
|
+
*/
|
|
275
|
+
watch: true,
|
|
276
|
+
|
|
277
|
+
/**
|
|
278
|
+
* 新しく作成または更新された .content ファイルをフォーマットするためのコマンド。
|
|
279
|
+
*/
|
|
280
|
+
formatCommand: 'npx prettier --write "{{file}}"',
|
|
281
|
+
},
|
|
282
|
+
|
|
283
|
+
/**
|
|
284
|
+
* ビジュアルエディタの設定。
|
|
285
|
+
*/
|
|
286
|
+
editor: {
|
|
287
|
+
/**
|
|
288
|
+
* ビジュアルエディタを有効にするかどうか。
|
|
289
|
+
* デフォルト: false
|
|
290
|
+
*/
|
|
291
|
+
enabled: true,
|
|
292
|
+
|
|
293
|
+
/**
|
|
294
|
+
* オリジン検証のためのアプリケーション URL。
|
|
295
|
+
* デフォルト: ""
|
|
296
|
+
*/
|
|
297
|
+
applicationURL: "http://localhost:3000",
|
|
298
|
+
|
|
299
|
+
/**
|
|
300
|
+
* ローカルエディタサーバーのポート。
|
|
301
|
+
* デフォルト: 8000
|
|
302
|
+
*/
|
|
303
|
+
port: 8000,
|
|
304
|
+
|
|
305
|
+
/**
|
|
306
|
+
* エディタのパブリック URL。
|
|
307
|
+
* デフォルト: "http://localhost:8000"
|
|
308
|
+
*/
|
|
309
|
+
editorURL: "http://localhost:8000",
|
|
310
|
+
|
|
311
|
+
/**
|
|
312
|
+
* Intlayer CMS の URL。
|
|
313
|
+
* デフォルト: "https://app.intlayer.org"
|
|
314
|
+
*/
|
|
315
|
+
cmsURL: "https://app.intlayer.org",
|
|
316
|
+
|
|
317
|
+
/**
|
|
318
|
+
* バックエンド API の URL。
|
|
319
|
+
* デフォルト: "https://back.intlayer.org"
|
|
320
|
+
*/
|
|
321
|
+
backendURL: "https://back.intlayer.org",
|
|
322
|
+
|
|
323
|
+
/**
|
|
324
|
+
* リアルタイムコンテンツ同期を有効にするかどうか。
|
|
325
|
+
* デフォルト: false
|
|
326
|
+
*/
|
|
327
|
+
liveSync: true,
|
|
328
|
+
},
|
|
329
|
+
|
|
330
|
+
/**
|
|
331
|
+
* AI による翻訳と生成の設定。
|
|
332
|
+
*/
|
|
333
|
+
ai: {
|
|
334
|
+
/**
|
|
335
|
+
* 使用する AI プロバイダー。
|
|
336
|
+
* オプション: 'openai', 'anthropic', 'mistral', 'deepseek', 'gemini', 'ollama', 'openrouter', 'alibaba', 'fireworks', 'groq', 'huggingface', 'bedrock', 'googlevertex', 'togetherai'
|
|
337
|
+
* デフォルト: 'openai'
|
|
338
|
+
*/
|
|
339
|
+
provider: "openai",
|
|
340
|
+
|
|
341
|
+
/**
|
|
342
|
+
* 選択したプロバイダーで使用するモデル。
|
|
343
|
+
*/
|
|
344
|
+
model: "gpt-4o",
|
|
345
|
+
|
|
346
|
+
/**
|
|
347
|
+
* プロバイダーの API キー。
|
|
348
|
+
*/
|
|
349
|
+
apiKey: process.env.OPENAI_API_KEY,
|
|
350
|
+
|
|
351
|
+
/**
|
|
352
|
+
* 翻訳を生成する際に AI をガイドするグローバルコンテキスト。
|
|
353
|
+
*/
|
|
354
|
+
applicationContext: "これは旅行予約アプリケーションです。",
|
|
355
|
+
|
|
356
|
+
/**
|
|
357
|
+
* AI API のベース URL。
|
|
358
|
+
*/
|
|
359
|
+
baseURL: "http://localhost:3000",
|
|
360
|
+
|
|
361
|
+
/**
|
|
362
|
+
* データシリアライゼーション
|
|
363
|
+
*
|
|
364
|
+
* オプション:
|
|
365
|
+
* - "json": デフォルト、信頼性が高いがトークン消費が多い。
|
|
366
|
+
* - "toon": トークン消費が少ないが、JSON ほど一貫性がない。
|
|
367
|
+
*
|
|
368
|
+
* デフォルト: "json"
|
|
369
|
+
*/
|
|
370
|
+
dataSerialization: "json",
|
|
371
|
+
},
|
|
372
|
+
|
|
373
|
+
/**
|
|
374
|
+
* ビルドと最適化の設定。
|
|
375
|
+
*/
|
|
376
|
+
build: {
|
|
377
|
+
/**
|
|
378
|
+
* ビルドの実行モード。
|
|
379
|
+
* - "auto": アプリのビルド中に自動的にビルドされます。
|
|
380
|
+
* - "manual": 明示的なビルドコマンドが必要です。
|
|
381
|
+
* デフォルト: "auto"
|
|
382
|
+
*/
|
|
383
|
+
mode: "auto",
|
|
384
|
+
|
|
385
|
+
/**
|
|
386
|
+
* 未使用の辞書を削除して、最終的なバンドルを最適化するかどうか。
|
|
387
|
+
* デフォルト: 本番環境では true
|
|
388
|
+
*/
|
|
389
|
+
optimize: true,
|
|
390
|
+
|
|
391
|
+
/**
|
|
392
|
+
* 生成された辞書ファイルの出力形式。
|
|
393
|
+
* デフォルト: ['cjs', 'esm']
|
|
394
|
+
*/
|
|
395
|
+
outputFormat: ["cjs", "esm"],
|
|
396
|
+
|
|
397
|
+
/**
|
|
398
|
+
* ビルド時に TypeScript の型チェックを行うかどうか。
|
|
399
|
+
* デフォルト: false
|
|
400
|
+
*/
|
|
401
|
+
checkTypes: false,
|
|
402
|
+
},
|
|
403
|
+
|
|
404
|
+
/**
|
|
405
|
+
* ロガー設定。
|
|
406
|
+
*/
|
|
407
|
+
log: {
|
|
408
|
+
/**
|
|
409
|
+
* ログレベル。
|
|
410
|
+
* - "default": 標準的なログ記録。
|
|
411
|
+
* - "verbose": 詳細なデバッグログ。
|
|
412
|
+
* - "disabled": ログを記録しません。
|
|
413
|
+
* デフォルト: "default"
|
|
414
|
+
*/
|
|
415
|
+
mode: "default",
|
|
416
|
+
|
|
417
|
+
/**
|
|
418
|
+
* すべてのログメッセージのプレフィックス。
|
|
419
|
+
* デフォルト: "[intlayer]"
|
|
420
|
+
*/
|
|
421
|
+
prefix: "[intlayer]",
|
|
422
|
+
},
|
|
423
|
+
|
|
424
|
+
/**
|
|
425
|
+
* システム設定 (高度なユースケース)
|
|
426
|
+
*/
|
|
427
|
+
system: {
|
|
428
|
+
/**
|
|
429
|
+
* ローカライズされた辞書を保存するディレクトリ。
|
|
430
|
+
*/
|
|
431
|
+
dictionariesDir: ".intlayer/dictionary",
|
|
432
|
+
|
|
433
|
+
/**
|
|
434
|
+
* モジュール拡張 (module augmentation) 用のディレクトリ。
|
|
435
|
+
*/
|
|
436
|
+
moduleAugmentationDir: ".intlayer/types",
|
|
437
|
+
|
|
438
|
+
/**
|
|
439
|
+
* マージされていない辞書を保存するディレクトリ。
|
|
440
|
+
*/
|
|
441
|
+
unmergedDictionariesDir: ".intlayer/unmerged_dictionary",
|
|
442
|
+
|
|
443
|
+
/**
|
|
444
|
+
* 辞書の型を保存するディレクトリ。
|
|
445
|
+
*/
|
|
446
|
+
typesDir: ".intlayer/types",
|
|
447
|
+
|
|
448
|
+
/**
|
|
449
|
+
* メインアプリケーションファイルが保存されるディレクトリ。
|
|
450
|
+
*/
|
|
451
|
+
mainDir: ".intlayer/main",
|
|
452
|
+
|
|
453
|
+
/**
|
|
454
|
+
* コンパイルされた設定ファイルが保存されるディレクトリ。
|
|
455
|
+
*/
|
|
456
|
+
configDir: ".intlayer/config",
|
|
457
|
+
|
|
458
|
+
/**
|
|
459
|
+
* キャッシュファイルが保存されるディレクトリ。
|
|
460
|
+
*/
|
|
461
|
+
cacheDir: ".intlayer/cache",
|
|
462
|
+
},
|
|
463
|
+
|
|
464
|
+
/**
|
|
465
|
+
* コンパイラ設定 (高度なユースケース)
|
|
466
|
+
*/
|
|
467
|
+
compiler: {
|
|
468
|
+
/**
|
|
469
|
+
* コンパイラを有効にするかどうか。
|
|
470
|
+
*
|
|
471
|
+
* - false: コンパイラを無効にする。
|
|
472
|
+
* - true: コンパイラを有効にする。
|
|
473
|
+
* - "build-only": 起動時間を短縮するため、開発中はコンパイラをスキップする。
|
|
474
|
+
*
|
|
475
|
+
* デフォルト: false
|
|
476
|
+
*/
|
|
477
|
+
enabled: true,
|
|
478
|
+
|
|
479
|
+
/**
|
|
480
|
+
* 出力ファイルのパスを定義します。`outputDir` を上書きします。
|
|
481
|
+
*
|
|
482
|
+
* - `./` で始まるパスは、コンポーネントのディレクトリを基準に解決されます。
|
|
483
|
+
* - `/` で始まるパスは、プロジェクトのルート (`baseDir`) を基準に解決されます。
|
|
484
|
+
*
|
|
485
|
+
* - パスに `{{locale}}` 変数を含めると、ロケールごとに個別の辞書生成が有効になります。
|
|
486
|
+
*
|
|
487
|
+
* 例:
|
|
488
|
+
* ```ts
|
|
489
|
+
* {
|
|
490
|
+
* // コンポーネントの近くに多言語対応の .content.ts ファイルを作成する
|
|
491
|
+
* output: ({ fileName, extension }) => `./${fileName}${extension}`,
|
|
492
|
+
*
|
|
493
|
+
* // output: './{{fileName}}{{extension}}', // テンプレート文字列を使用した同等の記述
|
|
494
|
+
* }
|
|
495
|
+
* ```
|
|
496
|
+
*
|
|
497
|
+
* ```ts
|
|
498
|
+
* {
|
|
499
|
+
* // プロジェクトのルートにロケールごとに集約された JSON を作成する
|
|
500
|
+
* output: ({ key, locale }) => `/locales/${locale}/${key}.content.json`,
|
|
501
|
+
*
|
|
502
|
+
* // output: '/locales/{{locale}}/{{key}}.content.json', // テンプレート文字列を使用した同等の記述
|
|
503
|
+
* }
|
|
504
|
+
* ```
|
|
505
|
+
*
|
|
506
|
+
* 変数リスト:
|
|
507
|
+
* - `fileName`: ファイル名。
|
|
508
|
+
* - `key`: コンテンツキー。
|
|
509
|
+
* - `locale`: コンテンツロケール。
|
|
510
|
+
* - `extension`: ファイル拡張子。
|
|
511
|
+
* - `componentFileName`: コンポーネントファイル名。
|
|
512
|
+
* - `componentExtension`: コンポーネントファイル拡張子。
|
|
513
|
+
* - `format`: 辞書フォーマット。
|
|
514
|
+
* - `componentFormat`: コンポーネント辞書フォーマット。
|
|
515
|
+
* - `componentDirPath`: コンポーネントディレクトリパス。
|
|
516
|
+
*/
|
|
517
|
+
output: ({ locale, key }) => `compiler/${locale}/${key}.json`,
|
|
518
|
+
|
|
519
|
+
/**
|
|
520
|
+
* 変換後のコンポーネントを保存するかどうか。
|
|
521
|
+
* これにより、コンパイラを一度だけ実行してアプリケーションを変換し、その後削除することが可能になります。
|
|
522
|
+
*/
|
|
523
|
+
saveComponents: false,
|
|
524
|
+
|
|
525
|
+
/**
|
|
526
|
+
* 生成されたファイルにコンテンツのみを挿入します。ロケールごとの i18next または ICU MessageFormat JSON 出力に有用です。
|
|
527
|
+
*/
|
|
528
|
+
noMetadata: false,
|
|
529
|
+
|
|
530
|
+
/**
|
|
531
|
+
* 辞書キープレフィックス
|
|
532
|
+
*/
|
|
533
|
+
dictionaryKeyPrefix: "", // 抽出された辞書キーにオプションのプレフィックスを追加します
|
|
534
|
+
},
|
|
535
|
+
|
|
536
|
+
/**
|
|
537
|
+
* 辞書のコンテンツを検証するためのカスタムスキーマ。
|
|
538
|
+
*/
|
|
539
|
+
schemas: {
|
|
540
|
+
"my-schema": z.object({
|
|
541
|
+
title: z.string(),
|
|
542
|
+
}),
|
|
543
|
+
},
|
|
544
|
+
|
|
545
|
+
/**
|
|
546
|
+
* プラグイン設定。
|
|
547
|
+
*/
|
|
548
|
+
plugins: [],
|
|
549
|
+
};
|
|
550
|
+
|
|
551
|
+
export default config;
|
|
552
|
+
````
|
|
553
|
+
|
|
554
|
+
---
|
|
555
|
+
|
|
556
|
+
## 設定リファレンス
|
|
557
|
+
|
|
558
|
+
以下のセクションでは、Intlayer で利用可能なさまざまな設定項目について詳しく説明します。
|
|
559
|
+
|
|
560
|
+
---
|
|
561
|
+
|
|
562
|
+
### 国際化設定 (Internationalization)
|
|
563
|
+
|
|
564
|
+
使用可能なロケールやアプリケーションのデフォルトロケールなど、国際化に関連する設定を定義します。
|
|
565
|
+
|
|
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
|
+
|
|
573
|
+
---
|
|
574
|
+
|
|
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` | <br/> `undefined` | `undefined` | | 秘密にする必要があるため、環境変数に保存してください。 |
|
|
588
|
+
| `clientSecret` | intlayer パッケージが oAuth2 を介してバックエンドで認証できるようにします。アクセストークンを取得するには、[intlayer.org/project](https://app.intlayer.org/project) にアクセスしてください。 | `string` | <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 サーバーを使用する場合は変更可能です。 |
|
|
593
|
+
|
|
594
|
+
---
|
|
595
|
+
|
|
596
|
+
### ルーティング設定 (Routing)
|
|
597
|
+
|
|
598
|
+
URL 構造、ロケール保存、ミドルウェア管理など、ルーティングの動作を制御する設定。
|
|
599
|
+
|
|
600
|
+
| フィールド | 説明 | 型 | デフォルト | 例 | 備考 |
|
|
601
|
+
| --- | --- | --- | --- | --- | --- |
|
|
602
|
+
| `mode` | ロケール管理のための URL ルーティングモード。 | `'prefix-no-default'` | <br/> `'prefix-all'` | <br/> `'no-prefix'` | <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` | <br/> `'cookie'` | <br/> `'localStorage'` | <br/> `'sessionStorage'` | <br/> `'header'` | <br/> `CookiesAttributes` | <br/> `StorageAttributes` | <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)を参照してください。 |
|
|
606
|
+
|
|
607
|
+
**`rewrite` の例**:
|
|
608
|
+
|
|
609
|
+
```typescript
|
|
610
|
+
routing: {
|
|
611
|
+
mode: "prefix-no-default", // フォールバック戦略
|
|
612
|
+
rewrite: nextjsRewrite({
|
|
613
|
+
"/about": {
|
|
614
|
+
en: "/about",
|
|
615
|
+
fr: "/a-propos",
|
|
616
|
+
},
|
|
617
|
+
"/product/[slug]": {
|
|
618
|
+
en: "/product/[slug]",
|
|
619
|
+
fr: "/produit/[slug]",
|
|
620
|
+
},
|
|
621
|
+
"/blog/[category]/[id]": {
|
|
622
|
+
en: "/blog/[category]/[id]",
|
|
623
|
+
fr: "/journal/[category]/[id]",
|
|
624
|
+
},
|
|
625
|
+
}),
|
|
626
|
+
}
|
|
627
|
+
```
|
|
628
|
+
|
|
629
|
+
#### 保存オプション (Storage Options)
|
|
630
|
+
|
|
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 ヘッダーを介してロケールを保存または送信します。サーバーサイドのみ。 |
|
|
637
|
+
|
|
638
|
+
#### Cookie 属性 (Cookies Attributes)
|
|
639
|
+
|
|
640
|
+
Cookie 保存を使用する場合、追加のアトリビュートを設定できます。
|
|
641
|
+
|
|
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'` | <br/> `'lax'` | <br/> `'none'` |
|
|
650
|
+
| `expires` | 有効期限または日数。デフォルト: `undefined` | `Date` | <br/> `number` |
|
|
651
|
+
|
|
652
|
+
#### 保存属性 (Storage Attributes)
|
|
653
|
+
|
|
654
|
+
localStorage または sessionStorage を使用する場合。
|
|
655
|
+
|
|
656
|
+
| フィールド | 説明 | 型 |
|
|
657
|
+
| --- | --- | --- |
|
|
658
|
+
| `type` | 保存方法のタイプ。 | `'localStorage'` | <br/> `'sessionStorage'` |
|
|
659
|
+
| `name` | 保存キーの名前。デフォルト: `'INTLAYER_LOCALE'` | `string` |
|
|
660
|
+
|
|
661
|
+
#### 設定例
|
|
662
|
+
|
|
663
|
+
新しい v7 ルーティング構造の一般的な設定例をいくつか示します。
|
|
664
|
+
|
|
665
|
+
**基本設定 (デフォルト)**:
|
|
666
|
+
|
|
667
|
+
```typescript
|
|
668
|
+
import { Locales, type IntlayerConfig } from "intlayer";
|
|
669
|
+
// intlayer.config.ts
|
|
670
|
+
const config: IntlayerConfig = {
|
|
671
|
+
internationalization: {
|
|
672
|
+
locales: ["en", "fr", "es"],
|
|
673
|
+
defaultLocale: "en",
|
|
674
|
+
},
|
|
675
|
+
routing: {
|
|
676
|
+
mode: "prefix-no-default",
|
|
677
|
+
storage: "localStorage",
|
|
678
|
+
basePath: "",
|
|
679
|
+
},
|
|
680
|
+
};
|
|
681
|
+
|
|
682
|
+
export default config;
|
|
683
|
+
```
|
|
684
|
+
|
|
685
|
+
**GDPR 準拠設定**:
|
|
686
|
+
|
|
687
|
+
```typescript
|
|
688
|
+
import { Locales, type IntlayerConfig } from "intlayer";
|
|
689
|
+
// intlayer.config.ts
|
|
690
|
+
const config: IntlayerConfig = {
|
|
691
|
+
internationalization: {
|
|
692
|
+
locales: ["en", "fr", "es"],
|
|
693
|
+
defaultLocale: "en",
|
|
694
|
+
},
|
|
695
|
+
routing: {
|
|
696
|
+
mode: "prefix-no-default",
|
|
697
|
+
storage: [
|
|
698
|
+
{
|
|
699
|
+
type: "localStorage",
|
|
700
|
+
name: "user-locale",
|
|
701
|
+
},
|
|
702
|
+
{
|
|
703
|
+
type: "cookie",
|
|
704
|
+
name: "user-locale",
|
|
705
|
+
secure: true,
|
|
706
|
+
sameSite: "strict",
|
|
707
|
+
httpOnly: false,
|
|
708
|
+
},
|
|
709
|
+
],
|
|
710
|
+
basePath: "",
|
|
711
|
+
},
|
|
712
|
+
};
|
|
713
|
+
|
|
714
|
+
export default config;
|
|
715
|
+
```
|
|
716
|
+
|
|
717
|
+
**検索パラメータモード**:
|
|
718
|
+
|
|
719
|
+
```typescript
|
|
720
|
+
import { Locales, type IntlayerConfig } from "intlayer";
|
|
721
|
+
// intlayer.config.ts
|
|
722
|
+
const config: IntlayerConfig = {
|
|
723
|
+
internationalization: {
|
|
724
|
+
locales: ["en", "fr", "es"],
|
|
725
|
+
defaultLocale: "en",
|
|
726
|
+
},
|
|
727
|
+
routing: {
|
|
728
|
+
mode: "search-params",
|
|
729
|
+
storage: "localStorage",
|
|
730
|
+
basePath: "",
|
|
731
|
+
},
|
|
732
|
+
};
|
|
733
|
+
|
|
734
|
+
export default config;
|
|
735
|
+
```
|
|
736
|
+
|
|
737
|
+
**カスタム保存を使用したプレフィックスなしモード**:
|
|
738
|
+
|
|
739
|
+
```typescript
|
|
740
|
+
import { Locales, type IntlayerConfig } from "intlayer";
|
|
741
|
+
// intlayer.config.ts
|
|
742
|
+
const config: IntlayerConfig = {
|
|
743
|
+
internationalization: {
|
|
744
|
+
locales: ["en", "fr", "es"],
|
|
745
|
+
defaultLocale: "en",
|
|
746
|
+
},
|
|
747
|
+
routing: {
|
|
748
|
+
mode: "no-prefix",
|
|
749
|
+
storage: {
|
|
750
|
+
type: "sessionStorage",
|
|
751
|
+
name: "app-locale",
|
|
752
|
+
},
|
|
753
|
+
basePath: "/my-app",
|
|
754
|
+
},
|
|
755
|
+
};
|
|
756
|
+
|
|
757
|
+
export default config;
|
|
758
|
+
```
|
|
759
|
+
|
|
760
|
+
**動的パスを使用したカスタム URL リライト**:
|
|
761
|
+
|
|
762
|
+
```typescript
|
|
763
|
+
// intlayer.config.ts
|
|
764
|
+
import { nextjsRewrite } from "intlayer/routing";
|
|
765
|
+
|
|
766
|
+
const config: IntlayerConfig = {
|
|
767
|
+
internationalization: {
|
|
768
|
+
locales: ["en", "fr"],
|
|
769
|
+
defaultLocale: "en",
|
|
770
|
+
},
|
|
771
|
+
routing: {
|
|
772
|
+
mode: "prefix-no-default", // リライトされないパスのフォールバック
|
|
773
|
+
storage: "cookie",
|
|
774
|
+
rewrite: nextjsRewrite({
|
|
775
|
+
"/about": {
|
|
776
|
+
en: "/about",
|
|
777
|
+
fr: "/a-propos",
|
|
778
|
+
},
|
|
779
|
+
"/product/[slug]": {
|
|
780
|
+
en: "/product/[slug]",
|
|
781
|
+
fr: "/produit/[slug]",
|
|
782
|
+
},
|
|
783
|
+
"/blog/[category]/[id]": {
|
|
784
|
+
en: "/blog/[category]/[id]",
|
|
785
|
+
fr: "/journal/[category]/[id]",
|
|
786
|
+
},
|
|
787
|
+
}),
|
|
788
|
+
},
|
|
789
|
+
};
|
|
790
|
+
|
|
791
|
+
export default config;
|
|
792
|
+
```
|
|
793
|
+
|
|
794
|
+
---
|
|
795
|
+
|
|
796
|
+
### コンテンツ設定 (Content)
|
|
797
|
+
|
|
798
|
+
ディレクトリ名、ファイル拡張子、派生設定など、アプリケーション内でのコンテンツ管理方法に関連する設定。
|
|
799
|
+
|
|
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 をテスト)。 |
|
|
808
|
+
|
|
809
|
+
---
|
|
810
|
+
|
|
811
|
+
### 辞書設定 (Dictionary)
|
|
812
|
+
|
|
813
|
+
自動入力動作やコンテンツ生成など、辞書操作を制御するパラメータ。
|
|
814
|
+
|
|
815
|
+
| フィールド | 説明 | 型 | デフォルト | 例 | 備考 |
|
|
816
|
+
| --- | --- | --- | --- | --- | --- |
|
|
817
|
+
| `fill` | 自動入力 (AI 翻訳) の出力ファイルがどのように生成されるかを制御します。 | `boolean` | <br/> `FilePathPattern` | <br/> `Partial<Record<Locale, boolean | 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` | <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'` | <br/> `'remote'` | <br/> `'hybrid'` | <br/> `'plugin'` | <br/> `string` | `'local'` | `'hybrid'` | • `'local'`: ローカルでのみ管理。<br/>• `'remote'`: リモート (CMS) でのみ管理。<br/>• `'hybrid'`: ローカルとリモートの両方で管理。<br/>• `'plugin'` またはカスタム文字列: プラグインやカスタムソースによって管理。 |
|
|
822
|
+
| `importMode` | 辞書のインポート方法を制御します。 | `'static'` | <br/> `'dynamic'` | <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/>• ローカルで編集しないでください。 |
|
|
829
|
+
|
|
830
|
+
**`fill` の例**:
|
|
831
|
+
|
|
832
|
+
```ts
|
|
833
|
+
dictionary: {
|
|
834
|
+
fill: {
|
|
835
|
+
en: "/locales/en/{{key}}.content.json",
|
|
836
|
+
fr: ({ key }) => `/locales/fr/${key}.content.json`,
|
|
837
|
+
es: false,
|
|
838
|
+
},
|
|
839
|
+
};
|
|
840
|
+
```
|
|
841
|
+
|
|
842
|
+
---
|
|
843
|
+
|
|
844
|
+
### ロガー設定 (Logger)
|
|
845
|
+
|
|
846
|
+
Intlayer からのログ出力をカスタマイズするためのパラメータ。
|
|
847
|
+
|
|
848
|
+
| フィールド | 説明 | 型 | デフォルト | 例 | 備考 |
|
|
849
|
+
| --- | --- | --- | --- | --- | --- |
|
|
850
|
+
| `mode` | ロガーのモードを指定します。 | `'default'` | <br/> `'verbose'` | <br/> `'disabled'` | `'default'` | `'verbose'` | • `'verbose'`: デバッグ用により多くの情報を出力します。<br/>• `'disabled'`: ロガーを完全に無効にします。 |
|
|
851
|
+
| `prefix` | ログメッセージのプレフィックス。 | `string` | `'[intlayer] '` | `'[my prefix] '` | |
|
|
852
|
+
|
|
853
|
+
---
|
|
854
|
+
|
|
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'` | <br/> `'anthropic'` | <br/> `'mistral'` | <br/> `'deepseek'` | <br/> `'gemini'` | <br/> `'ollama'` | <br/> `'openrouter'` | <br/> `'alibaba'` | <br/> `'fireworks'` | <br/> `'groq'` | <br/> `'huggingface'` | <br/> `'bedrock'` | <br/> `'googleaistudio'` | <br/> `'googlevertex'` | <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'` | <br/> `'toon'` | `undefined` | `'toon'` | • `'json'`: デフォルト、信頼性が高いがトークン消費が多い。<br/>• `'toon'`: トークン消費が少ないが、一貫性に欠ける。<br/>• 推論の努力 (reasoning effort) などの追加パラメータがコンテキストとしてモデルに渡されます。 |
|
|
892
|
+
|
|
893
|
+
---
|
|
894
|
+
|
|
895
|
+
### ビルド設定 (Build)
|
|
896
|
+
|
|
897
|
+
Intlayer がアプリケーションの国際化をどのように最適化およびコンパイルするかを制御するパラメータ。
|
|
898
|
+
|
|
899
|
+
ビルドオプションは、`@intlayer/babel` および `@intlayer/swc` プラグインに適用されます。
|
|
900
|
+
|
|
901
|
+
> 開発モードでは、Intlayer は開発体験を簡素化するために辞書の静的インポートを使用します。
|
|
902
|
+
|
|
903
|
+
> 最適化中、Intlayer はチャンキングを最適化するために辞書の呼び出しを置き換え、最終的なバンドルが実際に使用される辞書のみをインポートするようにします。
|
|
904
|
+
|
|
905
|
+
| フィールド | 説明 | 型 | デフォルト | 例 | 備考 |
|
|
906
|
+
| --- | --- | --- | --- | --- | --- |
|
|
907
|
+
| `mode` | ビルドモードを制御します。 | `'auto'` | <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' | '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 パターンを使用します。 |
|
|
912
|
+
|
|
913
|
+
---
|
|
914
|
+
|
|
915
|
+
### システム設定 (System)
|
|
916
|
+
|
|
917
|
+
これらの設定は、高度なユースケースおよび Intlayer の内部設定用です。
|
|
918
|
+
|
|
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'` | | |
|
|
928
|
+
|
|
929
|
+
---
|
|
930
|
+
|
|
931
|
+
### コンパイラ設定 (Compiler)
|
|
932
|
+
|
|
933
|
+
コンポーネントから直接辞書を抽出する Intlayer コンパイラを制御する設定。
|
|
934
|
+
|
|
935
|
+
| フィールド | 説明 | 型 | デフォルト | 例 | 備考 |
|
|
936
|
+
| --- | --- | --- | --- | --- | --- |
|
|
937
|
+
| `enabled` | 辞書の抽出のためにコンパイラを有効にするかどうかを指定します。 | `boolean` | <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` | <br/> `FilePathPattern` | <br/> `Partial<Record<Locale, boolean | 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` | `''` | | 抽出された辞書キーにオプションのプレフィックスを追加します。 |
|
|
943
|
+
|
|
944
|
+
---
|
|
945
|
+
|
|
946
|
+
### カスタムスキーマ (Custom Schemas)
|
|
947
|
+
|
|
948
|
+
| フィールド | 説明 | 型 |
|
|
949
|
+
| --- | --- | --- |
|
|
950
|
+
| `schemas` | 辞書の構造を検証するための Zod スキーマを定義できます。 | `Record<string, ZodSchema>` |
|
|
951
|
+
|
|
952
|
+
---
|
|
953
|
+
|
|
954
|
+
### プラグイン (Plugins)
|
|
955
|
+
|
|
956
|
+
| フィールド | 説明 | 型 |
|
|
957
|
+
| --- | --- | --- |
|
|
958
|
+
| `plugins` | 有効にする Intlayer プラグインのリスト。 | `IntlayerPlugin[]` |
|