@intlayer/docs 8.4.5 → 8.4.7
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/blog/en/next-i18next_vs_next-intl_vs_intlayer.md +1 -3
- package/blog/en-GB/next-i18next_vs_next-intl_vs_intlayer.md +1 -3
- package/blog/es/next-i18next_vs_next-intl_vs_intlayer.md +1 -3
- package/blog/id/next-i18next_vs_next-intl_vs_intlayer.md +1 -3
- package/blog/it/next-i18next_vs_next-intl_vs_intlayer.md +1 -3
- package/blog/ja/next-i18next_vs_next-intl_vs_intlayer.md +1 -3
- package/blog/ko/next-i18next_vs_next-intl_vs_intlayer.md +1 -3
- package/blog/uk/next-i18next_vs_next-intl_vs_intlayer.md +1 -3
- package/blog/vi/next-i18next_vs_next-intl_vs_intlayer.md +1 -3
- package/blog/zh/next-i18next_vs_next-intl_vs_intlayer.md +1 -3
- package/dist/cjs/generated/docs.entry.cjs +20 -0
- package/dist/cjs/generated/docs.entry.cjs.map +1 -1
- package/dist/esm/generated/docs.entry.mjs +20 -0
- package/dist/esm/generated/docs.entry.mjs.map +1 -1
- package/dist/types/generated/docs.entry.d.ts +1 -0
- package/dist/types/generated/docs.entry.d.ts.map +1 -1
- package/docs/ar/intlayer_with_storybook.md +521 -0
- package/docs/bn/intlayer_with_hono.md +428 -0
- package/docs/de/intlayer_with_storybook.md +521 -0
- package/docs/en/configuration.md +160 -508
- package/docs/en/intlayer_with_storybook.md +521 -0
- package/docs/en-GB/intlayer_with_storybook.md +521 -0
- package/docs/es/configuration.md +387 -754
- package/docs/es/intlayer_with_storybook.md +521 -0
- package/docs/fr/configuration.md +384 -757
- package/docs/fr/intlayer_with_storybook.md +521 -0
- package/docs/hi/intlayer_with_storybook.md +521 -0
- package/docs/id/intlayer_with_storybook.md +521 -0
- package/docs/it/intlayer_with_storybook.md +521 -0
- package/docs/ja/intlayer_with_storybook.md +521 -0
- package/docs/ko/intlayer_with_storybook.md +521 -0
- package/docs/pl/intlayer_with_storybook.md +521 -0
- package/docs/pt/intlayer_with_storybook.md +521 -0
- package/docs/ru/intlayer_with_storybook.md +521 -0
- package/docs/tr/intlayer_with_storybook.md +521 -0
- package/docs/uk/intlayer_with_storybook.md +521 -0
- package/docs/ur/intlayer_with_hono.md +428 -0
- package/docs/vi/intlayer_with_storybook.md +521 -0
- package/docs/zh/intlayer_with_storybook.md +521 -0
- package/package.json +6 -6
- package/src/generated/docs.entry.ts +20 -0
- package/docs/ar/configuration.md +0 -1124
- package/docs/de/configuration.md +0 -1296
- package/docs/en-GB/configuration.md +0 -1123
- package/docs/hi/configuration.md +0 -1118
- package/docs/id/configuration.md +0 -1235
- package/docs/it/configuration.md +0 -1301
- package/docs/ja/configuration.md +0 -1121
- package/docs/ko/configuration.md +0 -1121
- package/docs/pl/configuration.md +0 -1226
- package/docs/pt/configuration.md +0 -1293
- package/docs/ru/configuration.md +0 -1112
- package/docs/tr/configuration.md +0 -1114
- package/docs/uk/configuration.md +0 -1241
- package/docs/vi/configuration.md +0 -1263
- package/docs/zh/configuration.md +0 -1115
package/docs/ja/configuration.md
DELETED
|
@@ -1,1121 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
createdAt: 2024-08-13
|
|
3
|
-
updatedAt: 2026-03-12
|
|
4
|
-
title: 設定
|
|
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.3.0
|
|
18
|
-
date: 2026-03-11
|
|
19
|
-
changes: "'baseDir' を 'content' 設定から 'system' 設定に移動"
|
|
20
|
-
- version: 8.2.0
|
|
21
|
-
date: 2026-03-10
|
|
22
|
-
changes: コンパイラーオプションの更新、'output' および 'noMetadata' のサポートを追加
|
|
23
|
-
- version: 8.1.7
|
|
24
|
-
date: 2026-02-25
|
|
25
|
-
changes: コンパイラーオプションの更新
|
|
26
|
-
- version: 8.0.6
|
|
27
|
-
date: 2026-02-12
|
|
28
|
-
changes: Open Router, Alibaba, Amazon, Google Vertex Bedrock, Fireworks, Groq, Hugging Face, Together.ai プロバイダーのサポートを追加
|
|
29
|
-
- version: 8.0.5
|
|
30
|
-
date: 2026-02-06
|
|
31
|
-
changes: AI設定に `dataSerialization` を追加
|
|
32
|
-
- version: 8.0.0
|
|
33
|
-
date: 2026-01-22
|
|
34
|
-
changes: importMode のビルド設定を辞書設定に移動。
|
|
35
|
-
- version: 8.0.0
|
|
36
|
-
date: 2026-01-18
|
|
37
|
-
changes: システム設定をコンテンツ設定から分離。内部パスを `system` プロパティに移動。コンテンツファイルとコード変換を分離するために `codeDir` を追加。
|
|
38
|
-
- version: 8.0.0
|
|
39
|
-
date: 2026-01-18
|
|
40
|
-
changes: 辞書オプション `location` と `schema` を追加
|
|
41
|
-
- version: 7.5.1
|
|
42
|
-
date: 2026-01-10
|
|
43
|
-
changes: JSON5 および JSONC ファイル形式のサポートを追加
|
|
44
|
-
- version: 7.5.0
|
|
45
|
-
date: 2025-12-17
|
|
46
|
-
changes: "`buildMode` オプションを追加"
|
|
47
|
-
- version: 6.0.0
|
|
48
|
-
date: 2025-09-16
|
|
49
|
-
changes: "`live` インポートモードを追加"
|
|
50
|
-
- version: 6.0.0
|
|
51
|
-
date: 2025-09-16
|
|
52
|
-
changes: "`live` インポートモードを追加"
|
|
53
|
-
- version: 6.0.0
|
|
54
|
-
date: 2025-09-04
|
|
55
|
-
changes: "`hotReload` フィールドを `liveSync` に置き換え、`liveSyncPort` と `liveSyncURL` フィールドを追加"
|
|
56
|
-
- version: 5.6.1
|
|
57
|
-
date: 2025-07-25
|
|
58
|
-
changes: "`activateDynamicImport` を `importMode` オプションに置き換え"
|
|
59
|
-
- version: 5.6.0
|
|
60
|
-
date: 2025-07-13
|
|
61
|
-
changes: デフォルトの contentDir を `['src']` から `['.']` に変更
|
|
62
|
-
- version: 5.5.11
|
|
63
|
-
date: 2025-06-29
|
|
64
|
-
changes: "`docs` コマンドを追加"
|
|
65
|
-
---
|
|
66
|
-
|
|
67
|
-
# Intlayer 設定ドキュメント
|
|
68
|
-
|
|
69
|
-
## 概要
|
|
70
|
-
|
|
71
|
-
Intlayerの設定ファイルは、国際化、ミドルウェア、コンテンツ処理など、プラグインのさまざまな側面をカスタマイズすることを可能にします。本ドキュメントでは、設定内の各プロパティについて詳細に説明します。
|
|
72
|
-
|
|
73
|
-
---
|
|
74
|
-
|
|
75
|
-
## 目次
|
|
76
|
-
|
|
77
|
-
<TOC/>
|
|
78
|
-
|
|
79
|
-
---
|
|
80
|
-
|
|
81
|
-
## 設定ファイルの対応形式
|
|
82
|
-
|
|
83
|
-
IntlayerはJSON、JS、MJS、TSの設定ファイル形式をサポートしています:
|
|
84
|
-
|
|
85
|
-
- `intlayer.config.ts`
|
|
86
|
-
- `intlayer.config.js`
|
|
87
|
-
- `intlayer.config.json`
|
|
88
|
-
- `intlayer.config.json5`
|
|
89
|
-
- `intlayer.config.jsonc`
|
|
90
|
-
- `intlayer.config.cjs`
|
|
91
|
-
- `intlayer.config.mjs`
|
|
92
|
-
- `.intlayerrc`
|
|
93
|
-
|
|
94
|
-
---
|
|
95
|
-
|
|
96
|
-
## 設定ファイルの例
|
|
97
|
-
|
|
98
|
-
````typescript fileName="intlayer.config.ts" codeFormat="typescript"
|
|
99
|
-
import { Locales, type IntlayerConfig } from "intlayer";
|
|
100
|
-
import { nextjsRewrite } from "intlayer/routing";
|
|
101
|
-
import { z } from "zod";
|
|
102
|
-
|
|
103
|
-
/**
|
|
104
|
-
* Example Intlayer configuration file showing all available options.
|
|
105
|
-
*/
|
|
106
|
-
const config: IntlayerConfig = {
|
|
107
|
-
/**
|
|
108
|
-
* Configuration for internationalization settings.
|
|
109
|
-
*/
|
|
110
|
-
internationalization: {
|
|
111
|
-
/**
|
|
112
|
-
* List of supported locales in the application.
|
|
113
|
-
* Default: [Locales.ENGLISH]
|
|
114
|
-
*/
|
|
115
|
-
locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
|
|
116
|
-
|
|
117
|
-
/**
|
|
118
|
-
* List of required locales that must be defined in every dictionary.
|
|
119
|
-
* If empty, all locales are required in `strict` mode.
|
|
120
|
-
* Default: []
|
|
121
|
-
*/
|
|
122
|
-
requiredLocales: [Locales.ENGLISH],
|
|
123
|
-
|
|
124
|
-
/**
|
|
125
|
-
* Strictness level for internationalized content.
|
|
126
|
-
* - "strict": Errors if any declared locale is missing or undeclared.
|
|
127
|
-
* - "inclusive": Warnings if a declared locale is missing.
|
|
128
|
-
* - "loose": Accepts any existing locale.
|
|
129
|
-
* Default: "inclusive"
|
|
130
|
-
*/
|
|
131
|
-
strictMode: "inclusive",
|
|
132
|
-
|
|
133
|
-
/**
|
|
134
|
-
* Default locale used as a fallback if the requested locale is not found.
|
|
135
|
-
* Default: Locales.ENGLISH
|
|
136
|
-
*/
|
|
137
|
-
defaultLocale: Locales.ENGLISH,
|
|
138
|
-
},
|
|
139
|
-
|
|
140
|
-
/**
|
|
141
|
-
* Settings that control dictionary operations and fallback behavior.
|
|
142
|
-
*/
|
|
143
|
-
dictionary: {
|
|
144
|
-
/**
|
|
145
|
-
* Controls how dictionaries are imported.
|
|
146
|
-
* - "static": Statically imported at build time.
|
|
147
|
-
* - "dynamic": Dynamically imported using Suspense.
|
|
148
|
-
* - "fetch": Fetched dynamically via the live sync API.
|
|
149
|
-
* Default: "static"
|
|
150
|
-
*/
|
|
151
|
-
importMode: "static",
|
|
152
|
-
|
|
153
|
-
/**
|
|
154
|
-
* Strategy for auto-filling missing translations using AI.
|
|
155
|
-
* Can be a boolean or a path pattern to store filled content.
|
|
156
|
-
* Default: true
|
|
157
|
-
*/
|
|
158
|
-
fill: true,
|
|
159
|
-
|
|
160
|
-
/**
|
|
161
|
-
* Physical location of the dictionary files.
|
|
162
|
-
* - "local": Stored in the local filesystem.
|
|
163
|
-
* - "remote": Stored in the Intlayer CMS.
|
|
164
|
-
* - "hybrid": Stored in the local filesystem and the Intlayer CMS.
|
|
165
|
-
* - "plugin" (or any custom string): Provided by a plugin or a custom source.
|
|
166
|
-
* Default: "local"
|
|
167
|
-
*/
|
|
168
|
-
location: "local",
|
|
169
|
-
|
|
170
|
-
/**
|
|
171
|
-
* Whether to automatically transform content (e.g., Markdown to HTML).
|
|
172
|
-
* Default: false
|
|
173
|
-
*/
|
|
174
|
-
contentAutoTransformation: false,
|
|
175
|
-
},
|
|
176
|
-
|
|
177
|
-
/**
|
|
178
|
-
* Routing and middleware configuration.
|
|
179
|
-
*/
|
|
180
|
-
routing: {
|
|
181
|
-
/**
|
|
182
|
-
* Locale routing strategy.
|
|
183
|
-
* - "prefix-no-default": Prefix all except the default locale (e.g., /dashboard, /fr/dashboard).
|
|
184
|
-
* - "prefix-all": Prefix all locales (e.g., /en/dashboard, /fr/dashboard).
|
|
185
|
-
* - "no-prefix": No locale in the URL.
|
|
186
|
-
* - "search-params": Use ?locale=...
|
|
187
|
-
* Default: "prefix-no-default"
|
|
188
|
-
*/
|
|
189
|
-
mode: "prefix-no-default",
|
|
190
|
-
|
|
191
|
-
/**
|
|
192
|
-
* Where to store the user's selected locale.
|
|
193
|
-
* Options: 'cookie', 'localStorage', 'sessionStorage', 'header', or an array of these.
|
|
194
|
-
* Default: ['cookie', 'header']
|
|
195
|
-
*/
|
|
196
|
-
storage: ["cookie", "header"],
|
|
197
|
-
|
|
198
|
-
/**
|
|
199
|
-
* Base path for the application URLs.
|
|
200
|
-
* Default: ""
|
|
201
|
-
*/
|
|
202
|
-
basePath: "",
|
|
203
|
-
|
|
204
|
-
/**
|
|
205
|
-
* Custom URL rewriting rules for locale-specific paths.
|
|
206
|
-
*/
|
|
207
|
-
rewrite: nextjsRewrite({
|
|
208
|
-
"/[locale]/about": {
|
|
209
|
-
en: "/[locale]/about",
|
|
210
|
-
fr: "/[locale]/a-propos",
|
|
211
|
-
},
|
|
212
|
-
}),
|
|
213
|
-
},
|
|
214
|
-
|
|
215
|
-
/**
|
|
216
|
-
* Settings for finding and processing content files.
|
|
217
|
-
*/
|
|
218
|
-
content: {
|
|
219
|
-
/**
|
|
220
|
-
* File extensions to scan for dictionaries.
|
|
221
|
-
* Default: ['.content.ts', '.content.js', '.content.json', etc.]
|
|
222
|
-
*/
|
|
223
|
-
fileExtensions: [".content.ts", ".content.js", ".content.json"],
|
|
224
|
-
|
|
225
|
-
/**
|
|
226
|
-
* Directories where .content files are located.
|
|
227
|
-
* Default: ["."]
|
|
228
|
-
*/
|
|
229
|
-
contentDir: ["src"],
|
|
230
|
-
|
|
231
|
-
/**
|
|
232
|
-
* Directories where source code is located.
|
|
233
|
-
* Used for build optimization and code transformation.
|
|
234
|
-
* Default: ["."]
|
|
235
|
-
*/
|
|
236
|
-
codeDir: ["src"],
|
|
237
|
-
|
|
238
|
-
/**
|
|
239
|
-
* Patterns to exclude from scanning.
|
|
240
|
-
* Default: ['node_modules', '.intlayer', etc.]
|
|
241
|
-
*/
|
|
242
|
-
excludedPath: ["node_modules"],
|
|
243
|
-
|
|
244
|
-
/**
|
|
245
|
-
* Whether to watch for changes and rebuild dictionaries in development.
|
|
246
|
-
* Default: true in development
|
|
247
|
-
*/
|
|
248
|
-
watch: true,
|
|
249
|
-
|
|
250
|
-
/**
|
|
251
|
-
* Command to format newly created / updated .content files.
|
|
252
|
-
*/
|
|
253
|
-
formatCommand: 'npx prettier --write "{{file}}"',
|
|
254
|
-
},
|
|
255
|
-
|
|
256
|
-
/**
|
|
257
|
-
* Visual Editor configuration.
|
|
258
|
-
*/
|
|
259
|
-
editor: {
|
|
260
|
-
/**
|
|
261
|
-
* Whether the visual editor is enabled.
|
|
262
|
-
* Default: false
|
|
263
|
-
*/
|
|
264
|
-
enabled: true,
|
|
265
|
-
|
|
266
|
-
/**
|
|
267
|
-
* URL of your application for origin validation.
|
|
268
|
-
* Default: ""
|
|
269
|
-
*/
|
|
270
|
-
applicationURL: "http://localhost:3000",
|
|
271
|
-
|
|
272
|
-
/**
|
|
273
|
-
* Port for the local editor server.
|
|
274
|
-
* Default: 8000
|
|
275
|
-
*/
|
|
276
|
-
port: 8000,
|
|
277
|
-
|
|
278
|
-
/**
|
|
279
|
-
* Public URL for the editor.
|
|
280
|
-
* Default: "http://localhost:8000"
|
|
281
|
-
*/
|
|
282
|
-
editorURL: "http://localhost:8000",
|
|
283
|
-
|
|
284
|
-
/**
|
|
285
|
-
* Intlayer CMS URL.
|
|
286
|
-
* Default: "https://app.intlayer.org"
|
|
287
|
-
*/
|
|
288
|
-
cmsURL: "https://app.intlayer.org",
|
|
289
|
-
|
|
290
|
-
/**
|
|
291
|
-
* Backend API URL.
|
|
292
|
-
* Default: "https://back.intlayer.org"
|
|
293
|
-
*/
|
|
294
|
-
backendURL: "https://back.intlayer.org",
|
|
295
|
-
|
|
296
|
-
/**
|
|
297
|
-
* Whether to enable real-time content synchronization.
|
|
298
|
-
* Default: false
|
|
299
|
-
*/
|
|
300
|
-
liveSync: true,
|
|
301
|
-
},
|
|
302
|
-
|
|
303
|
-
/**
|
|
304
|
-
* AI-powered translation and generation settings.
|
|
305
|
-
*/
|
|
306
|
-
ai: {
|
|
307
|
-
/**
|
|
308
|
-
* AI provider to use.
|
|
309
|
-
* Options: 'openai', 'anthropic', 'mistral', 'deepseek', 'gemini', 'ollama', 'openrouter', 'alibaba', 'fireworks', 'groq', 'huggingface', 'bedrock', 'googlevertex', 'togetherai'
|
|
310
|
-
* Default: 'openai'
|
|
311
|
-
*/
|
|
312
|
-
provider: "openai",
|
|
313
|
-
|
|
314
|
-
/**
|
|
315
|
-
* Model to use from the selected provider.
|
|
316
|
-
*/
|
|
317
|
-
model: "gpt-4o",
|
|
318
|
-
|
|
319
|
-
/**
|
|
320
|
-
* Provider API key.
|
|
321
|
-
*/
|
|
322
|
-
apiKey: process.env.OPENAI_API_KEY,
|
|
323
|
-
|
|
324
|
-
/**
|
|
325
|
-
* Global context to guide the AI in generating translations.
|
|
326
|
-
*/
|
|
327
|
-
applicationContext: "This is a travel booking application.",
|
|
328
|
-
|
|
329
|
-
/**
|
|
330
|
-
* Base URL for the AI API.
|
|
331
|
-
*/
|
|
332
|
-
baseURL: "http://localhost:3000",
|
|
333
|
-
|
|
334
|
-
/**
|
|
335
|
-
* データシリアライゼーション
|
|
336
|
-
*
|
|
337
|
-
* オプション:
|
|
338
|
-
* - "json": 標準、信頼性あり。より多くのトークンを使用します。
|
|
339
|
-
* - "toon": より少ないトークンを使用しますが、JSON ほど一貫性がありません。
|
|
340
|
-
*
|
|
341
|
-
* デフォルト: "json"
|
|
342
|
-
*/
|
|
343
|
-
dataSerialization: "json",
|
|
344
|
-
},
|
|
345
|
-
|
|
346
|
-
/**
|
|
347
|
-
* Build and optimization settings.
|
|
348
|
-
*/
|
|
349
|
-
build: {
|
|
350
|
-
/**
|
|
351
|
-
* Build execution mode.
|
|
352
|
-
* - "auto": Automatic build during app build.
|
|
353
|
-
* - "manual": Requires explicit build command.
|
|
354
|
-
* Default: "auto"
|
|
355
|
-
*/
|
|
356
|
-
mode: "auto",
|
|
357
|
-
|
|
358
|
-
/**
|
|
359
|
-
* Whether to optimize the final bundle by pruning unused dictionaries.
|
|
360
|
-
* Default: true in production
|
|
361
|
-
*/
|
|
362
|
-
optimize: true,
|
|
363
|
-
|
|
364
|
-
/**
|
|
365
|
-
* Output format for generated dictionary files.
|
|
366
|
-
* Default: ['esm', 'cjs']
|
|
367
|
-
*/
|
|
368
|
-
outputFormat: ["esm"],
|
|
369
|
-
|
|
370
|
-
/**
|
|
371
|
-
* Indicates if the build should check TypeScript types.
|
|
372
|
-
* Default: false
|
|
373
|
-
*/
|
|
374
|
-
checkTypes: false,
|
|
375
|
-
},
|
|
376
|
-
|
|
377
|
-
/**
|
|
378
|
-
* Logger configuration.
|
|
379
|
-
*/
|
|
380
|
-
log: {
|
|
381
|
-
/**
|
|
382
|
-
* Logging level.
|
|
383
|
-
* - "default": Standard logging.
|
|
384
|
-
* - "verbose": Detailed debug logging.
|
|
385
|
-
* - "disabled": No logging.
|
|
386
|
-
* Default: "default"
|
|
387
|
-
*/
|
|
388
|
-
mode: "default",
|
|
389
|
-
|
|
390
|
-
/**
|
|
391
|
-
* Prefix for all log messages.
|
|
392
|
-
* Default: "[intlayer]"
|
|
393
|
-
*/
|
|
394
|
-
prefix: "[intlayer]",
|
|
395
|
-
},
|
|
396
|
-
|
|
397
|
-
/**
|
|
398
|
-
* System configuration (Advanced use cases)
|
|
399
|
-
*/
|
|
400
|
-
system: {
|
|
401
|
-
/**
|
|
402
|
-
* Directory for storing localization dictionaries.
|
|
403
|
-
*/
|
|
404
|
-
dictionariesDir: ".intlayer/dictionary",
|
|
405
|
-
|
|
406
|
-
/**
|
|
407
|
-
* Directory for module augmentation.
|
|
408
|
-
*/
|
|
409
|
-
moduleAugmentationDir: ".intlayer/types",
|
|
410
|
-
|
|
411
|
-
/**
|
|
412
|
-
* Directory for storing unmerged dictionaries.
|
|
413
|
-
*/
|
|
414
|
-
unmergedDictionariesDir: ".intlayer/unmerged_dictionary",
|
|
415
|
-
|
|
416
|
-
/**
|
|
417
|
-
* Directory for storing dictionary types.
|
|
418
|
-
*/
|
|
419
|
-
typesDir: ".intlayer/types",
|
|
420
|
-
|
|
421
|
-
/**
|
|
422
|
-
* Directory where main application files are stored.
|
|
423
|
-
*/
|
|
424
|
-
mainDir: ".intlayer/main",
|
|
425
|
-
|
|
426
|
-
/**
|
|
427
|
-
* Directory where the configuration files are stored.
|
|
428
|
-
*/
|
|
429
|
-
configDir: ".intlayer/config",
|
|
430
|
-
|
|
431
|
-
/**
|
|
432
|
-
* Directory where the cache files are stored.
|
|
433
|
-
*/
|
|
434
|
-
cacheDir: ".intlayer/cache",
|
|
435
|
-
},
|
|
436
|
-
|
|
437
|
-
/**
|
|
438
|
-
* Compiler configuration (Advanced use cases)
|
|
439
|
-
*/
|
|
440
|
-
compiler: {
|
|
441
|
-
/**
|
|
442
|
-
* コンパイラを有効にするかどうかを示します。
|
|
443
|
-
*
|
|
444
|
-
* - false : コンパイラを無効にします。
|
|
445
|
-
* - true : コンパイラを有効にします。
|
|
446
|
-
* - "build-only" : 開発中のコンパイラをスキップして起動時間を短縮します。
|
|
447
|
-
*
|
|
448
|
-
* デフォルト : false
|
|
449
|
-
*/
|
|
450
|
-
enabled: true,
|
|
451
|
-
|
|
452
|
-
/**
|
|
453
|
-
* 出力ファイルのパスを定義します。 `outputDir` を置き換えます。
|
|
454
|
-
*
|
|
455
|
-
* - `./` で始まるパスは、コンポーネントディレクトリを基準に解決されます。
|
|
456
|
-
* - `/` で始まるパスは、プロジェクトのルート (`baseDir`) を基準に解決されます。
|
|
457
|
-
*
|
|
458
|
-
* - パスに `{{locale}}` 変数を含めると、言語ごとに分離された辞書の生成が有効になります。
|
|
459
|
-
*
|
|
460
|
-
* 例:
|
|
461
|
-
* ```ts
|
|
462
|
-
* {
|
|
463
|
-
* // コンポーネントの隣に多言語対応の .content.ts ファイルを作成
|
|
464
|
-
* output: ({ fileName, extension }) => `./${fileName}${extension}`,
|
|
465
|
-
*
|
|
466
|
-
* // output: './{{fileName}}{{extension}}', // 文字列テンプレートを使用した同等の記述
|
|
467
|
-
* }
|
|
468
|
-
* ```
|
|
469
|
-
*
|
|
470
|
-
* ```ts
|
|
471
|
-
* {
|
|
472
|
-
* // プロジェクトのルートに言語ごとに集約された JSON ファイルを作成
|
|
473
|
-
* output: ({ key, locale }) => `/locales/${locale}/${key}.content.json`,
|
|
474
|
-
*
|
|
475
|
-
* // output: '/locales/{{locale}}/{{key}}.content.json', // 文字列テンプレートを使用した同等の記述
|
|
476
|
-
* }
|
|
477
|
-
* ```
|
|
478
|
-
*
|
|
479
|
-
* 変数リスト:
|
|
480
|
-
* - `fileName`: ファイル名。
|
|
481
|
-
* - `key`: コンテンツのキー。
|
|
482
|
-
* - `locale`: コンテンツのロケール。
|
|
483
|
-
* - `extension`: ファイル拡張子。
|
|
484
|
-
* - `componentFileName`: コンポーネントファイル名。
|
|
485
|
-
* - `componentExtension`: コンポーネント拡張子。
|
|
486
|
-
* - `format`: 辞書の形式。
|
|
487
|
-
* - `componentFormat`: コンポーネント辞書の形式。
|
|
488
|
-
* - `componentDirPath`: コンポーネントのディレクトリパス。
|
|
489
|
-
*/
|
|
490
|
-
output: ({ locale, key }) => `compiler/${locale}/${key}.json`,
|
|
491
|
-
|
|
492
|
-
/**
|
|
493
|
-
* 変換後にコンポーネントを保存するかどうかを示します。
|
|
494
|
-
* これにより、コンパイラを1回だけ実行してアプリを変換し、その後削除することができます。
|
|
495
|
-
*/
|
|
496
|
-
saveComponents: false,
|
|
497
|
-
|
|
498
|
-
/**
|
|
499
|
-
* 生成されたファイルにコンテンツのみを挿入します。
|
|
500
|
-
*/
|
|
501
|
-
noMetadata: false,
|
|
502
|
-
|
|
503
|
-
/**
|
|
504
|
-
* 辞書キーのプレフィックス
|
|
505
|
-
*/
|
|
506
|
-
dictionaryKeyPrefix: "", // すべての辞書キーにプレフィックスを設定
|
|
507
|
-
},
|
|
508
|
-
|
|
509
|
-
/**
|
|
510
|
-
* Custom schemas to validate the dictionaries content.
|
|
511
|
-
*/
|
|
512
|
-
schemas: {
|
|
513
|
-
"my-schema": z.object({
|
|
514
|
-
title: z.string(),
|
|
515
|
-
}),
|
|
516
|
-
},
|
|
517
|
-
|
|
518
|
-
/**
|
|
519
|
-
* Plugins configuration.
|
|
520
|
-
*/
|
|
521
|
-
plugins: [],
|
|
522
|
-
};
|
|
523
|
-
|
|
524
|
-
export default config;
|
|
525
|
-
````
|
|
526
|
-
|
|
527
|
-
## 設定リファレンス
|
|
528
|
-
|
|
529
|
-
以下のセクションでは、Intlayerで利用可能なさまざまな設定項目について説明します。
|
|
530
|
-
|
|
531
|
-
---
|
|
532
|
-
|
|
533
|
-
### 国際化設定
|
|
534
|
-
|
|
535
|
-
国際化に関連する設定を定義します。利用可能なロケールやアプリケーションのデフォルトロケールを含みます。
|
|
536
|
-
|
|
537
|
-
#### プロパティ
|
|
538
|
-
|
|
539
|
-
- **locales**:
|
|
540
|
-
- _型_: `string[]`
|
|
541
|
-
- _デフォルト_: `['en']`
|
|
542
|
-
- _説明_: アプリケーションでサポートされているロケールのリスト。
|
|
543
|
-
- _例_: `['en', 'fr', 'es']`
|
|
544
|
-
|
|
545
|
-
- **requiredLocales**:
|
|
546
|
-
- _型_: `string[]`
|
|
547
|
-
- _デフォルト_: `[]`
|
|
548
|
-
- _説明_: アプリケーションで必須とされるロケールのリスト。
|
|
549
|
-
- _例_: `[]`
|
|
550
|
-
- _注意_: 空の場合、`strict` モードではすべてのロケールが必須となります。
|
|
551
|
-
- _注意_: 必須のロケールは `locales` フィールドにも定義されていることを確認してください。
|
|
552
|
-
- **strictMode**:
|
|
553
|
-
- _型_: `string`
|
|
554
|
-
- _デフォルト_: `inclusive`
|
|
555
|
-
- _説明_: TypeScriptを使用して国際化コンテンツの強力な実装を保証します。
|
|
556
|
-
- _注意_: "strict" に設定すると、翻訳関数 `t` は宣言されたすべてのロケールが定義されていることを要求します。ロケールが1つでも欠けているか、設定に宣言されていないロケールがある場合はエラーをスローします。
|
|
557
|
-
- _注意_: "inclusive" に設定すると、翻訳関数 `t` は宣言されたすべてのロケールが定義されていることを要求します。ロケールが1つでも欠けている場合は警告を出します。ただし、設定に宣言されていないが存在するロケールは許容します。
|
|
558
|
-
- _注意_: "loose" に設定すると、翻訳関数 `t` は存在する任意のロケールを受け入れます。
|
|
559
|
-
|
|
560
|
-
- **defaultLocale**:
|
|
561
|
-
- _タイプ_: `string`
|
|
562
|
-
- _デフォルト_: `'en'`
|
|
563
|
-
- _説明_: 要求されたロケールが見つからない場合にフォールバックとして使用されるデフォルトのロケール。
|
|
564
|
-
- _例_: `'en'`
|
|
565
|
-
- _注意_: URL、クッキー、またはヘッダーでロケールが指定されていない場合に、どのロケールを使用するかを決定するために使用されます。
|
|
566
|
-
|
|
567
|
-
---
|
|
568
|
-
|
|
569
|
-
### エディター設定
|
|
570
|
-
|
|
571
|
-
統合エディターに関連する設定を定義します。サーバーポートやアクティブ状態などが含まれます。
|
|
572
|
-
|
|
573
|
-
#### プロパティ
|
|
574
|
-
|
|
575
|
-
- **applicationURL**:
|
|
576
|
-
- _タイプ_: `string`
|
|
577
|
-
- _デフォルト_: `http://localhost:3000`
|
|
578
|
-
- _説明_: アプリケーションのURL。セキュリティ上の理由からエディターのオリジンを制限するために使用されます。
|
|
579
|
-
- _例_:
|
|
580
|
-
- `'http://localhost:3000'`
|
|
581
|
-
- `'https://example.com'`
|
|
582
|
-
- `process.env.INTLAYER_EDITOR_URL`
|
|
583
|
-
- _注意_: アプリケーションのURL。セキュリティ上の理由からエディターのオリジンを制限するために使用されます。`'*'`に設定すると、どのオリジンからでもエディターにアクセス可能になります。
|
|
584
|
-
|
|
585
|
-
- **port**:
|
|
586
|
-
- _タイプ_: `number`
|
|
587
|
-
- _デフォルト_: `8000`
|
|
588
|
-
- _説明_: ビジュアルエディターサーバーが使用するポート。
|
|
589
|
-
|
|
590
|
-
- **editorURL**:
|
|
591
|
-
- _タイプ_: `string`
|
|
592
|
-
- _デフォルト_: `'http://localhost:8000'`
|
|
593
|
-
- _説明_: エディターサーバーのURL。セキュリティ上の理由からエディターのオリジンを制限するために使用されます。
|
|
594
|
-
- `'http://localhost:3000'`
|
|
595
|
-
- `'https://example.com'`
|
|
596
|
-
- `process.env.INTLAYER_EDITOR_URL`
|
|
597
|
-
- _注_: アプリケーションからアクセスするエディターサーバーのURL。セキュリティ上の理由から、アプリケーションとやり取りできるオリジンを制限するために使用されます。`'*'`に設定すると、エディターは任意のオリジンからアクセス可能になります。ポートを変更した場合やエディターが異なるドメインでホストされている場合に設定する必要があります。
|
|
598
|
-
|
|
599
|
-
- **cmsURL**:
|
|
600
|
-
- _型_: `string`
|
|
601
|
-
- _デフォルト_: `'https://intlayer.org'`
|
|
602
|
-
- _説明_: Intlayer CMSのURL。
|
|
603
|
-
- _例_: `'https://intlayer.org'`
|
|
604
|
-
- _注_: Intlayer CMSのURL。
|
|
605
|
-
|
|
606
|
-
- **backendURL**:
|
|
607
|
-
- _型_: `string`
|
|
608
|
-
- _デフォルト_: `https://back.intlayer.org`
|
|
609
|
-
- _説明_: バックエンドサーバーのURL。
|
|
610
|
-
- _例_: `http://localhost:4000`
|
|
611
|
-
|
|
612
|
-
- **enabled**:
|
|
613
|
-
- _型_: `boolean`
|
|
614
|
-
- _デフォルト_: `true`
|
|
615
|
-
- _説明_: アプリケーションがビジュアルエディターと連携するかどうかを示します。
|
|
616
|
-
- _例_: `process.env.NODE_ENV !== 'production'`
|
|
617
|
-
- _注意_: true の場合、エディターはアプリケーションと連携可能です。false の場合、エディターはアプリケーションと連携できません。いずれの場合も、エディターはビジュアルエディターによってのみ有効化されます。特定の環境でエディターを無効にすることは、セキュリティを強化する方法の一つです。
|
|
618
|
-
|
|
619
|
-
- **clientId**:
|
|
620
|
-
- _タイプ_: `string` | `undefined`
|
|
621
|
-
- _デフォルト_: `undefined`
|
|
622
|
-
- _説明_: clientId と clientSecret は、intlayer パッケージが oAuth2 認証を使用してバックエンドと認証するために使用されます。アクセストークンは、プロジェクトに関連するユーザーを認証するために使用されます。アクセストークンを取得するには、https://app.intlayer.org/project にアクセスしてアカウントを作成してください。
|
|
623
|
-
- _例_: `true`
|
|
624
|
-
- _注意_: 重要: clientId と clientSecret は秘密にしておく必要があり、公開しないでください。環境変数などの安全な場所に保管することをお勧めします。
|
|
625
|
-
|
|
626
|
-
- **clientSecret**:
|
|
627
|
-
- _タイプ_: `string` | `undefined`
|
|
628
|
-
- _デフォルト_: `undefined`
|
|
629
|
-
- _説明_: clientId と clientSecret は、intlayer パッケージが oAuth2 認証を使用してバックエンドと認証するために使用されます。アクセストークンは、プロジェクトに関連するユーザーを認証するために使用されます。アクセストークンを取得するには、https://app.intlayer.org/project にアクセスしてアカウントを作成してください。
|
|
630
|
-
- _例_: `true`
|
|
631
|
-
- _注意_: 重要: clientId と clientSecret は秘密にしておく必要があり、公開しないでください。環境変数などの安全な場所に保管することを推奨します。
|
|
632
|
-
|
|
633
|
-
- **dictionaryPriorityStrategy**:
|
|
634
|
-
- _タイプ_: `string`
|
|
635
|
-
- _デフォルト_: `'local_first'`
|
|
636
|
-
- _説明_: ローカル辞書と遠隔辞書の両方が存在する場合に、どちらを優先するかの戦略です。`'distant_first'` に設定すると、アプリケーションは遠隔辞書をローカル辞書より優先します。`'local_first'` に設定すると、アプリケーションはローカル辞書を遠隔辞書より優先します。
|
|
637
|
-
- _例_: `'distant_first'`
|
|
638
|
-
|
|
639
|
-
- **liveSync**:
|
|
640
|
-
- _型_: `boolean`
|
|
641
|
-
- _デフォルト_: `false`
|
|
642
|
-
- _説明_: CMS / ビジュアルエディター / バックエンドで変更が検出された際に、アプリケーションサーバーがコンテンツをホットリロードするかどうかを示します。
|
|
643
|
-
- _例_: `true`
|
|
644
|
-
- _注意_: 例えば、新しい辞書が追加または更新された場合、アプリケーションはページに表示するコンテンツを更新します。
|
|
645
|
-
- _注記_: ライブ同期はアプリケーションのコンテンツを別のサーバーに外部化する必要があります。これはアプリケーションのパフォーマンスにわずかな影響を与える可能性があります。これを制限するために、アプリケーションとライブ同期サーバーを同じマシン上にホストすることを推奨します。また、ライブ同期と `optimize` の組み合わせはライブ同期サーバーへのリクエスト数を大幅に増加させる可能性があります。インフラストラクチャに応じて、両方のオプションおよびその組み合わせをテストすることを推奨します。
|
|
646
|
-
|
|
647
|
-
- **liveSyncPort**:
|
|
648
|
-
- _タイプ_: `number`
|
|
649
|
-
- _デフォルト_: `4000`
|
|
650
|
-
- _説明_: ライブ同期サーバーのポート番号。
|
|
651
|
-
- _例_: `4000`
|
|
652
|
-
- _注記_: ライブ同期サーバーのポート番号。
|
|
653
|
-
|
|
654
|
-
- **liveSyncURL**:
|
|
655
|
-
- _タイプ_: `string`
|
|
656
|
-
- _デフォルト_: `'http://localhost:{liveSyncPort}'`
|
|
657
|
-
- _説明_: ライブシンクサーバーのURL。
|
|
658
|
-
- _例_: `'https://example.com'`
|
|
659
|
-
- _注意_: デフォルトではlocalhostを指しますが、リモートのライブシンクサーバーの場合は任意のURLに変更可能です。
|
|
660
|
-
|
|
661
|
-
### ミドルウェア設定
|
|
662
|
-
|
|
663
|
-
ミドルウェアの動作を制御する設定で、アプリケーションがクッキー、ヘッダー、ロケール管理のためのURLプレフィックスをどのように扱うかを含みます。
|
|
664
|
-
|
|
665
|
-
#### プロパティ
|
|
666
|
-
|
|
667
|
-
- **headerName**:
|
|
668
|
-
- _型_: `string`
|
|
669
|
-
- _デフォルト_: `'x-intlayer-locale'`
|
|
670
|
-
- _説明_: ロケールを判定するために使用されるHTTPヘッダーの名前。
|
|
671
|
-
- _例_: `'x-custom-locale'`
|
|
672
|
-
- _注意_: APIベースのロケール判定に便利です。
|
|
673
|
-
|
|
674
|
-
- **cookieName**:
|
|
675
|
-
- _型_: `string`
|
|
676
|
-
- _デフォルト_: `'intlayer-locale'`
|
|
677
|
-
- _説明_: ロケールを保存するために使用されるクッキーの名前。
|
|
678
|
-
- _例_: `'custom-locale'`
|
|
679
|
-
- _注意_: セッション間でロケールを保持するために使用されます。
|
|
680
|
-
|
|
681
|
-
- **prefixDefault**:
|
|
682
|
-
- _タイプ_: `boolean`
|
|
683
|
-
- _デフォルト_: `false`
|
|
684
|
-
- _説明_: デフォルトのロケールをURLに含めるかどうか。
|
|
685
|
-
- _例_: `true`
|
|
686
|
-
- _注意_:
|
|
687
|
-
- `true` かつ `defaultLocale = 'en'` の場合: パスは `/en/dashboard` または `/fr/dashboard`
|
|
688
|
-
- `false` かつ `defaultLocale = 'en'` の場合: パスは `/dashboard` または `/fr/dashboard`
|
|
689
|
-
|
|
690
|
-
- **basePath**:
|
|
691
|
-
- _タイプ_: `string`
|
|
692
|
-
- _デフォルト_: `''`
|
|
693
|
-
- _説明_: アプリケーションのURLのベースパス。
|
|
694
|
-
- _例_: `'/my-app'`
|
|
695
|
-
- _注意_:
|
|
696
|
-
- アプリケーションが `https://example.com/my-app` にホストされている場合
|
|
697
|
-
- ベースパスは `'/my-app'`
|
|
698
|
-
- URLは `https://example.com/my-app/en` となります
|
|
699
|
-
- ベースパスが設定されていない場合、URLは `https://example.com/en` となります
|
|
700
|
-
|
|
701
|
-
- **rewrite**:
|
|
702
|
-
- _タイプ_: `Record<string, StrictModeLocaleMap<string>>`
|
|
703
|
-
- _デフォルト_: `undefined`
|
|
704
|
-
- _説明_: 特定のパスのデフォルトルーティングモードを上書きするカスタムURL書き換えルール。標準のルーティング動作とは異なる言語固有のパスを定義できます。`[param]` 構文を使用した動的ルートパラメータをサポートします。
|
|
705
|
-
- _例_:
|
|
706
|
-
```typescript
|
|
707
|
-
routing: {
|
|
708
|
-
mode: "prefix-no-default", // フォールバック戦略
|
|
709
|
-
rewrite: nextjsRewrite({
|
|
710
|
-
"/[locale]/about": {
|
|
711
|
-
en: "/[locale]/about",
|
|
712
|
-
fr: "/[locale]/a-propos",
|
|
713
|
-
},
|
|
714
|
-
"/[locale]/product/[slug]": {
|
|
715
|
-
en: "/[locale]/product/[slug]",
|
|
716
|
-
fr: "/[locale]/produit/[slug]",
|
|
717
|
-
},
|
|
718
|
-
"/[locale]/blog/[category]/[id]": {
|
|
719
|
-
en: "/[locale]/blog/[category]/[id]",
|
|
720
|
-
fr: "/[locale]/journal/[category]/[id]",
|
|
721
|
-
},
|
|
722
|
-
}),
|
|
723
|
-
}
|
|
724
|
-
```
|
|
725
|
-
- _注意_: 書き換えルールはデフォルトの `mode` 動作よりも優先されます。パスが書き換えルールに一致する場合、標準の言語プレフィックスの代わりに書き換え設定のローカライズされたパスが使用されます。
|
|
726
|
-
- _注意_: 動的ルートパラメータは角括弧表記(例:`[slug]`、`[id]`)を使用してサポートされます。パラメータ値はURLから自動的に抽出され、書き換えられたパスに補間されます。
|
|
727
|
-
- _注意_: Next.js と Vite アプリケーションで動作します。ミドルウェア/プロキシは、内部ルート構造に一致するように受信リクエストを自動的に書き換えます。
|
|
728
|
-
- _注意_: `getLocalizedUrl()` でURLを生成する場合、提供されたパスに一致する場合、書き換えルールが自動的に適用されます。
|
|
729
|
-
- _参照_: 詳細については、[カスタムURL書き換え](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ja/custom_url_rewrites.md)を参照してください。
|
|
730
|
-
|
|
731
|
-
- **serverSetCookie**:
|
|
732
|
-
- _タイプ_: `string`
|
|
733
|
-
- _デフォルト_: `'always'`
|
|
734
|
-
- _説明_: サーバー側でロケールクッキーを設定するルール。
|
|
735
|
-
- _オプション_: `'always'`, `'never'`
|
|
736
|
-
- _例_: `'never'`
|
|
737
|
-
- _注意_: ロケールクッキーをすべてのリクエストで設定するか、まったく設定しないかを制御します。
|
|
738
|
-
|
|
739
|
-
- **noPrefix**:
|
|
740
|
-
- _タイプ_: `boolean`
|
|
741
|
-
- _デフォルト_: `false`
|
|
742
|
-
- _説明_: URLからロケールのプレフィックスを省略するかどうか。
|
|
743
|
-
- _例_: `true`
|
|
744
|
-
- _注意_:
|
|
745
|
-
- `true` の場合: URLにプレフィックスはありません
|
|
746
|
-
- `false` の場合: URLにプレフィックスがあります
|
|
747
|
-
- `basePath = '/my-app'` の例:
|
|
748
|
-
- `noPrefix = false` の場合: URLは `https://example.com/my-app/en`
|
|
749
|
-
- `noPrefix = true` の場合: URLは `https://example.com`
|
|
750
|
-
|
|
751
|
-
---
|
|
752
|
-
|
|
753
|
-
### コンテンツ設定
|
|
754
|
-
|
|
755
|
-
アプリケーション内のコンテンツ処理に関連する設定。ディレクトリ名、ファイル拡張子、および派生設定を含みます。
|
|
756
|
-
|
|
757
|
-
#### プロパティ
|
|
758
|
-
|
|
759
|
-
- **autoFill**:
|
|
760
|
-
- _型_: `boolean | string | FilePathPattern | { [key in Locales]?: string }`
|
|
761
|
-
- _デフォルト_: `undefined`
|
|
762
|
-
- _説明_: コンテンツをAIを使って自動的にどのように埋めるかを示します。`intlayer.config.ts`ファイルでグローバルに宣言することができます。
|
|
763
|
-
- _例_: true
|
|
764
|
-
- _例_: `'./{{fileName}}.content.json'`
|
|
765
|
-
- _例_: `{ fr: './{{fileName}}.fr.content.json', es: './{{fileName}}.es.content.json' }`
|
|
766
|
-
- _注意_: 自動埋め設定は以下のいずれかです:
|
|
767
|
-
- boolean: すべてのロケールで自動埋めを有効にする
|
|
768
|
-
- string: 単一ファイルのパスまたは変数を含むテンプレート
|
|
769
|
-
- object: ロケールごとのファイルパス
|
|
770
|
-
|
|
771
|
-
- **watch**:
|
|
772
|
-
- _型_: `boolean`
|
|
773
|
-
- _デフォルト_: `process.env.NODE_ENV === 'development'`
|
|
774
|
-
- _説明_: Intlayerがアプリ内のコンテンツ宣言ファイルの変更を監視し、関連する辞書を再構築するかどうかを示します。
|
|
775
|
-
|
|
776
|
-
- **fileExtensions**:
|
|
777
|
-
- _型_: `string[]`
|
|
778
|
-
- _デフォルト_: `['.content.ts', '.content.js', '.content.cjs', '.content.mjs', '.content.json', '.content.tsx', '.content.jsx']`
|
|
779
|
-
- _説明_: 辞書を構築する際に探すファイル拡張子。
|
|
780
|
-
- _例_: `['.data.ts', '.data.js', '.data.json']`
|
|
781
|
-
- _注意_: ファイル拡張子をカスタマイズすることで競合を回避できます。
|
|
782
|
-
|
|
783
|
-
- **dictionaryOutput**:
|
|
784
|
-
- _タイプ_: `string[]`
|
|
785
|
-
- _デフォルト_: `['intlayer']`
|
|
786
|
-
- _説明_: 使用する辞書出力のタイプ。例:`'intlayer'` または `'i18next'`。
|
|
787
|
-
|
|
788
|
-
- **contentDir**:
|
|
789
|
-
- _タイプ_: `string[]`
|
|
790
|
-
- _デフォルト_: `['.']`
|
|
791
|
-
- _例_: `['src', '../../ui-library', require.resolve("@my-package/content")]`
|
|
792
|
-
- _説明_: コンテンツ定義ファイル(`.content.*`)が保存されているディレクトリパス。
|
|
793
|
-
- _注意_: これは辞書を再構築するためにコンテンツファイルを監視するために使用されます。
|
|
794
|
-
|
|
795
|
-
- **codeDir**:
|
|
796
|
-
- _タイプ_: `string[]`
|
|
797
|
-
- _デフォルト_: `['.']`
|
|
798
|
-
- _例_: `['src', '../../ui-library']`
|
|
799
|
-
- _説明_: コードが保存されているディレクトリパス(ベースディレクトリからの相対パス)。
|
|
800
|
-
- _注意_: これはコードファイルを変換(プルーン、最適化)するために監視するために使用されます。これを `contentDir` から分離しておくことで、コンテンツファイルの不要なスキャンを避けることでビルドパフォーマンスを向上させることができます。
|
|
801
|
-
|
|
802
|
-
- **dictionariesDir**:
|
|
803
|
-
- _タイプ_: `string`
|
|
804
|
-
- _デフォルト_: `'.intlayer/dictionaries'`
|
|
805
|
-
- _説明_: 中間結果または出力結果を保存するためのディレクトリパス。
|
|
806
|
-
|
|
807
|
-
- **moduleAugmentationDir**:
|
|
808
|
-
- _タイプ_: `string`
|
|
809
|
-
- _デフォルト_: `'.intlayer/types'`
|
|
810
|
-
- _説明_: モジュール拡張用のディレクトリで、IDEの補完や型チェックを向上させるためのもの。
|
|
811
|
-
- _例_: `'intlayer-types'`
|
|
812
|
-
- _注意_: これを必ず `tsconfig.json` に含めてください。
|
|
813
|
-
|
|
814
|
-
- **unmergedDictionariesDir**:
|
|
815
|
-
- _タイプ_: `string`
|
|
816
|
-
- _デフォルト_: `'.intlayer/unmerged_dictionary'`
|
|
817
|
-
- _説明_: マージされていない辞書を保存するためのディレクトリ。
|
|
818
|
-
- _例_: `'translations'`
|
|
819
|
-
|
|
820
|
-
- **dictionariesDir**:
|
|
821
|
-
- _タイプ_: `string`
|
|
822
|
-
- _デフォルト_: `'.intlayer/dictionary'`
|
|
823
|
-
- _説明_: ローカリゼーション辞書を格納するディレクトリ。
|
|
824
|
-
- _例_: `'translations'`
|
|
825
|
-
|
|
826
|
-
- **i18nextResourcesDir**:
|
|
827
|
-
- _タイプ_: `string`
|
|
828
|
-
- _デフォルト_: `'i18next_dictionary'`
|
|
829
|
-
- _説明_: i18n辞書を格納するディレクトリ。
|
|
830
|
-
- _例_: `'translations'`
|
|
831
|
-
- _注意_: このディレクトリがi18nextの出力タイプ用に設定されていることを確認してください。
|
|
832
|
-
|
|
833
|
-
- **typesDir**:
|
|
834
|
-
- _タイプ_: `string`
|
|
835
|
-
- _デフォルト_: `'types'`
|
|
836
|
-
- _説明_: 辞書の型を格納するディレクトリ。
|
|
837
|
-
- _例_: `'intlayer-types'`
|
|
838
|
-
|
|
839
|
-
- **mainDir**:
|
|
840
|
-
- _タイプ_: `string`
|
|
841
|
-
- _デフォルト_: `'main'`
|
|
842
|
-
- _説明_: メインアプリケーションファイルが格納されるディレクトリ。
|
|
843
|
-
- _例_: `'intlayer-main'`
|
|
844
|
-
|
|
845
|
-
- **excludedPath**:
|
|
846
|
-
- _タイプ_: `string[]`
|
|
847
|
-
- _デフォルト_: `['node_modules']`
|
|
848
|
-
- _説明_: コンテンツ検索から除外するディレクトリ。
|
|
849
|
-
- _注意_: この設定はまだ使用されていませんが、将来的に実装予定です。
|
|
850
|
-
|
|
851
|
-
---
|
|
852
|
-
|
|
853
|
-
### システム設定
|
|
854
|
-
|
|
855
|
-
Intlayerの内部パスと出力結果に関連する設定。これらの設定は通常内部的なものであり、ユーザーが変更する必要はありません。
|
|
856
|
-
|
|
857
|
-
#### プロパティ
|
|
858
|
-
|
|
859
|
-
- **baseDir**:
|
|
860
|
-
- _タイプ_: `string`
|
|
861
|
-
- _デフォルト_: `process.cwd()`
|
|
862
|
-
- _説明_: プロジェクトのベースディレクトリ。
|
|
863
|
-
- _例_: `'/path/to/project'`
|
|
864
|
-
- _注意_: これはすべてのIntlayer関連ディレクトリを解決するために使用されます。
|
|
865
|
-
|
|
866
|
-
### 辞書設定
|
|
867
|
-
|
|
868
|
-
自動入力の動作やコンテンツ生成を含む、辞書操作を制御する設定。
|
|
869
|
-
|
|
870
|
-
この辞書設定には、主に2つの目的があります:
|
|
871
|
-
|
|
872
|
-
1. **デフォルト値**: コンテンツ宣言ファイルを作成する際のデフォルト値を定義
|
|
873
|
-
2. **フォールバック動作**: 特定のフィールドが定義されていない場合のフォールバック値を提供し、辞書操作の動作をグローバルに定義できるようにする
|
|
874
|
-
|
|
875
|
-
コンテンツ宣言ファイルと設定値の適用方法の詳細については、[コンテンツファイルのドキュメント](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ja/dictionary/content_file.md)を参照してください。
|
|
876
|
-
|
|
877
|
-
#### プロパティ
|
|
878
|
-
|
|
879
|
-
- **fill**
|
|
880
|
-
- **description**
|
|
881
|
-
- **locale**
|
|
882
|
-
- **location**
|
|
883
|
-
- **priority**
|
|
884
|
-
- **live**
|
|
885
|
-
- **schema**
|
|
886
|
-
- **title**
|
|
887
|
-
- **tags**
|
|
888
|
-
- **version**
|
|
889
|
-
|
|
890
|
-
---
|
|
891
|
-
|
|
892
|
-
### ロガー設定
|
|
893
|
-
|
|
894
|
-
ロガーを制御する設定で、使用するプレフィックスも含みます。
|
|
895
|
-
|
|
896
|
-
#### プロパティ
|
|
897
|
-
|
|
898
|
-
- **mode**:
|
|
899
|
-
- _タイプ_: `string`
|
|
900
|
-
- _デフォルト_: `default`
|
|
901
|
-
- _説明_: ロガーのモードを示します。
|
|
902
|
-
- _オプション_: `default`, `verbose`, `disabled`
|
|
903
|
-
- _例_: `default`
|
|
904
|
-
- _注意_: ロガーのモードです。verboseモードはより多くの情報をログに記録しますが、デバッグ目的で使用されます。disabledモードはロガーを無効にします。
|
|
905
|
-
|
|
906
|
-
- **prefix**:
|
|
907
|
-
- _タイプ_: `string`
|
|
908
|
-
- _デフォルト_: `'[intlayer] '`
|
|
909
|
-
- _説明_: ロガーのプレフィックス。
|
|
910
|
-
- _例_: `'[my custom prefix] '`
|
|
911
|
-
- _注_: ロガーのプレフィックス。
|
|
912
|
-
|
|
913
|
-
### AI構成
|
|
914
|
-
|
|
915
|
-
IntlayerのAI機能を制御する設定で、プロバイダー、モデル、APIキーを含みます。
|
|
916
|
-
|
|
917
|
-
この設定は、アクセスキーを使用して[Intlayerダッシュボード](https://app.intlayer.org/project)に登録している場合はオプションです。Intlayerは、最も効率的でコスト効果の高いAIソリューションを自動的に管理します。デフォルトのオプションを使用することで、Intlayerが継続的に最適なモデルを使用するように更新されるため、長期的な保守性が向上します。
|
|
918
|
-
|
|
919
|
-
独自のAPIキーや特定のモデルを使用したい場合は、カスタムAI構成を定義できます。
|
|
920
|
-
このAI構成は、Intlayer環境全体でグローバルに使用されます。CLIコマンドはこれらの設定をコマンド(例:`fill`)のデフォルトとして使用し、SDK、ビジュアルエディター、CMSでも同様です。特定のユースケースに対しては、コマンドパラメータを使ってこれらのデフォルト値を上書きすることができます。
|
|
921
|
-
|
|
922
|
-
Intlayerは、柔軟性と選択肢を高めるために複数のAIプロバイダーをサポートしています。現在サポートされているプロバイダーは以下の通りです:
|
|
923
|
-
|
|
924
|
-
- **OpenAI**(デフォルト)
|
|
925
|
-
- **Anthropic Claude**
|
|
926
|
-
- **Mistral AI**
|
|
927
|
-
- **DeepSeek**
|
|
928
|
-
- **Google Gemini**
|
|
929
|
-
- **Meta Llama**
|
|
930
|
-
- **Ollama**
|
|
931
|
-
- **OpenRouter**
|
|
932
|
-
- **Alibaba Cloud**
|
|
933
|
-
- **Fireworks**
|
|
934
|
-
- **Hugging Face**
|
|
935
|
-
- **Groq**
|
|
936
|
-
- **Amazon Bedrock**
|
|
937
|
-
- **Google AI Studio**
|
|
938
|
-
- **Google Vertex**
|
|
939
|
-
- **Together.ai**
|
|
940
|
-
- **ollama**
|
|
941
|
-
|
|
942
|
-
#### プロパティ
|
|
943
|
-
|
|
944
|
-
- **provider**:
|
|
945
|
-
- _タイプ_: `string`
|
|
946
|
-
- _デフォルト_: `'openai'`
|
|
947
|
-
- _説明_: IntlayerのAI機能に使用するプロバイダー。
|
|
948
|
-
- _オプション_: `'openai'`, `'anthropic'`, `'mistral'`, `'deepseek'`, `'gemini'`, `'ollama'`, `'openrouter'`, `'alibaba'`, `'fireworks'`, `'groq'`, `'huggingface'`, `'bedrock'`, `'googleaistudio'`, `'googlevertex'`, `'togetherai'`
|
|
949
|
-
- _例_: `'anthropic'`
|
|
950
|
-
- _注意_: プロバイダーによっては異なるAPIキーが必要であり、料金体系も異なる場合があります。
|
|
951
|
-
|
|
952
|
-
- **model**:
|
|
953
|
-
- _タイプ_: `string`
|
|
954
|
-
- _デフォルト_: なし
|
|
955
|
-
- _説明_: IntlayerのAI機能で使用するモデル。
|
|
956
|
-
- _例_: `'gpt-4o-2024-11-20'`
|
|
957
|
-
- _注意_: 使用するモデルはプロバイダーによって異なります。
|
|
958
|
-
|
|
959
|
-
- **temperature**:
|
|
960
|
-
- _タイプ_: `number`
|
|
961
|
-
- _デフォルト_: なし
|
|
962
|
-
- _説明_: AIの応答のランダム性を制御する温度パラメータ。
|
|
963
|
-
- _例_: `0.1`
|
|
964
|
-
- _注意_: 温度が高いほど、AIの応答はより創造的で予測不可能になります。
|
|
965
|
-
|
|
966
|
-
- **apiKey**:
|
|
967
|
-
- _タイプ_: `string`
|
|
968
|
-
- _デフォルト_: なし
|
|
969
|
-
- _説明_: 選択したプロバイダーのAPIキー。
|
|
970
|
-
- _例_: `process.env.OPENAI_API_KEY`
|
|
971
|
-
- _注意_: 重要: APIキーは秘密にしておく必要があり、公開しないでください。環境変数などの安全な場所に保管することを必ず行ってください。
|
|
972
|
-
|
|
973
|
-
- **applicationContext**:
|
|
974
|
-
- _タイプ_: `string`
|
|
975
|
-
- _デフォルト_: なし
|
|
976
|
-
- _説明_: AIモデルに対してアプリケーションの追加コンテキストを提供し、より正確で文脈に適した翻訳を生成するのに役立ちます。これには、アプリのドメイン、ターゲットユーザー、トーン、特定の用語などの情報が含まれます。
|
|
977
|
-
|
|
978
|
-
- **baseURL**:
|
|
979
|
-
- _タイプ_: `string`
|
|
980
|
-
- _デフォルト_: なし
|
|
981
|
-
- _説明_: AI APIのベースURL。
|
|
982
|
-
- _例_: `'https://api.openai.com/v1'`
|
|
983
|
-
- _注意_: ローカルまたはカスタムのAI APIエンドポイントを指すために使用できます。
|
|
984
|
-
|
|
985
|
-
- **dataSerialization**:
|
|
986
|
-
- _型_: `'json' | 'toon'`
|
|
987
|
-
- _デフォルト_: `'json'`
|
|
988
|
-
- _説明_: IntlayerのAI機能に使用するデータシリアライズ形式。
|
|
989
|
-
- _例_: `'toon'`
|
|
990
|
-
- _注_: `json`: 標準的で信頼性が高い。より多くのトークンを使用します。`toon`: トークン消費が少ないが、JSONほど一貫性がない。
|
|
991
|
-
|
|
992
|
-
### ビルド設定
|
|
993
|
-
|
|
994
|
-
Intlayerがアプリケーションの国際化をどのように最適化しビルドするかを制御する設定。
|
|
995
|
-
|
|
996
|
-
ビルドオプションは `@intlayer/babel` と `@intlayer/swc` プラグインに適用されます。
|
|
997
|
-
|
|
998
|
-
> 開発モードでは、Intlayer は辞書を静的にインポートして、開発体験を簡素化します。
|
|
999
|
-
|
|
1000
|
-
> 最適化された場合、Intlayer は辞書の呼び出しを置き換えてチャンク分割を最適化し、最終バンドルには実際に使用されている辞書のみがインポートされるようにします。
|
|
1001
|
-
|
|
1002
|
-
#### プロパティ
|
|
1003
|
-
|
|
1004
|
-
- **mode**:
|
|
1005
|
-
- _型_: `'auto' | 'manual'`
|
|
1006
|
-
- _デフォルト_: `'auto'`
|
|
1007
|
-
- _説明_: ビルドのモードを制御します。
|
|
1008
|
-
- _例_: `'manual'`
|
|
1009
|
-
- _注意_: 'auto'の場合、アプリケーションがビルドされると自動的にビルドが有効になります。
|
|
1010
|
-
- _注意_: 'manual'の場合、ビルドコマンドが実行されたときにのみビルドが設定されます。
|
|
1011
|
-
- _注意_: 辞書のビルドを無効にするために使用できます。たとえば、Node.js環境での実行を避ける必要がある場合などです。
|
|
1012
|
-
|
|
1013
|
-
- **checkTypes**:
|
|
1014
|
-
- _タイプ_: `boolean`
|
|
1015
|
-
- _デフォルト_: `false`
|
|
1016
|
-
- _説明_: ビルドがTypeScriptの型をチェックし、エラーをログに記録するかどうかを示します。
|
|
1017
|
-
- _注_: これにより、ビルドが遅くなる可能性があります。
|
|
1018
|
-
|
|
1019
|
-
- **optimize**:
|
|
1020
|
-
- _型_: `boolean`
|
|
1021
|
-
- _デフォルト_: `process.env.NODE_ENV === 'production'`
|
|
1022
|
-
- _説明_: ビルドを最適化するかどうかを制御します。
|
|
1023
|
-
- _例_: `true`
|
|
1024
|
-
- _注意_: 有効にすると、Intlayer は辞書のすべての呼び出しを置き換えてチャンク分割を最適化します。これにより、最終バンドルは使用されている辞書のみをインポートします。すべてのインポートは辞書の読み込み時の非同期処理を避けるために静的インポートのまま維持されます。
|
|
1025
|
-
- _注意_: Intlayerは、`useIntlayer`のすべての呼び出しを`importMode`オプションで定義されたモードに置き換え、`getIntlayer`を`getDictionary`に置き換えます。
|
|
1026
|
-
- _注意_: このオプションは`@intlayer/babel`および`@intlayer/swc`プラグインに依存しています。
|
|
1027
|
-
- _注意_: `useIntlayer`の呼び出し内で、すべてのキーが静的に宣言されていることを確認してください。例: `useIntlayer('navbar')`。
|
|
1028
|
-
|
|
1029
|
-
- **outputFormat**:
|
|
1030
|
-
- _型_: `'esm' | 'cjs'`
|
|
1031
|
-
- _デフォルト_: `'esm'`
|
|
1032
|
-
- _説明_: 辞書の出力形式を制御します。
|
|
1033
|
-
- _例_: `'cjs'`
|
|
1034
|
-
- _注意_: 辞書の出力形式。
|
|
1035
|
-
|
|
1036
|
-
- **traversePattern**:
|
|
1037
|
-
- _型_: `string[]`
|
|
1038
|
-
- _デフォルト_: `['**/*.{js,ts,mjs,cjs,jsx,tsx}', '!**/node_modules/**']`
|
|
1039
|
-
- _説明_: 最適化中にどのファイルを走査するかを定義するパターンです。
|
|
1040
|
-
- _例_: `['src/**\/*.{ts,tsx}', '../ui-library/**\/*.{ts,tsx}', '!**/node_modules/**']`
|
|
1041
|
-
- _注意_: 最適化を関連するコードファイルに限定し、ビルドパフォーマンスを向上させるために使用します。
|
|
1042
|
-
- _注意_: `optimize` が無効の場合、このオプションは無視されます。
|
|
1043
|
-
- _注意_: グロブパターンを使用してください。
|
|
1044
|
-
|
|
1045
|
-
---
|
|
1046
|
-
|
|
1047
|
-
### コンパイラ設定
|
|
1048
|
-
|
|
1049
|
-
コンポーネントから直接辞書を抽出する Intlayer コンパイラを制御する設定。
|
|
1050
|
-
|
|
1051
|
-
#### プロパティ
|
|
1052
|
-
|
|
1053
|
-
- **enabled**:
|
|
1054
|
-
- _型_: `boolean | 'build-only'`
|
|
1055
|
-
- _デフォルト_: `true`
|
|
1056
|
-
- _説明_: 辞書を抽出するためにコンパイラを有効にするかどうかを示します。
|
|
1057
|
-
- _例_: `'build-only'`
|
|
1058
|
-
- _注意_: `'build-only'` に設定すると、開発モード中にコンパイラをスキップして起動時間を短縮します。ビルドコマンドでのみ実行されます。
|
|
1059
|
-
|
|
1060
|
-
- **dictionaryKeyPrefix**:
|
|
1061
|
-
- _型_: `string`
|
|
1062
|
-
- _デフォルト_: `''`
|
|
1063
|
-
- _説明_: 抽出された辞書キーのプレフィックス。
|
|
1064
|
-
- _例_: `'my-key-'`
|
|
1065
|
-
- _注意_: 辞書が抽出される際、キーはファイル名に基づいて生成されます。このプレフィックスは、競合を防ぐために生成されたキーに追加されます。
|
|
1066
|
-
|
|
1067
|
-
- **saveComponents**:
|
|
1068
|
-
- _型_: `boolean`
|
|
1069
|
-
- _デフォルト_: `false`
|
|
1070
|
-
- _説明_: 変換後にコンポーネントを保存するかどうかを示します。
|
|
1071
|
-
- _注意_: true の場合、コンパイラは元のファイルを変換後のファイルで置き換えます。これにより、コンパイラを一度だけ実行してアプリケーションを変換し、その後コンパイラを削除することができます。
|
|
1072
|
-
|
|
1073
|
-
- **transformPattern**:
|
|
1074
|
-
- _型_: `string | string[]`
|
|
1075
|
-
- _デフォルト_: `['**/*.{ts,tsx,jsx,js,cjs,mjs,svelte,vue}', '!**/node_modules/**']`
|
|
1076
|
-
- _説明_: 最適化中に走査されるファイルを定義するパターン。
|
|
1077
|
-
- _例_: `['src/**/*.{ts,tsx}', '!**/node_modules/**']`
|
|
1078
|
-
- _注意_: 最適化を関連するコードファイルに限定し、ビルドパフォーマンスを向上させるために使用します。
|
|
1079
|
-
|
|
1080
|
-
- **excludePattern**:
|
|
1081
|
-
- _型_: `string | string[]`
|
|
1082
|
-
- _デフォルト_: `['**/node_modules/**']`
|
|
1083
|
-
- _説明_: 最適化中に除外されるファイルを定義するパターン。
|
|
1084
|
-
- _例_: `['**/node_modules/**', '!**/node_modules/react/**']`
|
|
1085
|
-
|
|
1086
|
-
- **output**:
|
|
1087
|
-
- _型_: `FilePathPattern`
|
|
1088
|
-
- _デフォルト_: `undefined`
|
|
1089
|
-
- _説明_: 出力ファイルのパスを定義します。 `outputDir` を置き換えます。 文字列テンプレートまたは関数を通じて動的変数をサポートします。 サポートされている変数: `{{fileName}}`, `{{key}}`, `{{locale}}`, `{{extension}}`, `{{componentFileName}}`, `{{componentExtension}}`, `{{format}}`, `{{componentFormat}}`, および `{{componentDirPath}}`。
|
|
1090
|
-
- _注_: `./` で始まるパスは、コンポーネントディレクトリを基準に解決されます。 `/` で始まるパスは、プロジェクトのルート (`baseDir`) を基準に解決されます。
|
|
1091
|
-
- _注_: パスに `{{locale}}` 変数を含めると、ロケールごとに分離された辞書の生成が有効になります。
|
|
1092
|
-
- _例_:
|
|
1093
|
-
- **コンポーネントの隣に多言語ファイルを作成**:
|
|
1094
|
-
- 文字列: `'./{{fileName}}{{extension}}'`
|
|
1095
|
-
- 関数: `({ fileName, extension }) => \`./${fileName}${extension}\``
|
|
1096
|
-
|
|
1097
|
-
- **ロケールごとに集約された JSON を出力**:
|
|
1098
|
-
- 文字列: `'/locales/{{locale}}/{{key}}.content.json'`
|
|
1099
|
-
- 関数: `({ key, locale }) => \`/locales/${locale}/${key}.content.json\``
|
|
1100
|
-
|
|
1101
|
-
- **noMetadata**:
|
|
1102
|
-
- _タイプ_: `boolean`
|
|
1103
|
-
- _デフォルト_: `false`
|
|
1104
|
-
- _説明_: メタデータをファイルに保存するかどうかを示します。trueの場合、コンパイラーは辞書のメタデータ(キー、コンテンツラッパー)を保存しません。
|
|
1105
|
-
- _注_: `loadJSON`プラグインを使用する場合に便利です。ロケールごとの i18next または ICU MessageFormat JSON 出力に有用です。
|
|
1106
|
-
- _例_:
|
|
1107
|
-
`true`の場合:
|
|
1108
|
-
```json
|
|
1109
|
-
{
|
|
1110
|
-
"key": "value"
|
|
1111
|
-
}
|
|
1112
|
-
```
|
|
1113
|
-
`false`の場合:
|
|
1114
|
-
```json
|
|
1115
|
-
{
|
|
1116
|
-
"key": "value",
|
|
1117
|
-
"content": {
|
|
1118
|
-
"key": "value"
|
|
1119
|
-
}
|
|
1120
|
-
}
|
|
1121
|
-
```
|