@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/pl/configuration.md
DELETED
|
@@ -1,1226 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
createdAt: 2024-08-13
|
|
3
|
-
updatedAt: 2026-03-12
|
|
4
|
-
title: Konfiguracja
|
|
5
|
-
description: Dowiedz się, jak skonfigurować Intlayer dla swojej aplikacji. Zrozum różne ustawienia i opcje dostępne do dostosowania Intlayer do Twoich potrzeb.
|
|
6
|
-
keywords:
|
|
7
|
-
- Konfiguracja
|
|
8
|
-
- Ustawienia
|
|
9
|
-
- Personalizacja
|
|
10
|
-
- Intlayer
|
|
11
|
-
- Opcje
|
|
12
|
-
slugs:
|
|
13
|
-
- doc
|
|
14
|
-
- concept
|
|
15
|
-
- configuration
|
|
16
|
-
history:
|
|
17
|
-
- version: 8.3.0
|
|
18
|
-
date: 2026-03-11
|
|
19
|
-
changes: Przenieś 'baseDir' z konfiguracji 'content' do konfiguracji 'system'
|
|
20
|
-
- version: 8.2.0
|
|
21
|
-
date: 2026-03-09
|
|
22
|
-
changes: Zaktualizuj opcje kompilatora, dodaj obsługę 'output' i 'noMetadata'
|
|
23
|
-
- version: 8.1.7
|
|
24
|
-
date: 2026-02-25
|
|
25
|
-
changes: Aktualizacja opcji kompilatora
|
|
26
|
-
- version: 8.0.6
|
|
27
|
-
date: 2026-02-12
|
|
28
|
-
changes: Dodaj obsługę dostawców Open Router, Alibaba, Amazon, Google Vertex Bedrock, Fireworks, Groq, Hugging Face i Together.ai
|
|
29
|
-
- version: 8.0.5
|
|
30
|
-
date: 2026-02-06
|
|
31
|
-
changes: Dodano `dataSerialization` do konfiguracji AI
|
|
32
|
-
- version: 8.0.0
|
|
33
|
-
date: 2026-01-22
|
|
34
|
-
changes: Przenieś konfigurację budowania importMode do konfiguracji słownika.
|
|
35
|
-
- version: 8.0.0
|
|
36
|
-
date: 2026-01-18
|
|
37
|
-
changes: Oddziel konfigurację systemu od konfiguracji treści. Przenieś wewnętrzne ścieżki do właściwości `system`. Dodaj `codeDir`, aby oddzielić pliki treści od transformacji kodu.
|
|
38
|
-
- version: 8.0.0
|
|
39
|
-
date: 2026-01-18
|
|
40
|
-
changes: Dodano opcje słownika `location` i `schema`
|
|
41
|
-
- version: 7.5.0
|
|
42
|
-
date: 2025-12-17
|
|
43
|
-
changes: Dodano opcję `buildMode`
|
|
44
|
-
- version: 7.0.0
|
|
45
|
-
date: 2025-10-25
|
|
46
|
-
changes: Dodano konfigurację `dictionary`
|
|
47
|
-
- version: 7.0.0
|
|
48
|
-
date: 2025-10-21
|
|
49
|
-
changes: Zastąpiono konfigurację `middleware` konfiguracją `routing`
|
|
50
|
-
- version: 7.0.0
|
|
51
|
-
date: 2025-10-12
|
|
52
|
-
changes: Dodano opcję `formatCommand`
|
|
53
|
-
- version: 6.2.0
|
|
54
|
-
date: 2025-10-12
|
|
55
|
-
changes: Zaktualizowano opcję `excludedPath`
|
|
56
|
-
- version: 6.0.2
|
|
57
|
-
date: 2025-09-23
|
|
58
|
-
changes: Dodano opcję `outputFormat`
|
|
59
|
-
- version: 6.0.0
|
|
60
|
-
date: 2025-09-21
|
|
61
|
-
changes: Usunięto pole `dictionaryOutput` oraz pole `i18nextResourcesDir`
|
|
62
|
-
- version: 6.0.0
|
|
63
|
-
date: 2025-09-16
|
|
64
|
-
changes: Dodano tryb importu `live`
|
|
65
|
-
- version: 6.0.0
|
|
66
|
-
date: 2025-09-04
|
|
67
|
-
changes: Zastąpiono pole `hotReload` polem `liveSync` oraz dodano pola `liveSyncPort` i `liveSyncURL`
|
|
68
|
-
- version: 5.6.1
|
|
69
|
-
date: 2025-07-25
|
|
70
|
-
changes: Zastąpiono `activateDynamicImport` opcją `importMode`
|
|
71
|
-
- version: 5.6.0
|
|
72
|
-
date: 2025-07-13
|
|
73
|
-
changes: Zmieniono domyślny contentDir z `['src']` na `['.']`
|
|
74
|
-
- version: 5.5.11
|
|
75
|
-
date: 2025-06-29
|
|
76
|
-
changes: Dodano komendy `docs`
|
|
77
|
-
---
|
|
78
|
-
|
|
79
|
-
# Dokumentacja konfiguracji Intlayer
|
|
80
|
-
|
|
81
|
-
## Przegląd
|
|
82
|
-
|
|
83
|
-
Pliki konfiguracyjne Intlayer umożliwiają dostosowanie różnych aspektów wtyczki, takich jak internacjonalizacja, middleware oraz obsługa treści. Ten dokument zawiera szczegółowy opis każdej właściwości w konfiguracji.
|
|
84
|
-
|
|
85
|
-
---
|
|
86
|
-
|
|
87
|
-
## Spis treści
|
|
88
|
-
|
|
89
|
-
<TOC/>
|
|
90
|
-
|
|
91
|
-
---
|
|
92
|
-
|
|
93
|
-
## Obsługiwane formaty plików konfiguracyjnych
|
|
94
|
-
|
|
95
|
-
Intlayer obsługuje formaty plików konfiguracyjnych JSON, JS, MJS oraz TS:
|
|
96
|
-
|
|
97
|
-
- `intlayer.config.ts`
|
|
98
|
-
- `intlayer.config.js`
|
|
99
|
-
- `intlayer.config.json`
|
|
100
|
-
- `intlayer.config.json5`
|
|
101
|
-
- `intlayer.config.jsonc`
|
|
102
|
-
- `intlayer.config.cjs`
|
|
103
|
-
- `intlayer.config.mjs`
|
|
104
|
-
- `.intlayerrc`
|
|
105
|
-
|
|
106
|
-
---
|
|
107
|
-
|
|
108
|
-
## Przykładowy plik konfiguracyjny
|
|
109
|
-
|
|
110
|
-
````typescript fileName="intlayer.config.ts" codeFormat="typescript"
|
|
111
|
-
import { Locales, type IntlayerConfig } from "intlayer";
|
|
112
|
-
import { nextjsRewrite } from "intlayer/routing";
|
|
113
|
-
import { z } from "zod";
|
|
114
|
-
|
|
115
|
-
/**
|
|
116
|
-
* Example Intlayer configuration file showing all available options.
|
|
117
|
-
*/
|
|
118
|
-
const config: IntlayerConfig = {
|
|
119
|
-
/**
|
|
120
|
-
* Configuration for internationalization settings.
|
|
121
|
-
*/
|
|
122
|
-
internationalization: {
|
|
123
|
-
/**
|
|
124
|
-
* List of supported locales in the application.
|
|
125
|
-
* Default: [Locales.ENGLISH]
|
|
126
|
-
*/
|
|
127
|
-
locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
|
|
128
|
-
|
|
129
|
-
/**
|
|
130
|
-
* List of required locales that must be defined in every dictionary.
|
|
131
|
-
* If empty, all locales are required in `strict` mode.
|
|
132
|
-
* Default: []
|
|
133
|
-
*/
|
|
134
|
-
requiredLocales: [Locales.ENGLISH],
|
|
135
|
-
|
|
136
|
-
/**
|
|
137
|
-
* Strictness level for internationalized content.
|
|
138
|
-
* - "strict": Errors if any declared locale is missing or undeclared.
|
|
139
|
-
* - "inclusive": Warnings if a declared locale is missing.
|
|
140
|
-
* - "loose": Accepts any existing locale.
|
|
141
|
-
* Default: "inclusive"
|
|
142
|
-
*/
|
|
143
|
-
strictMode: "inclusive",
|
|
144
|
-
|
|
145
|
-
/**
|
|
146
|
-
* Default locale used as a fallback if the requested locale is not found.
|
|
147
|
-
* Default: Locales.ENGLISH
|
|
148
|
-
*/
|
|
149
|
-
defaultLocale: Locales.ENGLISH,
|
|
150
|
-
},
|
|
151
|
-
|
|
152
|
-
/**
|
|
153
|
-
* Settings that control dictionary operations and fallback behavior.
|
|
154
|
-
*/
|
|
155
|
-
dictionary: {
|
|
156
|
-
/**
|
|
157
|
-
* Controls how dictionaries are imported.
|
|
158
|
-
* - "static": Statically imported at build time.
|
|
159
|
-
* - "dynamic": Dynamically imported using Suspense.
|
|
160
|
-
* - "fetch": Fetched dynamically via the live sync API.
|
|
161
|
-
* Default: "static"
|
|
162
|
-
*/
|
|
163
|
-
importMode: "static",
|
|
164
|
-
|
|
165
|
-
/**
|
|
166
|
-
* Strategy for auto-filling missing translations using AI.
|
|
167
|
-
* Can be a boolean or a path pattern to store filled content.
|
|
168
|
-
* Default: true
|
|
169
|
-
*/
|
|
170
|
-
fill: true,
|
|
171
|
-
|
|
172
|
-
/**
|
|
173
|
-
* Physical location of the dictionary files.
|
|
174
|
-
* - "local": Stored in the local filesystem.
|
|
175
|
-
* - "remote": Stored in the Intlayer CMS.
|
|
176
|
-
* - "hybrid": Stored in the local filesystem and the Intlayer CMS.
|
|
177
|
-
* - "plugin" (or any custom string): Provided by a plugin or a custom source.
|
|
178
|
-
* Default: "local"
|
|
179
|
-
*/
|
|
180
|
-
location: "local",
|
|
181
|
-
|
|
182
|
-
/**
|
|
183
|
-
* Whether to automatically transform content (e.g., Markdown to HTML).
|
|
184
|
-
* Default: false
|
|
185
|
-
*/
|
|
186
|
-
contentAutoTransformation: false,
|
|
187
|
-
},
|
|
188
|
-
|
|
189
|
-
/**
|
|
190
|
-
* Routing and middleware configuration.
|
|
191
|
-
*/
|
|
192
|
-
routing: {
|
|
193
|
-
/**
|
|
194
|
-
* Locale routing strategy.
|
|
195
|
-
* - "prefix-no-default": Prefix all except the default locale (e.g., /dashboard, /fr/dashboard).
|
|
196
|
-
* - "prefix-all": Prefix all locales (e.g., /en/dashboard, /fr/dashboard).
|
|
197
|
-
* - "no-prefix": No locale in the URL.
|
|
198
|
-
* - "search-params": Use ?locale=...
|
|
199
|
-
* Default: "prefix-no-default"
|
|
200
|
-
*/
|
|
201
|
-
mode: "prefix-no-default",
|
|
202
|
-
|
|
203
|
-
/**
|
|
204
|
-
* Where to store the user's selected locale.
|
|
205
|
-
* Options: 'cookie', 'localStorage', 'sessionStorage', 'header', or an array of these.
|
|
206
|
-
* Default: ['cookie', 'header']
|
|
207
|
-
*/
|
|
208
|
-
storage: ["cookie", "header"],
|
|
209
|
-
|
|
210
|
-
/**
|
|
211
|
-
* Base path for the application URLs.
|
|
212
|
-
* Default: ""
|
|
213
|
-
*/
|
|
214
|
-
basePath: "",
|
|
215
|
-
|
|
216
|
-
/**
|
|
217
|
-
* Custom URL rewriting rules for locale-specific paths.
|
|
218
|
-
*/
|
|
219
|
-
rewrite: nextjsRewrite({
|
|
220
|
-
"/[locale]/about": {
|
|
221
|
-
en: "/[locale]/about",
|
|
222
|
-
fr: "/[locale]/a-propos",
|
|
223
|
-
},
|
|
224
|
-
}),
|
|
225
|
-
},
|
|
226
|
-
|
|
227
|
-
/**
|
|
228
|
-
* Settings for finding and processing content files.
|
|
229
|
-
*/
|
|
230
|
-
content: {
|
|
231
|
-
/**
|
|
232
|
-
* File extensions to scan for dictionaries.
|
|
233
|
-
* Default: ['.content.ts', '.content.js', '.content.json', etc.]
|
|
234
|
-
*/
|
|
235
|
-
fileExtensions: [".content.ts", ".content.js", ".content.json"],
|
|
236
|
-
|
|
237
|
-
/**
|
|
238
|
-
* Directories where .content files are located.
|
|
239
|
-
* Default: ["."]
|
|
240
|
-
*/
|
|
241
|
-
contentDir: ["src"],
|
|
242
|
-
|
|
243
|
-
/**
|
|
244
|
-
* Directories where source code is located.
|
|
245
|
-
* Used for build optimization and code transformation.
|
|
246
|
-
* Default: ["."]
|
|
247
|
-
*/
|
|
248
|
-
codeDir: ["src"],
|
|
249
|
-
|
|
250
|
-
/**
|
|
251
|
-
* Patterns to exclude from scanning.
|
|
252
|
-
* Default: ['node_modules', '.intlayer', etc.]
|
|
253
|
-
*/
|
|
254
|
-
excludedPath: ["node_modules"],
|
|
255
|
-
|
|
256
|
-
/**
|
|
257
|
-
* Whether to watch for changes and rebuild dictionaries in development.
|
|
258
|
-
* Default: true in development
|
|
259
|
-
*/
|
|
260
|
-
watch: true,
|
|
261
|
-
|
|
262
|
-
/**
|
|
263
|
-
* Command to format newly created / updated .content files.
|
|
264
|
-
*/
|
|
265
|
-
formatCommand: 'npx prettier --write "{{file}}"',
|
|
266
|
-
},
|
|
267
|
-
|
|
268
|
-
/**
|
|
269
|
-
* Visual Editor configuration.
|
|
270
|
-
*/
|
|
271
|
-
editor: {
|
|
272
|
-
/**
|
|
273
|
-
* Whether the visual editor is enabled.
|
|
274
|
-
* Default: false
|
|
275
|
-
*/
|
|
276
|
-
enabled: true,
|
|
277
|
-
|
|
278
|
-
/**
|
|
279
|
-
* URL of your application for origin validation.
|
|
280
|
-
* Default: ""
|
|
281
|
-
*/
|
|
282
|
-
applicationURL: "http://localhost:3000",
|
|
283
|
-
|
|
284
|
-
/**
|
|
285
|
-
* Port for the local editor server.
|
|
286
|
-
* Default: 8000
|
|
287
|
-
*/
|
|
288
|
-
port: 8000,
|
|
289
|
-
|
|
290
|
-
/**
|
|
291
|
-
* Public URL for the editor.
|
|
292
|
-
* Default: "http://localhost:8000"
|
|
293
|
-
*/
|
|
294
|
-
editorURL: "http://localhost:8000",
|
|
295
|
-
|
|
296
|
-
/**
|
|
297
|
-
* Intlayer CMS URL.
|
|
298
|
-
* Default: "https://app.intlayer.org"
|
|
299
|
-
*/
|
|
300
|
-
cmsURL: "https://app.intlayer.org",
|
|
301
|
-
|
|
302
|
-
/**
|
|
303
|
-
* Backend API URL.
|
|
304
|
-
* Default: "https://back.intlayer.org"
|
|
305
|
-
*/
|
|
306
|
-
backendURL: "https://back.intlayer.org",
|
|
307
|
-
|
|
308
|
-
/**
|
|
309
|
-
* Whether to enable real-time content synchronization.
|
|
310
|
-
* Default: false
|
|
311
|
-
*/
|
|
312
|
-
liveSync: true,
|
|
313
|
-
},
|
|
314
|
-
|
|
315
|
-
/**
|
|
316
|
-
* AI-powered translation and generation settings.
|
|
317
|
-
*/
|
|
318
|
-
ai: {
|
|
319
|
-
/**
|
|
320
|
-
* AI provider to use.
|
|
321
|
-
* Options: 'openai', 'anthropic', 'mistral', 'deepseek', 'gemini', 'ollama', 'openrouter', 'alibaba', 'fireworks', 'groq', 'huggingface', 'bedrock', 'googlevertex', 'togetherai'
|
|
322
|
-
* Default: 'openai'
|
|
323
|
-
*/
|
|
324
|
-
provider: "openai",
|
|
325
|
-
|
|
326
|
-
/**
|
|
327
|
-
* Model to use from the selected provider.
|
|
328
|
-
*/
|
|
329
|
-
model: "gpt-4o",
|
|
330
|
-
|
|
331
|
-
/**
|
|
332
|
-
* Provider API key.
|
|
333
|
-
*/
|
|
334
|
-
apiKey: process.env.OPENAI_API_KEY,
|
|
335
|
-
|
|
336
|
-
/**
|
|
337
|
-
* Global context to guide the AI in generating translations.
|
|
338
|
-
*/
|
|
339
|
-
applicationContext: "This is a travel booking application.",
|
|
340
|
-
|
|
341
|
-
/**
|
|
342
|
-
* Base URL for the AI API.
|
|
343
|
-
*/
|
|
344
|
-
baseURL: "http://localhost:3000",
|
|
345
|
-
|
|
346
|
-
/**
|
|
347
|
-
* Serializacja danych
|
|
348
|
-
*
|
|
349
|
-
* Opcje:
|
|
350
|
-
* - "json": Standardowa, niezawodna; zużywa więcej tokenów.
|
|
351
|
-
* - "toon": Mniej tokenów, mniej spójna niż JSON.
|
|
352
|
-
*
|
|
353
|
-
* Domyślnie: "json"
|
|
354
|
-
*/
|
|
355
|
-
dataSerialization: "json",
|
|
356
|
-
},
|
|
357
|
-
|
|
358
|
-
/**
|
|
359
|
-
* Build and optimization settings.
|
|
360
|
-
*/
|
|
361
|
-
build: {
|
|
362
|
-
/**
|
|
363
|
-
* Build execution mode.
|
|
364
|
-
* - "auto": Automatic build during app build.
|
|
365
|
-
* - "manual": Requires explicit build command.
|
|
366
|
-
* Default: "auto"
|
|
367
|
-
*/
|
|
368
|
-
mode: "auto",
|
|
369
|
-
|
|
370
|
-
/**
|
|
371
|
-
* Whether to optimize the final bundle by pruning unused dictionaries.
|
|
372
|
-
* Default: true in production
|
|
373
|
-
*/
|
|
374
|
-
optimize: true,
|
|
375
|
-
|
|
376
|
-
/**
|
|
377
|
-
* Output format for generated dictionary files.
|
|
378
|
-
* Default: ['esm', 'cjs']
|
|
379
|
-
*/
|
|
380
|
-
outputFormat: ["esm"],
|
|
381
|
-
|
|
382
|
-
/**
|
|
383
|
-
* Indicates if the build should check TypeScript types.
|
|
384
|
-
* Default: false
|
|
385
|
-
*/
|
|
386
|
-
checkTypes: false,
|
|
387
|
-
},
|
|
388
|
-
|
|
389
|
-
/**
|
|
390
|
-
* Logger configuration.
|
|
391
|
-
*/
|
|
392
|
-
log: {
|
|
393
|
-
/**
|
|
394
|
-
* Logging level.
|
|
395
|
-
* - "default": Standard logging.
|
|
396
|
-
* - "verbose": Detailed debug logging.
|
|
397
|
-
* - "disabled": No logging.
|
|
398
|
-
* Default: "default"
|
|
399
|
-
*/
|
|
400
|
-
mode: "default",
|
|
401
|
-
|
|
402
|
-
/**
|
|
403
|
-
* Prefix for all log messages.
|
|
404
|
-
* Default: "[intlayer]"
|
|
405
|
-
*/
|
|
406
|
-
prefix: "[intlayer]",
|
|
407
|
-
},
|
|
408
|
-
|
|
409
|
-
/**
|
|
410
|
-
* System configuration (Advanced use cases)
|
|
411
|
-
*/
|
|
412
|
-
system: {
|
|
413
|
-
/**
|
|
414
|
-
* Directory for storing localization dictionaries.
|
|
415
|
-
*/
|
|
416
|
-
dictionariesDir: ".intlayer/dictionary",
|
|
417
|
-
|
|
418
|
-
/**
|
|
419
|
-
* Directory for module augmentation.
|
|
420
|
-
*/
|
|
421
|
-
moduleAugmentationDir: ".intlayer/types",
|
|
422
|
-
|
|
423
|
-
/**
|
|
424
|
-
* Directory for storing unmerged dictionaries.
|
|
425
|
-
*/
|
|
426
|
-
unmergedDictionariesDir: ".intlayer/unmerged_dictionary",
|
|
427
|
-
|
|
428
|
-
/**
|
|
429
|
-
* Directory for storing dictionary types.
|
|
430
|
-
*/
|
|
431
|
-
typesDir: ".intlayer/types",
|
|
432
|
-
|
|
433
|
-
/**
|
|
434
|
-
* Directory where main application files are stored.
|
|
435
|
-
*/
|
|
436
|
-
mainDir: ".intlayer/main",
|
|
437
|
-
|
|
438
|
-
/**
|
|
439
|
-
* Directory where the configuration files are stored.
|
|
440
|
-
*/
|
|
441
|
-
configDir: ".intlayer/config",
|
|
442
|
-
|
|
443
|
-
/**
|
|
444
|
-
* Directory where the cache files are stored.
|
|
445
|
-
*/
|
|
446
|
-
cacheDir: ".intlayer/cache",
|
|
447
|
-
},
|
|
448
|
-
|
|
449
|
-
/**
|
|
450
|
-
* Compiler configuration (Advanced use cases)
|
|
451
|
-
*/
|
|
452
|
-
compiler: {
|
|
453
|
-
/**
|
|
454
|
-
* Wskazuje, czy kompilator powinien być włączony.
|
|
455
|
-
*
|
|
456
|
-
* - false : Wyłącza kompilator.
|
|
457
|
-
* - true : Włącza kompilator.
|
|
458
|
-
* - "build-only" : Pomija kompilator podczas programowania, aby przyspieszyć czas uruchamiania.
|
|
459
|
-
*
|
|
460
|
-
* Wartość domyślna : false
|
|
461
|
-
*/
|
|
462
|
-
enabled: true,
|
|
463
|
-
|
|
464
|
-
/**
|
|
465
|
-
* Definiuje ścieżkę plików wyjściowych. Zastępuje `outputDir`.
|
|
466
|
-
*
|
|
467
|
-
* - Ścieżki zaczynające się od `./` są rozwiązywane względem katalogu komponentu.
|
|
468
|
-
* - Ścieżki zaczynające się od `/` są rozwiązywane względem katalogu głównego projektu (`baseDir`).
|
|
469
|
-
*
|
|
470
|
-
* - Uwzględnienie zmiennej `{{locale}}` w ścieżce umożliwi generowanie słowników oddzielonych według języka.
|
|
471
|
-
*
|
|
472
|
-
* Przykład:
|
|
473
|
-
* ```ts
|
|
474
|
-
* {
|
|
475
|
-
* // Utwórz wielojęzyczne pliki .content.ts obok komponentu
|
|
476
|
-
* output: ({ fileName, extension }) => `./${fileName}${extension}`,
|
|
477
|
-
*
|
|
478
|
-
* // output: './{{fileName}}{{extension}}', // Równoważne użycie szablonu ciągu znaków
|
|
479
|
-
* }
|
|
480
|
-
* ```
|
|
481
|
-
*
|
|
482
|
-
* ```ts
|
|
483
|
-
* {
|
|
484
|
-
* // Utwórz scentralizowane pliki JSON według języka w katalogu głównym projektu
|
|
485
|
-
* output: ({ key, locale }) => `/locales/${locale}/${key}.content.json`,
|
|
486
|
-
*
|
|
487
|
-
* // output: '/locales/{{locale}}/{{key}}.content.json', // Równoważne użycie szablonu ciągu znaków
|
|
488
|
-
* }
|
|
489
|
-
* ```
|
|
490
|
-
*
|
|
491
|
-
* Lista zmiennych:
|
|
492
|
-
* - `fileName`: Nazwa pliku.
|
|
493
|
-
* - `key`: Klucz zawartości.
|
|
494
|
-
* - `locale`: Język zawartości.
|
|
495
|
-
* - `extension`: Rozszerzenie pliku.
|
|
496
|
-
* - `componentFileName`: Nazwa pliku komponentu.
|
|
497
|
-
* - `componentExtension`: Rozszerzenie pliku komponentu.
|
|
498
|
-
* - `format`: Format słownika.
|
|
499
|
-
* - `componentFormat`: Format słownika komponentu.
|
|
500
|
-
* - `componentDirPath`: Ścieżka do katalogu komponentu.
|
|
501
|
-
*/
|
|
502
|
-
output: ({ locale, key }) => `compiler/${locale}/${key}.json`,
|
|
503
|
-
|
|
504
|
-
/**
|
|
505
|
-
* Wskazuje, czy komponenty powinny być zapisywane po transformacji.
|
|
506
|
-
* W ten sposób kompilator można uruchomić tylko raz, aby przetransformować aplikację, a następnie go usunąć.
|
|
507
|
-
*/
|
|
508
|
-
saveComponents: false,
|
|
509
|
-
|
|
510
|
-
/**
|
|
511
|
-
* Wstaw tylko zawartość do wygenerowanego pliku. Przydatne dla wyjść JSON i18next lub ICU MessageFormat na lokalizację.
|
|
512
|
-
*/
|
|
513
|
-
noMetadata: false,
|
|
514
|
-
|
|
515
|
-
/**
|
|
516
|
-
* Prefiks klucza słownika
|
|
517
|
-
*/
|
|
518
|
-
dictionaryKeyPrefix: "", // Dodaj opcjonalny prefiks dla wyodrębnionych kluczy słownika
|
|
519
|
-
},
|
|
520
|
-
|
|
521
|
-
/**
|
|
522
|
-
* Custom schemas to validate the dictionaries content.
|
|
523
|
-
*/
|
|
524
|
-
schemas: {
|
|
525
|
-
"my-schema": z.object({
|
|
526
|
-
title: z.string(),
|
|
527
|
-
}),
|
|
528
|
-
},
|
|
529
|
-
|
|
530
|
-
/**
|
|
531
|
-
* Plugins configuration.
|
|
532
|
-
*/
|
|
533
|
-
plugins: [],
|
|
534
|
-
};
|
|
535
|
-
|
|
536
|
-
export default config;
|
|
537
|
-
````
|
|
538
|
-
|
|
539
|
-
## Odniesienie do konfiguracji
|
|
540
|
-
|
|
541
|
-
Poniższe sekcje opisują różne ustawienia konfiguracyjne dostępne dla Intlayer.
|
|
542
|
-
|
|
543
|
-
---
|
|
544
|
-
|
|
545
|
-
### Konfiguracja internacjonalizacji
|
|
546
|
-
|
|
547
|
-
Definiuje ustawienia związane z internacjonalizacją, w tym dostępne lokalizacje oraz domyślną lokalizację dla aplikacji.
|
|
548
|
-
|
|
549
|
-
#### Właściwości
|
|
550
|
-
|
|
551
|
-
- **locales**:
|
|
552
|
-
- _Typ_: `string[]`
|
|
553
|
-
- _Domyślnie_: `['en']`
|
|
554
|
-
- _Opis_: Lista obsługiwanych lokalizacji w aplikacji.
|
|
555
|
-
- _Przykład_: `['en', 'fr', 'es']`
|
|
556
|
-
|
|
557
|
-
- **requiredLocales**:
|
|
558
|
-
- _Typ_: `string[]`
|
|
559
|
-
- _Domyślnie_: `[]`
|
|
560
|
-
- _Opis_: Lista wymaganych lokalizacji w aplikacji.
|
|
561
|
-
- _Przykład_: `[]`
|
|
562
|
-
- _Uwaga_: Jeśli pusta, wszystkie lokalizacje są wymagane w trybie `strict`.
|
|
563
|
-
- _Uwaga_: Upewnij się, że wymagane lokalizacje są również zdefiniowane w polu `locales`.
|
|
564
|
-
- **strictMode**:
|
|
565
|
-
- _Typ_: `string`
|
|
566
|
-
- _Domyślnie_: `inclusive`
|
|
567
|
-
- _Opis_: Zapewnia silną implementację zinternacjonalizowanej zawartości przy użyciu TypeScript.
|
|
568
|
-
- _Uwaga_: Jeśli ustawione na "strict", funkcja tłumaczenia `t` będzie wymagać zdefiniowania każdej zadeklarowanej lokalizacji. Jeśli jakaś lokalizacja będzie brakować lub nie będzie zadeklarowana w konfiguracji, zostanie zgłoszony błąd.
|
|
569
|
-
- _Uwaga_: Jeśli ustawione na "inclusive", funkcja tłumaczenia `t` będzie wymagać zdefiniowania każdej zadeklarowanej lokalizacji. Jeśli jakaś lokalizacja będzie brakować, zostanie wyświetlone ostrzeżenie. Jednak zaakceptuje lokalizację, która nie jest zadeklarowana w konfiguracji, ale istnieje.
|
|
570
|
-
- _Uwaga_: Jeśli ustawione na "loose", funkcja tłumaczenia `t` zaakceptuje dowolną istniejącą lokalizację.
|
|
571
|
-
|
|
572
|
-
- **defaultLocale**:
|
|
573
|
-
- _Typ_: `string`
|
|
574
|
-
- _Domyślnie_: `'en'`
|
|
575
|
-
- _Opis_: Domyślna lokalizacja używana jako zapasowa, jeśli żądana lokalizacja nie zostanie znaleziona.
|
|
576
|
-
- _Przykład_: `'en'`
|
|
577
|
-
- _Uwaga_: Używane do określenia lokalizacji, gdy żadna nie jest podana w URL, ciasteczku lub nagłówku.
|
|
578
|
-
|
|
579
|
-
---
|
|
580
|
-
|
|
581
|
-
### Konfiguracja edytora
|
|
582
|
-
|
|
583
|
-
Definiuje ustawienia związane z zintegrowanym edytorem, w tym port serwera i status aktywności.
|
|
584
|
-
|
|
585
|
-
#### Właściwości
|
|
586
|
-
|
|
587
|
-
- **applicationURL**:
|
|
588
|
-
- _Typ_: `string`
|
|
589
|
-
- _Domyślnie_: `http://localhost:3000`
|
|
590
|
-
- _Opis_: URL aplikacji. Używany do ograniczenia pochodzenia edytora ze względów bezpieczeństwa.
|
|
591
|
-
- _Przykład_:
|
|
592
|
-
- `'http://localhost:3000'`
|
|
593
|
-
- `'https://example.com'`
|
|
594
|
-
- `process.env.INTLAYER_EDITOR_URL`
|
|
595
|
-
- _Uwaga_: URL aplikacji. Używany do ograniczenia pochodzenia edytora ze względów bezpieczeństwa. Jeśli ustawiony na `'*'`, edytor jest dostępny z dowolnego pochodzenia.
|
|
596
|
-
|
|
597
|
-
- **port**:
|
|
598
|
-
- _Typ_: `number`
|
|
599
|
-
- _Domyślnie_: `8000`
|
|
600
|
-
- _Opis_: Port używany przez serwer wizualnego edytora.
|
|
601
|
-
|
|
602
|
-
- **editorURL**:
|
|
603
|
-
- _Typ_: `string`
|
|
604
|
-
- _Domyślnie_: `'http://localhost:8000'`
|
|
605
|
-
- _Opis_: URL serwera edytora. Używany do ograniczenia pochodzenia edytora ze względów bezpieczeństwa.
|
|
606
|
-
- `'http://localhost:3000'`
|
|
607
|
-
- `'https://example.com'`
|
|
608
|
-
- `process.env.INTLAYER_EDITOR_URL`
|
|
609
|
-
- _Uwaga_: URL serwera edytora, do którego aplikacja się łączy. Używany do ograniczenia pochodzenia, które może wchodzić w interakcję z aplikacją ze względów bezpieczeństwa. Jeśli ustawiony na `'*'`, edytor jest dostępny z dowolnego pochodzenia. Powinien być ustawiony, jeśli zmieniono port lub jeśli edytor jest hostowany na innej domenie.
|
|
610
|
-
|
|
611
|
-
- **cmsURL**:
|
|
612
|
-
- _Typ_: `string`
|
|
613
|
-
- _Domyślnie_: `'https://intlayer.org'`
|
|
614
|
-
- _Opis_: URL systemu CMS Intlayer.
|
|
615
|
-
- _Przykład_: `'https://intlayer.org'`
|
|
616
|
-
- _Uwaga_: URL systemu CMS Intlayer.
|
|
617
|
-
|
|
618
|
-
- **backendURL**:
|
|
619
|
-
- _Typ_: `string`
|
|
620
|
-
- _Domyślnie_: `https://back.intlayer.org`
|
|
621
|
-
- _Opis_: URL serwera backendowego.
|
|
622
|
-
- _Przykład_: `http://localhost:4000`
|
|
623
|
-
|
|
624
|
-
- **enabled**:
|
|
625
|
-
- _Typ_: `boolean`
|
|
626
|
-
- _Domyślnie_: `true`
|
|
627
|
-
- _Opis_: Wskazuje, czy aplikacja wchodzi w interakcję z edytorem wizualnym.
|
|
628
|
-
- _Przykład_: `process.env.NODE_ENV !== 'production'`
|
|
629
|
-
- _Uwaga_: Jeśli wartość jest prawdziwa, edytor będzie mógł wchodzić w interakcję z aplikacją. Jeśli fałszywa, edytor nie będzie mógł wchodzić w interakcję z aplikacją. W każdym przypadku edytor może być włączony tylko przez edytor wizualny. Wyłączanie edytora dla określonych środowisk jest sposobem na zwiększenie bezpieczeństwa.
|
|
630
|
-
|
|
631
|
-
- **clientId**:
|
|
632
|
-
- _Typ_: `string` | `undefined`
|
|
633
|
-
- _Domyślnie_: `undefined`
|
|
634
|
-
- _Opis_: clientId i clientSecret pozwalają pakietom intlayer na uwierzytelnianie się z backendem za pomocą uwierzytelniania oAuth2. Token dostępu jest używany do uwierzytelniania użytkownika związanego z projektem. Aby uzyskać token dostępu, przejdź do https://app.intlayer.org/project i załóż konto.
|
|
635
|
-
- _Przykład_: `true`
|
|
636
|
-
- _Uwaga_: Ważne: clientId i clientSecret powinny być przechowywane w tajemnicy i nie udostępniane publicznie. Upewnij się, że są przechowywane w bezpiecznym miejscu, na przykład w zmiennych środowiskowych.
|
|
637
|
-
|
|
638
|
-
- **clientSecret**:
|
|
639
|
-
- _Typ_: `string` | `undefined`
|
|
640
|
-
- _Domyślnie_: `undefined`
|
|
641
|
-
- _Opis_: clientId i clientSecret pozwalają pakietom intlayer na uwierzytelnianie się z backendem za pomocą uwierzytelniania oAuth2. Token dostępu jest używany do uwierzytelniania użytkownika związanego z projektem. Aby uzyskać token dostępu, przejdź do https://app.intlayer.org/project i załóż konto.
|
|
642
|
-
- _Przykład_: `true`
|
|
643
|
-
- _Uwaga_: Ważne: clientId i clientSecret powinny być przechowywane w tajemnicy i nie udostępniane publicznie. Upewnij się, że są przechowywane w bezpiecznym miejscu, na przykład w zmiennych środowiskowych.
|
|
644
|
-
|
|
645
|
-
- **dictionaryPriorityStrategy**:
|
|
646
|
-
- _Typ_: `string`
|
|
647
|
-
- _Domyślnie_: `'local_first'`
|
|
648
|
-
- _Opis_: Strategia priorytetyzacji słowników w przypadku obecności zarówno lokalnych, jak i zdalnych słowników. Jeśli ustawiona na `'distant_first'`, aplikacja będzie priorytetowo traktować słowniki zdalne nad lokalnymi. Jeśli ustawiona na `'local_first'`, aplikacja będzie priorytetowo traktować słowniki lokalne nad zdalnymi.
|
|
649
|
-
- _Przykład_: `'distant_first'`
|
|
650
|
-
|
|
651
|
-
- **liveSync**:
|
|
652
|
-
- _Typ_: `boolean`
|
|
653
|
-
- _Domyślnie_: `false`
|
|
654
|
-
- _Opis_: Wskazuje, czy serwer aplikacji powinien automatycznie przeładowywać zawartość aplikacji po wykryciu zmiany w CMS / Visual Editor / Backend.
|
|
655
|
-
- _Przykład_: `true`
|
|
656
|
-
- _Uwaga_: Na przykład, gdy zostanie dodany lub zaktualizowany nowy słownik, aplikacja zaktualizuje zawartość wyświetlaną na stronie.
|
|
657
|
-
- _Uwaga_: Live sync wymaga zewnętrznego udostępnienia zawartości aplikacji na innym serwerze. Oznacza to, że może to nieznacznie wpłynąć na wydajność aplikacji. Aby to ograniczyć, zalecamy hostowanie aplikacji i serwera live sync na tej samej maszynie. Ponadto, połączenie live sync i `optimize` może generować znaczną liczbę zapytań do serwera live sync. W zależności od infrastruktury, zalecamy przetestowanie obu opcji oraz ich kombinacji.
|
|
658
|
-
|
|
659
|
-
- **liveSyncPort**:
|
|
660
|
-
- _Typ_: `number`
|
|
661
|
-
- _Domyślnie_: `4000`
|
|
662
|
-
- _Opis_: Port serwera live sync.
|
|
663
|
-
- _Przykład_: `4000`
|
|
664
|
-
- _Uwaga_: Port serwera live sync.
|
|
665
|
-
|
|
666
|
-
- **liveSyncURL**:
|
|
667
|
-
- _Typ_: `string`
|
|
668
|
-
- _Domyślnie_: `'http://localhost:{liveSyncPort}'`
|
|
669
|
-
- _Opis_: URL serwera live sync.
|
|
670
|
-
- _Przykład_: `'https://example.com'`
|
|
671
|
-
- _Uwaga_: Domyślnie wskazuje na localhost, ale może zostać zmieniony na dowolny URL w przypadku zdalnego serwera live sync.
|
|
672
|
-
|
|
673
|
-
### Konfiguracja routingu
|
|
674
|
-
|
|
675
|
-
Ustawienia kontrolujące zachowanie routingu, w tym strukturę URL, przechowywanie lokalizacji oraz obsługę middleware.
|
|
676
|
-
|
|
677
|
-
#### Właściwości
|
|
678
|
-
|
|
679
|
-
- **mode**:
|
|
680
|
-
- _Typ_: `'prefix-no-default' | 'prefix-all' | 'no-prefix' | 'search-params'`
|
|
681
|
-
- _Domyślnie_: `'prefix-no-default'`
|
|
682
|
-
- _Opis_: Tryb routingu URL dla obsługi lokalizacji.
|
|
683
|
-
- _Przykłady_:
|
|
684
|
-
- `'prefix-no-default'`: `/dashboard` (en) lub `/fr/dashboard` (fr)
|
|
685
|
-
- `'prefix-all'`: `/en/dashboard` (en) lub `/fr/dashboard` (fr)
|
|
686
|
-
- `'no-prefix'`: `/dashboard` (lokalizacja obsługiwana innymi metodami)
|
|
687
|
-
- `'search-params'`: `/dashboard?locale=fr`
|
|
688
|
-
- _Uwaga_: To ustawienie nie wpływa na zarządzanie ciasteczkami ani przechowywaniem lokalizacji.
|
|
689
|
-
|
|
690
|
-
- **storage**:
|
|
691
|
-
- _Typ_: `false | 'cookie' | 'localStorage' | 'sessionStorage' | 'header' | CookiesAttributes | StorageAttributes | Array`
|
|
692
|
-
- _Domyślnie_: `'localStorage'`
|
|
693
|
-
- _Opis_: Konfiguracja przechowywania lokalizacji po stronie klienta.
|
|
694
|
-
|
|
695
|
-
- **cookie**:
|
|
696
|
-
- _Opis_: Przechowuje dane w ciasteczkach, małych fragmentach danych zapisywanych w przeglądarce klienta, dostępnych zarówno po stronie klienta, jak i serwera.
|
|
697
|
-
- _Uwaga_: Aby przechowywanie było zgodne z RODO, należy zapewnić odpowiednią zgodę użytkownika przed użyciem.
|
|
698
|
-
- _Uwaga_: Parametry ciasteczek są konfigurowalne, jeśli ustawione jako CookiesAttributes (`{ type: 'cookie', name: 'custom-locale', secure: true, httpOnly: false }`).
|
|
699
|
-
|
|
700
|
-
- **localStorage**:
|
|
701
|
-
- _Opis_: Przechowuje dane w przeglądarce bez dat wygaśnięcia, co pozwala na utrzymanie danych pomiędzy sesjami, dostępne tylko po stronie klienta.
|
|
702
|
-
- _Uwaga_: Idealne do przechowywania danych długoterminowych, ale należy pamiętać o kwestiach prywatności i bezpieczeństwa ze względu na brak automatycznego wygasania, chyba że dane zostaną wyraźnie usunięte.
|
|
703
|
-
- _Uwaga_: Przechowywanie lokalizacji jest dostępne tylko po stronie klienta, proxy intlayer nie będzie miało do niego dostępu.
|
|
704
|
-
- _Uwaga_: Parametry przechowywania lokalizacji są konfigurowalne, jeśli ustawione jako StorageAttributes (`{ type: 'localStorage', name: 'custom-locale' }`).
|
|
705
|
-
|
|
706
|
-
- **sessionStorage**:
|
|
707
|
-
- _Opis_: Przechowuje dane przez czas trwania sesji strony, co oznacza, że dane są usuwane po zamknięciu zakładki lub okna, dostępne tylko po stronie klienta.
|
|
708
|
-
- _Uwaga_: Odpowiednie do tymczasowego przechowywania danych dla każdej sesji.
|
|
709
|
-
- _Uwaga_: Przechowywanie lokalne jest dostępne tylko po stronie klienta, proxy intlayer nie będzie miało do niego dostępu.
|
|
710
|
-
- _Uwaga_: Parametry przechowywania lokalnego są konfigurowalne, jeśli ustawione jako StorageAttributes (`{ type: 'sessionStorage', name: 'custom-locale' }`).
|
|
711
|
-
|
|
712
|
-
- **header**:
|
|
713
|
-
- _Opis_: Wykorzystuje nagłówki HTTP do przechowywania lub przesyłania danych lokalizacyjnych, odpowiednie do określania języka po stronie serwera.
|
|
714
|
-
- _Uwaga_: Przydatne w wywołaniach API do utrzymania spójnych ustawień językowych w żądaniach.
|
|
715
|
-
- _Uwaga_: Nagłówek jest dostępny tylko po stronie serwera, klient nie będzie miał do niego dostępu.
|
|
716
|
-
- _Uwaga_: Nazwa nagłówka jest konfigurowalna, jeśli ustawiona jako StorageAttributes (`{ type: 'header', name: 'custom-locale' }`).
|
|
717
|
-
|
|
718
|
-
- **basePath**:
|
|
719
|
-
- _Typ_: `string`
|
|
720
|
-
- _Domyślnie_: `''`
|
|
721
|
-
- _Opis_: Podstawowa ścieżka dla adresów URL aplikacji.
|
|
722
|
-
- _Przykład_: `'/my-app'`
|
|
723
|
-
- _Uwaga_:
|
|
724
|
-
- Jeśli aplikacja jest hostowana pod adresem `https://example.com/my-app`
|
|
725
|
-
- Podstawowa ścieżka to `'/my-app'`
|
|
726
|
-
- Adres URL będzie `https://example.com/my-app/en`
|
|
727
|
-
- Jeśli podstawowa ścieżka nie jest ustawiona, adres URL będzie `https://example.com/en`
|
|
728
|
-
|
|
729
|
-
- **rewrite**:
|
|
730
|
-
- _Typ_: `Record<string, StrictModeLocaleMap<string>>`
|
|
731
|
-
- _Domyślnie_: `undefined`
|
|
732
|
-
- _Opis_: Niestandardowe reguły przepisywania URL, które zastępują domyślny tryb routingu dla określonych ścieżek. Pozwala definiować ścieżki specyficzne dla języka, które różnią się od standardowego zachowania routingu. Obsługuje dynamiczne parametry trasy przy użyciu składni `[param]`.
|
|
733
|
-
- _Przykład_:
|
|
734
|
-
```typescript
|
|
735
|
-
routing: {
|
|
736
|
-
mode: "prefix-no-default", // Strategia zapasowa
|
|
737
|
-
rewrite: nextjsRewrite({
|
|
738
|
-
"/[locale]/about": {
|
|
739
|
-
en: "/[locale]/about",
|
|
740
|
-
fr: "/[locale]/a-propos",
|
|
741
|
-
},
|
|
742
|
-
"/[locale]/product/[slug]": {
|
|
743
|
-
en: "/[locale]/product/[slug]",
|
|
744
|
-
fr: "/[locale]/produit/[slug]",
|
|
745
|
-
},
|
|
746
|
-
"/[locale]/blog/[category]/[id]": {
|
|
747
|
-
en: "/[locale]/blog/[category]/[id]",
|
|
748
|
-
fr: "/[locale]/journal/[category]/[id]",
|
|
749
|
-
},
|
|
750
|
-
}),
|
|
751
|
-
}
|
|
752
|
-
```
|
|
753
|
-
- _Uwaga_: Reguły przepisywania mają pierwszeństwo przed domyślnym zachowaniem `mode`. Jeśli ścieżka pasuje do reguły przepisywania, zostanie użyta zlokalizowana ścieżka z konfiguracji przepisywania zamiast standardowego prefiksu języka.
|
|
754
|
-
- _Uwaga_: Dynamiczne parametry trasy są obsługiwane przy użyciu notacji nawiasów kwadratowych (np. `[slug]`, `[id]`). Wartości parametrów są automatycznie wyodrębniane z URL i interpolowane do przepisanej ścieżki.
|
|
755
|
-
- _Uwaga_: Działa z aplikacjami Next.js i Vite. Middleware/proxy automatycznie przepisze przychodzące żądania, aby dopasować je do wewnętrznej struktury trasy.
|
|
756
|
-
- _Uwaga_: Podczas generowania URL za pomocą `getLocalizedUrl()`, reguły przepisywania są automatycznie stosowane, jeśli pasują do podanej ścieżki.
|
|
757
|
-
- _Odniesienie_: Aby uzyskać więcej informacji, zobacz [Niestandardowe przepisywanie URL](https://github.com/aymericzip/intlayer/blob/main/docs/docs/pl/custom_url_rewrites.md).
|
|
758
|
-
|
|
759
|
-
#### Atrybuty ciasteczek
|
|
760
|
-
|
|
761
|
-
Podczas korzystania z przechowywania w ciasteczkach, możesz skonfigurować dodatkowe atrybuty ciasteczek:
|
|
762
|
-
|
|
763
|
-
- **name**: Nazwa ciasteczka (domyślnie: `'INTLAYER_LOCALE'`)
|
|
764
|
-
- **domain**: Domeną ciasteczka (domyślnie: niezdefiniowane)
|
|
765
|
-
- **path**: Ścieżka ciasteczka (domyślnie: niezdefiniowane)
|
|
766
|
-
- **secure**: Wymagaj HTTPS (domyślnie: niezdefiniowane)
|
|
767
|
-
- **httpOnly**: Flaga HTTP-only (domyślnie: niezdefiniowane)
|
|
768
|
-
- **sameSite**: Polityka SameSite (`'strict' | 'lax' | 'none'`)
|
|
769
|
-
- **expires**: Data wygaśnięcia lub liczba dni (domyślnie: niezdefiniowane)
|
|
770
|
-
|
|
771
|
-
#### Atrybuty przechowywania lokalnego
|
|
772
|
-
|
|
773
|
-
Podczas korzystania z localStorage lub sessionStorage:
|
|
774
|
-
|
|
775
|
-
- **type**: Typ przechowywania (`'localStorage' | 'sessionStorage'`)
|
|
776
|
-
- **name**: Nazwa klucza przechowywania (domyślnie: `'INTLAYER_LOCALE'`)
|
|
777
|
-
|
|
778
|
-
#### Przykłady konfiguracji
|
|
779
|
-
|
|
780
|
-
Oto kilka typowych przykładów konfiguracji dla nowej struktury routingu w wersji v7:
|
|
781
|
-
|
|
782
|
-
**Podstawowa konfiguracja (domyślna)**:
|
|
783
|
-
|
|
784
|
-
```typescript
|
|
785
|
-
import { Locales, type IntlayerConfig } from "intlayer";
|
|
786
|
-
// intlayer.config.ts
|
|
787
|
-
const config: IntlayerConfig = {
|
|
788
|
-
internationalization: {
|
|
789
|
-
locales: ["en", "fr", "es"],
|
|
790
|
-
defaultLocale: "en",
|
|
791
|
-
},
|
|
792
|
-
routing: {
|
|
793
|
-
mode: "prefix-no-default",
|
|
794
|
-
storage: "localStorage",
|
|
795
|
-
headerName: "x-intlayer-locale",
|
|
796
|
-
},
|
|
797
|
-
};
|
|
798
|
-
|
|
799
|
-
export default config;
|
|
800
|
-
```
|
|
801
|
-
|
|
802
|
-
**Konfiguracja zgodna z RODO**:
|
|
803
|
-
|
|
804
|
-
```typescript
|
|
805
|
-
import { Locales, type IntlayerConfig } from "intlayer";
|
|
806
|
-
// intlayer.config.ts
|
|
807
|
-
const config: IntlayerConfig = {
|
|
808
|
-
internationalization: {
|
|
809
|
-
locales: ["en", "fr", "es"],
|
|
810
|
-
defaultLocale: "en",
|
|
811
|
-
},
|
|
812
|
-
routing: {
|
|
813
|
-
mode: "prefix-no-default",
|
|
814
|
-
storage: [
|
|
815
|
-
{
|
|
816
|
-
type: "localStorage",
|
|
817
|
-
name: "user-locale",
|
|
818
|
-
},
|
|
819
|
-
{
|
|
820
|
-
type: "cookie",
|
|
821
|
-
name: "user-locale",
|
|
822
|
-
secure: true,
|
|
823
|
-
sameSite: "strict",
|
|
824
|
-
httpOnly: false,
|
|
825
|
-
},
|
|
826
|
-
],
|
|
827
|
-
},
|
|
828
|
-
};
|
|
829
|
-
|
|
830
|
-
export default config;
|
|
831
|
-
```
|
|
832
|
-
|
|
833
|
-
**Tryb parametrów wyszukiwania**:
|
|
834
|
-
|
|
835
|
-
```typescript
|
|
836
|
-
import { Locales, type IntlayerConfig } from "intlayer";
|
|
837
|
-
// intlayer.config.ts
|
|
838
|
-
const config: IntlayerConfig = {
|
|
839
|
-
internationalization: {
|
|
840
|
-
locales: ["en", "fr", "es"],
|
|
841
|
-
defaultLocale: "en",
|
|
842
|
-
},
|
|
843
|
-
routing: {
|
|
844
|
-
mode: "search-params",
|
|
845
|
-
},
|
|
846
|
-
};
|
|
847
|
-
|
|
848
|
-
export default config;
|
|
849
|
-
```
|
|
850
|
-
|
|
851
|
-
**Tryb bez prefiksu z niestandardową pamięcią**:
|
|
852
|
-
|
|
853
|
-
```typescript
|
|
854
|
-
import { Locales, type IntlayerConfig } from "intlayer";
|
|
855
|
-
// intlayer.config.ts
|
|
856
|
-
const config: IntlayerConfig = {
|
|
857
|
-
internationalization: {
|
|
858
|
-
locales: ["en", "fr", "es"],
|
|
859
|
-
defaultLocale: "en",
|
|
860
|
-
},
|
|
861
|
-
routing: {
|
|
862
|
-
mode: "no-prefix",
|
|
863
|
-
storage: {
|
|
864
|
-
type: "sessionStorage",
|
|
865
|
-
},
|
|
866
|
-
},
|
|
867
|
-
};
|
|
868
|
-
|
|
869
|
-
export default config;
|
|
870
|
-
```
|
|
871
|
-
|
|
872
|
-
---
|
|
873
|
-
|
|
874
|
-
### Konfiguracja treści
|
|
875
|
-
|
|
876
|
-
Ustawienia związane z obsługą treści w aplikacji, w tym nazwy katalogów, rozszerzenia plików oraz pochodne konfiguracje.
|
|
877
|
-
|
|
878
|
-
#### Właściwości
|
|
879
|
-
|
|
880
|
-
- **watch**:
|
|
881
|
-
- _Typ_: `boolean`
|
|
882
|
-
- _Domyślnie_: `process.env.NODE_ENV === 'development'`
|
|
883
|
-
- _Opis_: Wskazuje, czy Intlayer powinien obserwować zmiany w plikach deklaracji treści w aplikacji, aby przebudować powiązane słowniki.
|
|
884
|
-
|
|
885
|
-
- **fileExtensions**:
|
|
886
|
-
- _Typ_: `string[]`
|
|
887
|
-
- _Domyślnie_: `['.content.ts', '.content.js', '.content.cjs', '.content.mjs', '.content.json', '.content.tsx', '.content.jsx']`
|
|
888
|
-
- _Opis_: Rozszerzenia plików, które mają być wyszukiwane podczas budowania słowników.
|
|
889
|
-
- _Przykład_: `['.data.ts', '.data.js', '.data.json']`
|
|
890
|
-
- _Uwaga_: Dostosowanie rozszerzeń plików może pomóc uniknąć konfliktów.
|
|
891
|
-
|
|
892
|
-
- **contentDir**:
|
|
893
|
-
- _Typ_: `string[]`
|
|
894
|
-
- _Domyślnie_: `['.']`
|
|
895
|
-
- _Przykład_: `['src', '../../ui-library', require.resolve("@my-package/content")]`
|
|
896
|
-
- _Opis_: Ścieżka katalogu, w którym przechowywane są pliki definicji treści (`.content.*`).
|
|
897
|
-
- _Uwaga_: Jest używany do monitorowania plików treści w celu przebudowy słowników.
|
|
898
|
-
|
|
899
|
-
- **codeDir**:
|
|
900
|
-
- _Typ_: `string[]`
|
|
901
|
-
- _Domyślnie_: `['.']`
|
|
902
|
-
- _Przykład_: `['src', '../../ui-library']`
|
|
903
|
-
- _Opis_: Ścieżka katalogu, w którym przechowywany jest kod, względem katalogu bazowego.
|
|
904
|
-
- _Uwaga_: Jest używany do monitorowania plików kodu w celu transformacji (przycinanie, optymalizacja). Utrzymanie tego oddzielnie od `contentDir` może poprawić wydajność kompilacji, unikając niepotrzebnego skanowania plików treści.
|
|
905
|
-
|
|
906
|
-
---
|
|
907
|
-
|
|
908
|
-
### Konfiguracja systemu
|
|
909
|
-
|
|
910
|
-
Ustawienia związane z wewnętrznymi ścieżkami oraz wynikami wyjściowymi Intlayer. Te ustawienia są zazwyczaj wewnętrzne i nie powinny być modyfikowane przez użytkownika.
|
|
911
|
-
|
|
912
|
-
#### Właściwości
|
|
913
|
-
|
|
914
|
-
- **baseDir**:
|
|
915
|
-
- _Typ_: `string`
|
|
916
|
-
- _Domyślnie_: `process.cwd()`
|
|
917
|
-
- _Opis_: Katalog bazowy projektu.
|
|
918
|
-
- _Przykład_: `'/path/to/project'`
|
|
919
|
-
- _Uwaga_: Jest używany do rozwiązywania wszystkich katalogów związanych z Intlayer.
|
|
920
|
-
|
|
921
|
-
- **dictionariesDir**:
|
|
922
|
-
- _Typ_: `string`
|
|
923
|
-
- _Domyślnie_: `'.intlayer/dictionary'`
|
|
924
|
-
- _Opis_: Ścieżka katalogu do przechowywania słowników lokalizacyjnych.
|
|
925
|
-
- _Przykład_: `'translations'`
|
|
926
|
-
|
|
927
|
-
- **moduleAugmentationDir**:
|
|
928
|
-
- _Typ_: `string`
|
|
929
|
-
- _Domyślnie_: `'.intlayer/types'`
|
|
930
|
-
- _Opis_: Katalog do rozszerzania modułów, umożliwiający lepsze sugestie w IDE i sprawdzanie typów.
|
|
931
|
-
- _Przykład_: `'intlayer-types'`
|
|
932
|
-
- _Uwaga_: Upewnij się, że jest to uwzględnione w `tsconfig.json`.
|
|
933
|
-
|
|
934
|
-
- **unmergedDictionariesDir**:
|
|
935
|
-
- _Typ_: `string`
|
|
936
|
-
- _Domyślnie_: `'.intlayer/unmerged_dictionary'`
|
|
937
|
-
- _Opis_: Katalog do przechowywania niepołączonych słowników.
|
|
938
|
-
- _Przykład_: `'translations'`
|
|
939
|
-
|
|
940
|
-
- **typesDir**:
|
|
941
|
-
- _Typ_: `string`
|
|
942
|
-
- _Domyślnie_: `'types'`
|
|
943
|
-
- _Opis_: Katalog do przechowywania typów słowników.
|
|
944
|
-
- _Przykład_: `'intlayer-types'`
|
|
945
|
-
|
|
946
|
-
- **mainDir**:
|
|
947
|
-
- _Typ_: `string`
|
|
948
|
-
- _Domyślnie_: `'main'`
|
|
949
|
-
- _Opis_: Katalog, w którym przechowywane są główne pliki aplikacji.
|
|
950
|
-
- _Przykład_: `'intlayer-main'`
|
|
951
|
-
|
|
952
|
-
- **excludedPath**:
|
|
953
|
-
- _Typ_: `string[]`
|
|
954
|
-
- _Domyślnie_: `['**/node_modules/**', '**/dist/**', '**/build/**', '**/.intlayer/**', '**/.next/**', '**/.nuxt/**', '**/.expo/**', '**/.vercel/**', '**/.turbo/**', '**/.tanstack/**']`
|
|
955
|
-
- _Opis_: Katalogi wykluczone z wyszukiwania treści.
|
|
956
|
-
- _Uwaga_: To ustawienie nie jest jeszcze używane, ale planowane do implementacji w przyszłości.
|
|
957
|
-
|
|
958
|
-
- **formatCommand**:
|
|
959
|
-
- _Typ_: `string`
|
|
960
|
-
- _Domyślnie_: `undefined`
|
|
961
|
-
- _Opis_: Komenda do formatowania zawartości. Gdy intlayer zapisuje lokalnie twoje pliki .content, ta komenda będzie używana do formatowania zawartości.
|
|
962
|
-
- _Przykład_: `'npx prettier --write "{{file}}" --log-level silent'` Użycie Prettier
|
|
963
|
-
- _Przykład_: `'npx biome format "{{file}}" --write --log-level none'` Użycie Biome
|
|
964
|
-
- _Przykład_: `'npx eslint --fix "{{file}}" --quiet'` Użycie ESLint
|
|
965
|
-
- _Uwaga_: Intlayer zastąpi {{file}} ścieżką do pliku, który ma zostać sformatowany.
|
|
966
|
-
- _Uwaga_: Jeśli nie zostanie ustawione, Intlayer spróbuje automatycznie wykryć polecenie formatowania. Próbując rozpoznać następujące polecenia: prettier, biome, eslint.
|
|
967
|
-
|
|
968
|
-
### Konfiguracja Słownika
|
|
969
|
-
|
|
970
|
-
Ustawienia kontrolujące operacje słownika, w tym zachowanie automatycznego wypełniania oraz generowanie zawartości.
|
|
971
|
-
|
|
972
|
-
Ta konfiguracja słownika służy dwóm głównym celom:
|
|
973
|
-
|
|
974
|
-
1. **Wartości domyślne**: Definiowanie wartości domyślnych podczas tworzenia plików deklaracji zawartości
|
|
975
|
-
2. **Zachowanie zapasowe**: Zapewnienie wartości zapasowych, gdy konkretne pola nie są zdefiniowane, co pozwala na globalne określenie zachowania operacji słownika
|
|
976
|
-
|
|
977
|
-
Aby uzyskać więcej informacji na temat plików deklaracji zawartości oraz sposobu stosowania wartości konfiguracyjnych, zobacz [Dokumentację pliku zawartości](https://github.com/aymericzip/intlayer/blob/main/docs/docs/pl/dictionary/content_file.md).
|
|
978
|
-
|
|
979
|
-
#### Właściwości
|
|
980
|
-
|
|
981
|
-
- **fill**
|
|
982
|
-
- **description**
|
|
983
|
-
- **locale**
|
|
984
|
-
- **location**
|
|
985
|
-
- **priority**
|
|
986
|
-
- **live**
|
|
987
|
-
- **schema**
|
|
988
|
-
- **title**
|
|
989
|
-
- **tags**
|
|
990
|
-
- **version**
|
|
991
|
-
|
|
992
|
-
---
|
|
993
|
-
|
|
994
|
-
### Konfiguracja Loggera
|
|
995
|
-
|
|
996
|
-
Ustawienia kontrolujące logger, w tym prefiks do użycia.
|
|
997
|
-
|
|
998
|
-
#### Właściwości
|
|
999
|
-
|
|
1000
|
-
- **mode**:
|
|
1001
|
-
- _Typ_: `string`
|
|
1002
|
-
- _Domyślnie_: `default`
|
|
1003
|
-
- _Opis_: Określa tryb loggera.
|
|
1004
|
-
- _Opcje_: `default`, `verbose`, `disabled`
|
|
1005
|
-
- _Przykład_: `default`
|
|
1006
|
-
- _Uwaga_: Tryb loggera. Tryb verbose będzie logował więcej informacji, ale może być używany do celów debugowania. Tryb disabled wyłączy logger.
|
|
1007
|
-
|
|
1008
|
-
- **prefix**:
|
|
1009
|
-
- _Typ_: `string`
|
|
1010
|
-
- _Domyślnie_: `'[intlayer] '`
|
|
1011
|
-
- _Opis_: Prefiks loggera.
|
|
1012
|
-
- _Przykład_: `'[my custom prefix] '`
|
|
1013
|
-
- _Uwaga_: Prefiks loggera.
|
|
1014
|
-
|
|
1015
|
-
### Konfiguracja AI
|
|
1016
|
-
|
|
1017
|
-
Ustawienia kontrolujące funkcje AI w Intlayer, w tym dostawcę, model i klucz API.
|
|
1018
|
-
|
|
1019
|
-
Ta konfiguracja jest opcjonalna, jeśli jesteś zarejestrowany na [Intlayer Dashboard](https://app.intlayer.org/project) i korzystasz z klucza dostępu. Intlayer automatycznie zarządza najbardziej efektywnym i opłacalnym rozwiązaniem AI dla Twoich potrzeb. Korzystanie z domyślnych opcji zapewnia lepszą długoterminową utrzymalność, ponieważ Intlayer stale aktualizuje się, aby korzystać z najbardziej odpowiednich modeli.
|
|
1020
|
-
|
|
1021
|
-
Jeśli wolisz używać własnego klucza API lub konkretnego modelu, możesz zdefiniować własną konfigurację AI.
|
|
1022
|
-
Ta konfiguracja AI będzie używana globalnie w całym środowisku Intlayer. Polecenia CLI będą korzystać z tych ustawień jako domyślnych dla poleceń (np. `fill`), a także SDK, Visual Editor i CMS. Możesz nadpisać te domyślne wartości dla konkretnych przypadków użycia, korzystając z parametrów poleceń.
|
|
1023
|
-
|
|
1024
|
-
Intlayer obsługuje wielu dostawców AI, aby zapewnić większą elastyczność i wybór. Obecnie obsługiwani dostawcy to:
|
|
1025
|
-
|
|
1026
|
-
- **OpenAI** (domyślny)
|
|
1027
|
-
- **Anthropic Claude**
|
|
1028
|
-
- **Mistral AI**
|
|
1029
|
-
- **DeepSeek**
|
|
1030
|
-
- **Google Gemini**
|
|
1031
|
-
- **Meta Llama**
|
|
1032
|
-
- **Ollama**
|
|
1033
|
-
- **OpenRouter**
|
|
1034
|
-
- **Alibaba Cloud**
|
|
1035
|
-
- **Fireworks**
|
|
1036
|
-
- **Hugging Face**
|
|
1037
|
-
- **Groq**
|
|
1038
|
-
- **Amazon Bedrock**
|
|
1039
|
-
- **Google AI Studio**
|
|
1040
|
-
- **Google Vertex**
|
|
1041
|
-
- **Together.ai**
|
|
1042
|
-
- **ollama**
|
|
1043
|
-
|
|
1044
|
-
#### Właściwości
|
|
1045
|
-
|
|
1046
|
-
- **provider**:
|
|
1047
|
-
- _Typ_: `string`
|
|
1048
|
-
- _Domyślnie_: `'openai'`
|
|
1049
|
-
- _Opis_: Dostawca używany do funkcji AI w Intlayer.
|
|
1050
|
-
- _Opcje_: `'openai'`, `'anthropic'`, `'mistral'`, `'deepseek'`, `'gemini'`, `'ollama'`, `'openrouter'`, `'alibaba'`, `'fireworks'`, `'groq'`, `'huggingface'`, `'bedrock'`, `'googleaistudio'`, `'googlevertex'`, `'togetherai'`
|
|
1051
|
-
- _Przykład_: `'anthropic'`
|
|
1052
|
-
- _Uwaga_: Różni dostawcy mogą wymagać różnych kluczy API i mieć różne modele cenowe.
|
|
1053
|
-
|
|
1054
|
-
- **model**:
|
|
1055
|
-
- _Typ_: `string`
|
|
1056
|
-
- _Domyślnie_: Brak
|
|
1057
|
-
- _Opis_: Model używany do funkcji AI w Intlayer.
|
|
1058
|
-
- _Przykład_: `'gpt-4o-2024-11-20'`
|
|
1059
|
-
- _Uwaga_: Konkretne modele różnią się w zależności od dostawcy.
|
|
1060
|
-
|
|
1061
|
-
- **temperature**:
|
|
1062
|
-
- _Typ_: `number`
|
|
1063
|
-
- _Domyślnie_: Brak
|
|
1064
|
-
- _Opis_: Temperatura kontroluje losowość odpowiedzi AI.
|
|
1065
|
-
- _Przykład_: `0.1`
|
|
1066
|
-
- _Uwaga_: Wyższa temperatura sprawia, że AI jest bardziej kreatywne i mniej przewidywalne.
|
|
1067
|
-
|
|
1068
|
-
- **apiKey**:
|
|
1069
|
-
- _Typ_: `string`
|
|
1070
|
-
- _Domyślnie_: Brak
|
|
1071
|
-
- _Opis_: Twój klucz API dla wybranego dostawcy.
|
|
1072
|
-
- _Przykład_: `process.env.OPENAI_API_KEY`
|
|
1073
|
-
- _Uwaga_: Ważne: Klucze API powinny być przechowywane w tajemnicy i nie udostępniane publicznie. Proszę upewnić się, że są przechowywane w bezpiecznym miejscu, takim jak zmienne środowiskowe.
|
|
1074
|
-
|
|
1075
|
-
- **applicationContext**:
|
|
1076
|
-
- _Typ_: `string`
|
|
1077
|
-
- _Domyślnie_: Brak
|
|
1078
|
-
- _Opis_: Dostarcza dodatkowy kontekst dotyczący Twojej aplikacji dla modelu AI, pomagając mu generować dokładniejsze i kontekstowo odpowiednie tłumaczenia. Może to obejmować informacje o domenie aplikacji, docelowej grupie odbiorców, tonie lub specyficznej terminologii.
|
|
1079
|
-
|
|
1080
|
-
- **baseURL**:
|
|
1081
|
-
- _Typ_: `string`
|
|
1082
|
-
- _Domyślnie_: Brak
|
|
1083
|
-
- _Opis_: Podstawowy URL dla API AI.
|
|
1084
|
-
- _Przykład_: `'https://api.openai.com/v1'`
|
|
1085
|
-
- _Uwaga_: Może być używany do wskazania lokalnego lub niestandardowego punktu końcowego API AI.
|
|
1086
|
-
|
|
1087
|
-
- **dataSerialization**:
|
|
1088
|
-
- _Typ_: `'json' | 'toon'`
|
|
1089
|
-
- _Domyślnie_: `'json'`
|
|
1090
|
-
- _Opis_: Format serializacji danych dla funkcji AI w Intlayer.
|
|
1091
|
-
- _Przykład_: `'toon'`
|
|
1092
|
-
- _Uwaga_: `json`: Standardowy, niezawodny; zużywa więcej tokenów. `toon`: Mniej tokenów, mniej spójny niż JSON.
|
|
1093
|
-
|
|
1094
|
-
### Konfiguracja Budowania
|
|
1095
|
-
|
|
1096
|
-
Ustawienia kontrolujące, jak Intlayer optymalizuje i buduje internacjonalizację Twojej aplikacji.
|
|
1097
|
-
|
|
1098
|
-
Opcje budowania dotyczą wtyczek `@intlayer/babel` oraz `@intlayer/swc`.
|
|
1099
|
-
|
|
1100
|
-
> W trybie deweloperskim Intlayer używa statycznych importów słowników, aby uprościć proces tworzenia aplikacji.
|
|
1101
|
-
|
|
1102
|
-
> Po optymalizacji Intlayer zastąpi wywołania słowników, aby zoptymalizować podział na części (chunking), dzięki czemu finalny pakiet zaimportuje tylko te słowniki, które są faktycznie używane.
|
|
1103
|
-
|
|
1104
|
-
#### Właściwości
|
|
1105
|
-
|
|
1106
|
-
- **mode**:
|
|
1107
|
-
- _Typ_: `'auto' | 'manual'`
|
|
1108
|
-
- _Domyślnie_: `'auto'`
|
|
1109
|
-
- _Opis_: Kontroluje tryb budowania.
|
|
1110
|
-
- _Przykład_: `'manual'`
|
|
1111
|
-
- _Uwaga_: Jeśli 'auto', budowanie zostanie włączone automatycznie podczas budowania aplikacji.
|
|
1112
|
-
- _Uwaga_: Jeśli 'manual', budowanie zostanie ustawione tylko po wykonaniu polecenia budowania.
|
|
1113
|
-
- _Uwaga_: Może być używane do wyłączenia budowania słowników, na przykład gdy należy unikać wykonywania w środowisku Node.js.
|
|
1114
|
-
|
|
1115
|
-
- **optimize**:
|
|
1116
|
-
- _Typ_: `boolean`
|
|
1117
|
-
- _Domyślnie_: `process.env.NODE_ENV === 'production'`
|
|
1118
|
-
- _Opis_: Kontroluje, czy budowa powinna być zoptymalizowana.
|
|
1119
|
-
- _Przykład_: `true`
|
|
1120
|
-
- _Uwaga_: Po włączeniu Intlayer zastąpi wszystkie wywołania słowników, aby zoptymalizować podział na części. W ten sposób finalny pakiet zaimportuje tylko używane słowniki. Wszystkie importy pozostaną statyczne, aby uniknąć asynchronicznego przetwarzania podczas ładowania słowników.
|
|
1121
|
-
- _Uwaga_: Intlayer zastąpi wszystkie wywołania `useIntlayer` trybem zdefiniowanym przez opcję `importMode` oraz `getIntlayer` funkcją `getDictionary`.
|
|
1122
|
-
- _Uwaga_: Ta opcja wymaga wtyczek `@intlayer/babel` oraz `@intlayer/swc`.
|
|
1123
|
-
- _Uwaga_: Upewnij się, że wszystkie klucze są deklarowane statycznie w wywołaniach `useIntlayer`, np. `useIntlayer('navbar')`.
|
|
1124
|
-
|
|
1125
|
-
- **checkTypes**:
|
|
1126
|
-
- _Typ_: `boolean`
|
|
1127
|
-
- _Domyślny_: `false`
|
|
1128
|
-
- _Opis_: Wskazuje, czy kompilacja powinna sprawdzać typy TypeScript i rejestrować błędy.
|
|
1129
|
-
- _Uwaga_: Może to spowolnić proces kompilacji.
|
|
1130
|
-
|
|
1131
|
-
- **outputFormat**:
|
|
1132
|
-
- _Typ_: `'esm' | 'cjs'`
|
|
1133
|
-
- _Domyślnie_: `'esm'`
|
|
1134
|
-
- _Opis_: Kontroluje format wyjściowy słowników.
|
|
1135
|
-
- _Przykład_: `'cjs'`
|
|
1136
|
-
- _Uwaga_: Format wyjściowy słowników.
|
|
1137
|
-
|
|
1138
|
-
- **traversePattern**:
|
|
1139
|
-
- _Typ_: `string[]`
|
|
1140
|
-
- _Domyślnie_: `['**\/*.{js,ts,mjs,cjs,jsx,tsx}', '!**\/node_modules/**']`
|
|
1141
|
-
- _Opis_: Wzorce definiujące, które pliki powinny być przeszukiwane podczas optymalizacji.
|
|
1142
|
-
- _Przykład_: `['src/**\/*.{ts,tsx}', '../ui-library/**\/*.{ts,tsx}', '!**/node_modules/**']`
|
|
1143
|
-
- _Uwaga_: Użyj tego, aby ograniczyć optymalizację do istotnych plików kodu i poprawić wydajność budowania.
|
|
1144
|
-
- _Uwaga_: Ta opcja zostanie zignorowana, jeśli `optimize` jest wyłączone.
|
|
1145
|
-
- _Uwaga_: Używaj wzorców glob.
|
|
1146
|
-
|
|
1147
|
-
---
|
|
1148
|
-
|
|
1149
|
-
### Konfiguracja Kompilatora
|
|
1150
|
-
|
|
1151
|
-
Ustawienia kontrolujące kompilator Intlayer, który wyodrębnia słowniki bezpośrednio z Twoich komponentów.
|
|
1152
|
-
|
|
1153
|
-
#### Właściwości
|
|
1154
|
-
|
|
1155
|
-
- **enabled**:
|
|
1156
|
-
- _Typ_: `boolean | 'build-only'`
|
|
1157
|
-
- _Domyślnie_: `true`
|
|
1158
|
-
- _Opis_: Wskazuje, czy kompilator powinien być włączony w celu wyodrębniania słowników.
|
|
1159
|
-
- _Przykład_: `'build-only'`
|
|
1160
|
-
- _Uwaga_: Ustawienie go na `'build-only'` spowoduje pominięcie kompilatora w trybie deweloperskim, co przyspieszy czas uruchamiania. Będzie on uruchamiany tylko przy poleceniach budowania.
|
|
1161
|
-
|
|
1162
|
-
- **dictionaryKeyPrefix**:
|
|
1163
|
-
- _Typ_: `string`
|
|
1164
|
-
- _Domyślnie_: `''`
|
|
1165
|
-
- _Opis_: Prefiks dla wyodrębnionych kluczy słownika.
|
|
1166
|
-
- _Przykład_: `'my-key-'`
|
|
1167
|
-
- _Uwaga_: Podczas wyodrębniania słowników klucz jest generowany na podstawie nazwy pliku. Ten prefiks jest dodawany do wygenerowanego klucza, aby zapobiec konfliktom.
|
|
1168
|
-
|
|
1169
|
-
- **saveComponents**:
|
|
1170
|
-
- _Typ_: `boolean`
|
|
1171
|
-
- _Domyślnie_: `false`
|
|
1172
|
-
- _Opis_: Wskazuje, czy komponenty powinny zostać zapisane po ich przekształceniu.
|
|
1173
|
-
- _Uwaga_: Jeśli ustawiono na true, kompilator zastąpi oryginalne pliki plikami przekształconymi. W ten sposób kompilator można uruchomić tylko raz, aby przekształcić aplikację, a następnie można go usunąć.
|
|
1174
|
-
|
|
1175
|
-
- **transformPattern**:
|
|
1176
|
-
- _Typ_: `string | string[]`
|
|
1177
|
-
- _Domyślnie_: `['**/*.{ts,tsx,jsx,js,cjs,mjs,svelte,vue}', '!**/node_modules/**']`
|
|
1178
|
-
- _Opis_: Wzorce określające, które pliki powinny być przeszukiwane podczas optymalizacji.
|
|
1179
|
-
- _Przykład_: `['src/**/*.{ts,tsx}', '!**/node_modules/**']`
|
|
1180
|
-
- _Uwaga_: Użyj tego, aby ograniczyć optymalizację do istotnych plików kodu i poprawić wydajność budowania.
|
|
1181
|
-
|
|
1182
|
-
- **excludePattern**:
|
|
1183
|
-
- _Typ_: `string | string[]`
|
|
1184
|
-
- _Domyślnie_: `['**/node_modules/**']`
|
|
1185
|
-
- _Opis_: Wzorce określające, które pliki powinny być wykluczone podczas optymalizacji.
|
|
1186
|
-
- _Przykład_: `['**/node_modules/**', '!**/node_modules/react/**']`
|
|
1187
|
-
|
|
1188
|
-
- **output**:
|
|
1189
|
-
- _Typ_: `FilePathPattern`
|
|
1190
|
-
- _Domyślny_: `undefined`
|
|
1191
|
-
- _Opis_: Definiuje ścieżkę plików wyjściowych. Zastępuje `outputDir`. Obsługuje zmienne dynamiczne poprzez szablony ciągów znaków lub funkcję. Obsługiwane zmienne: `{{fileName}}`, `{{key}}`, `{{locale}}`, `{{extension}}`, `{{componentFileName}}`, `{{componentExtension}}`, `{{format}}`, `{{componentFormat}}` oraz `{{componentDirPath}}`.
|
|
1192
|
-
- _Uwaga_: Ścieżki zaczynające się od `./` są rozwiązywane względem katalogu komponentu. Ścieżki zaczynające się od `/` są rozwiązywane względem katalogu głównego projektu (`baseDir`).
|
|
1193
|
-
- _Uwaga_: Uwzględnienie zmiennej `{{locale}}` w ścieżce umożliwi generowanie słowników oddzielonych według języka.
|
|
1194
|
-
- _Przykład_:
|
|
1195
|
-
- **Plik wielojęzyczny obok komponentu**:
|
|
1196
|
-
- Ciąg znaków: `'./{{fileName}}{{extension}}'`
|
|
1197
|
-
- Funkcja: `({ fileName, extension }) => \`./${fileName}${extension}\``
|
|
1198
|
-
|
|
1199
|
-
- **Zcentralizowane pliki JSON według języka**:
|
|
1200
|
-
- Ciąg znaków: `'/locales/{{locale}}/{{key}}.content.json'`
|
|
1201
|
-
- Funkcja: `({ key, locale }) => \`/locales/${locale}/${key}.content.json\``
|
|
1202
|
-
|
|
1203
|
-
- **noMetadata**:
|
|
1204
|
-
- _Typ_: `boolean`
|
|
1205
|
-
- _Domyślny_: `false`
|
|
1206
|
-
- _Opis_: Wskazuje, czy metadane powinny być zapisywane w pliku. Jeśli true, kompilator nie będzie zapisywał metadanych słowników (klucza, otoczki zawartości). Przydatne dla wyjść JSON i18next lub ICU MessageFormat na lokalizację.
|
|
1207
|
-
- _Uwaga_: Przydatne w przypadku korzystania z wtyczki `loadJSON`.
|
|
1208
|
-
- _Przykład_:
|
|
1209
|
-
Jeśli `true`:
|
|
1210
|
-
|
|
1211
|
-
```json
|
|
1212
|
-
{
|
|
1213
|
-
"key": "value"
|
|
1214
|
-
}
|
|
1215
|
-
```
|
|
1216
|
-
|
|
1217
|
-
Jeśli `false`:
|
|
1218
|
-
|
|
1219
|
-
```json
|
|
1220
|
-
{
|
|
1221
|
-
"key": "value",
|
|
1222
|
-
"content": {
|
|
1223
|
-
"key": "value"
|
|
1224
|
-
}
|
|
1225
|
-
}
|
|
1226
|
-
```
|