@intlayer/docs 7.5.9 → 7.5.10
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/README.md +9 -2
- package/dist/cjs/generated/docs.entry.cjs +19 -0
- package/dist/cjs/generated/docs.entry.cjs.map +1 -1
- package/dist/esm/generated/docs.entry.mjs +19 -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/cli/push.md +1 -1
- package/docs/ar/configuration.md +3 -3
- package/docs/ar/interest_of_intlayer.md +1 -1
- package/docs/ar/intlayer_CMS.md +5 -5
- package/docs/ar/intlayer_with_express.md +1 -0
- package/docs/ar/intlayer_with_fastify.md +516 -0
- package/docs/ar/readme.md +1 -1
- package/docs/de/cli/push.md +1 -1
- package/docs/de/configuration.md +3 -3
- package/docs/de/interest_of_intlayer.md +1 -1
- package/docs/de/intlayer_CMS.md +5 -5
- package/docs/de/intlayer_with_express.md +1 -0
- package/docs/de/intlayer_with_fastify.md +449 -0
- package/docs/de/readme.md +1 -1
- package/docs/en/cli/push.md +1 -1
- package/docs/en/configuration.md +3 -3
- package/docs/en/interest_of_intlayer.md +1 -1
- package/docs/en/intlayer_CMS.md +5 -5
- package/docs/en/intlayer_with_express.md +1 -0
- package/docs/en/intlayer_with_fastify.md +439 -0
- package/docs/en/readme.md +3 -1
- package/docs/en-GB/cli/push.md +1 -1
- package/docs/en-GB/configuration.md +3 -3
- package/docs/en-GB/interest_of_intlayer.md +1 -1
- package/docs/en-GB/intlayer_CMS.md +5 -5
- package/docs/en-GB/intlayer_with_express.md +1 -0
- package/docs/en-GB/intlayer_with_fastify.md +445 -0
- package/docs/en-GB/readme.md +3 -1
- package/docs/es/cli/push.md +1 -1
- package/docs/es/configuration.md +3 -3
- package/docs/es/interest_of_intlayer.md +1 -1
- package/docs/es/intlayer_CMS.md +5 -5
- package/docs/es/intlayer_with_express.md +1 -0
- package/docs/es/intlayer_with_fastify.md +480 -0
- package/docs/es/readme.md +1 -1
- package/docs/fr/cli/push.md +1 -1
- package/docs/fr/configuration.md +3 -3
- package/docs/fr/interest_of_intlayer.md +1 -1
- package/docs/fr/intlayer_CMS.md +5 -5
- package/docs/fr/intlayer_with_express.md +1 -0
- package/docs/fr/intlayer_with_fastify.md +439 -0
- package/docs/fr/readme.md +1 -1
- package/docs/hi/cli/push.md +1 -1
- package/docs/hi/configuration.md +3 -3
- package/docs/hi/interest_of_intlayer.md +1 -1
- package/docs/hi/intlayer_CMS.md +5 -5
- package/docs/hi/intlayer_with_express.md +1 -0
- package/docs/hi/intlayer_with_fastify.md +540 -0
- package/docs/hi/readme.md +1 -1
- package/docs/id/cli/push.md +1 -1
- package/docs/id/configuration.md +3 -3
- package/docs/id/interest_of_intlayer.md +1 -1
- package/docs/id/intlayer_CMS.md +5 -5
- package/docs/id/intlayer_with_express.md +1 -0
- package/docs/id/intlayer_with_fastify.md +470 -0
- package/docs/id/readme.md +1 -1
- package/docs/it/cli/push.md +1 -1
- package/docs/it/configuration.md +3 -3
- package/docs/it/interest_of_intlayer.md +1 -1
- package/docs/it/intlayer_CMS.md +5 -5
- package/docs/it/intlayer_with_express.md +1 -0
- package/docs/it/intlayer_with_fastify.md +445 -0
- package/docs/it/readme.md +1 -1
- package/docs/ja/cli/push.md +1 -1
- package/docs/ja/configuration.md +3 -3
- package/docs/ja/interest_of_intlayer.md +1 -1
- package/docs/ja/intlayer_CMS.md +5 -5
- package/docs/ja/intlayer_with_express.md +1 -0
- package/docs/ja/intlayer_with_fastify.md +516 -0
- package/docs/ja/readme.md +1 -1
- package/docs/ko/cli/push.md +1 -1
- package/docs/ko/configuration.md +3 -3
- package/docs/ko/interest_of_intlayer.md +1 -1
- package/docs/ko/intlayer_CMS.md +5 -5
- package/docs/ko/intlayer_with_express.md +1 -0
- package/docs/ko/intlayer_with_fastify.md +463 -0
- package/docs/ko/readme.md +1 -1
- package/docs/pl/cli/push.md +1 -1
- package/docs/pl/configuration.md +3 -3
- package/docs/pl/interest_of_intlayer.md +1 -1
- package/docs/pl/intlayer_CMS.md +5 -5
- package/docs/pl/intlayer_with_express.md +1 -0
- package/docs/pl/intlayer_with_fastify.md +457 -0
- package/docs/pl/readme.md +1 -1
- package/docs/pt/cli/push.md +1 -1
- package/docs/pt/configuration.md +3 -3
- package/docs/pt/interest_of_intlayer.md +1 -1
- package/docs/pt/intlayer_CMS.md +5 -5
- package/docs/pt/intlayer_with_express.md +1 -0
- package/docs/pt/intlayer_with_fastify.md +502 -0
- package/docs/pt/readme.md +1 -1
- package/docs/ru/cli/push.md +1 -1
- package/docs/ru/configuration.md +3 -3
- package/docs/ru/interest_of_intlayer.md +1 -1
- package/docs/ru/intlayer_CMS.md +5 -5
- package/docs/ru/intlayer_with_express.md +1 -0
- package/docs/ru/intlayer_with_fastify.md +468 -0
- package/docs/ru/readme.md +1 -1
- package/docs/tr/cli/push.md +1 -1
- package/docs/tr/configuration.md +3 -3
- package/docs/tr/interest_of_intlayer.md +1 -1
- package/docs/tr/intlayer_CMS.md +5 -5
- package/docs/tr/intlayer_with_express.md +1 -0
- package/docs/tr/intlayer_with_fastify.md +471 -0
- package/docs/tr/readme.md +1 -1
- package/docs/vi/cli/push.md +1 -1
- package/docs/vi/configuration.md +3 -3
- package/docs/vi/interest_of_intlayer.md +1 -1
- package/docs/vi/intlayer_CMS.md +5 -5
- package/docs/vi/intlayer_with_express.md +1 -0
- package/docs/vi/intlayer_with_fastify.md +490 -0
- package/docs/vi/readme.md +1 -1
- package/docs/zh/cli/push.md +1 -1
- package/docs/zh/configuration.md +3 -3
- package/docs/zh/interest_of_intlayer.md +1 -1
- package/docs/zh/intlayer_CMS.md +5 -5
- package/docs/zh/intlayer_with_express.md +1 -0
- package/docs/zh/intlayer_with_fastify.md +451 -0
- package/docs/zh/readme.md +1 -1
- package/package.json +6 -6
- package/src/generated/docs.entry.ts +19 -0
|
@@ -0,0 +1,439 @@
|
|
|
1
|
+
---
|
|
2
|
+
createdAt: 2025-12-30
|
|
3
|
+
updatedAt: 2025-12-30
|
|
4
|
+
title: How to translate your Fastify backend – i18n guide 2026
|
|
5
|
+
description: Discover how to make your Fastify backend multilingual. Follow the documentation to internationalize (i18n) and translate it.
|
|
6
|
+
keywords:
|
|
7
|
+
- Internationalization
|
|
8
|
+
- Documentation
|
|
9
|
+
- Intlayer
|
|
10
|
+
- Fastify
|
|
11
|
+
- JavaScript
|
|
12
|
+
- Backend
|
|
13
|
+
slugs:
|
|
14
|
+
- doc
|
|
15
|
+
- environment
|
|
16
|
+
- fastify
|
|
17
|
+
applicationTemplate: https://github.com/aymericzip/intlayer-fastify-template
|
|
18
|
+
history:
|
|
19
|
+
- version: 7.6.0
|
|
20
|
+
date: 2025-12-31
|
|
21
|
+
changes: Add init command
|
|
22
|
+
- version: 7.6.0
|
|
23
|
+
date: 2025-12-31
|
|
24
|
+
changes: Init history
|
|
25
|
+
---
|
|
26
|
+
|
|
27
|
+
# Translate your Fastify backend website using Intlayer | Internationalization (i18n)
|
|
28
|
+
|
|
29
|
+
`fastify-intlayer` is a powerful internationalization (i18n) plugin for Fastify applications, designed to make your backend services globally accessible by providing localized responses based on the client's preferences.
|
|
30
|
+
|
|
31
|
+
### Practical Use Cases
|
|
32
|
+
|
|
33
|
+
- **Displaying Backend Errors in User's Language**: When an error occurs, displaying messages in the user's native language improves understanding and reduces frustration. This is especially useful for dynamic error messages that might be shown in front-end components like toasts or modals.
|
|
34
|
+
- **Retrieving Multilingual Content**: For applications pulling content from a database, internationalization ensures that you can serve this content in multiple languages. This is crucial for platforms like e-commerce sites or content management systems that need to display product descriptions, articles, and other content in the language preferred by the user.
|
|
35
|
+
- **Sending Multilingual Emails**: Whether it's transactional emails, marketing campaigns, or notifications, sending emails in the recipient’s language can significantly increase engagement and effectiveness.
|
|
36
|
+
- **Multilingual Push Notifications**: For mobile applications, sending push notifications in a user's preferred language can enhance interaction and retention. This personal touch can make notifications feel more relevant and actionable.
|
|
37
|
+
- **Other Communications**: Any form of communication from the backend, such as SMS messages, system alerts, or user interface updates, benefits from being in the user's language, ensuring clarity and enhancing the overall user experience.
|
|
38
|
+
|
|
39
|
+
By internationalizing the backend, your application not only respects cultural differences but also aligns better with global market needs, making it a key step in scaling your services worldwide.
|
|
40
|
+
|
|
41
|
+
## Getting Started
|
|
42
|
+
|
|
43
|
+
### Installation
|
|
44
|
+
|
|
45
|
+
To begin using `fastify-intlayer`, install the package using npm:
|
|
46
|
+
|
|
47
|
+
```bash packageManager="npm"
|
|
48
|
+
npm install intlayer fastify-intlayer
|
|
49
|
+
npx intlayer init
|
|
50
|
+
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
```bash packageManager="pnpm"
|
|
54
|
+
pnpm add intlayer fastify-intlayer
|
|
55
|
+
pnpm intlayer init
|
|
56
|
+
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
```bash packageManager="yarn"
|
|
60
|
+
yarn add intlayer fastify-intlayer
|
|
61
|
+
yarn intlayer init
|
|
62
|
+
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
```bash packageManager="bun"
|
|
66
|
+
bun add intlayer fastify-intlayer
|
|
67
|
+
bunx intlayer init
|
|
68
|
+
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
### Setup
|
|
72
|
+
|
|
73
|
+
Configure the internationalization settings by creating an `intlayer.config.ts` in your project root:
|
|
74
|
+
|
|
75
|
+
```typescript fileName="intlayer.config.ts" codeFormat="typescript"
|
|
76
|
+
import { Locales, type IntlayerConfig } from "intlayer";
|
|
77
|
+
|
|
78
|
+
const config: IntlayerConfig = {
|
|
79
|
+
internationalization: {
|
|
80
|
+
locales: [
|
|
81
|
+
Locales.ENGLISH,
|
|
82
|
+
Locales.FRENCH,
|
|
83
|
+
Locales.SPANISH_MEXICO,
|
|
84
|
+
Locales.SPANISH_SPAIN,
|
|
85
|
+
],
|
|
86
|
+
defaultLocale: Locales.ENGLISH,
|
|
87
|
+
},
|
|
88
|
+
};
|
|
89
|
+
|
|
90
|
+
export default config;
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
```javascript fileName="intlayer.config.mjs" codeFormat="esm"
|
|
94
|
+
import { Locales } from "intlayer";
|
|
95
|
+
|
|
96
|
+
/** @type {import('intlayer').IntlayerConfig} */
|
|
97
|
+
const config = {
|
|
98
|
+
internationalization: {
|
|
99
|
+
locales: [
|
|
100
|
+
Locales.ENGLISH,
|
|
101
|
+
Locales.FRENCH,
|
|
102
|
+
Locales.SPANISH_MEXICO,
|
|
103
|
+
Locales.SPANISH_SPAIN,
|
|
104
|
+
],
|
|
105
|
+
defaultLocale: Locales.ENGLISH,
|
|
106
|
+
},
|
|
107
|
+
};
|
|
108
|
+
|
|
109
|
+
export default config;
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
```javascript fileName="intlayer.config.cjs" codeFormat="commonjs"
|
|
113
|
+
const { Locales } = require("intlayer");
|
|
114
|
+
|
|
115
|
+
/** @type {import('intlayer').IntlayerConfig} */
|
|
116
|
+
const config = {
|
|
117
|
+
internationalization: {
|
|
118
|
+
locales: [
|
|
119
|
+
Locales.ENGLISH,
|
|
120
|
+
Locales.FRENCH,
|
|
121
|
+
Locales.SPANISH_MEXICO,
|
|
122
|
+
Locales.SPANISH_SPAIN,
|
|
123
|
+
],
|
|
124
|
+
defaultLocale: Locales.ENGLISH,
|
|
125
|
+
},
|
|
126
|
+
};
|
|
127
|
+
|
|
128
|
+
module.exports = config;
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
### Declare Your Content
|
|
132
|
+
|
|
133
|
+
Create and manage your content declarations to store translations:
|
|
134
|
+
|
|
135
|
+
```typescript fileName="src/index.content.ts" contentDeclarationFormat="typescript"
|
|
136
|
+
import { t, type Dictionary } from "intlayer";
|
|
137
|
+
|
|
138
|
+
const indexContent = {
|
|
139
|
+
key: "index",
|
|
140
|
+
content: {
|
|
141
|
+
exampleOfContent: t({
|
|
142
|
+
en: "Example of returned content in English",
|
|
143
|
+
fr: "Exemple de contenu renvoyé en français",
|
|
144
|
+
"es-ES": "Ejemplo de contenido devuelto en español (España)",
|
|
145
|
+
"es-MX": "Ejemplo de contenido devuelto en español (México)",
|
|
146
|
+
}),
|
|
147
|
+
},
|
|
148
|
+
} satisfies Dictionary;
|
|
149
|
+
|
|
150
|
+
export default indexContent;
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
```javascript fileName="src/index.content.mjs" contentDeclarationFormat="esm"
|
|
154
|
+
import { t } from "intlayer";
|
|
155
|
+
|
|
156
|
+
/** @type {import('intlayer').Dictionary} */
|
|
157
|
+
const indexContent = {
|
|
158
|
+
key: "index",
|
|
159
|
+
content: {
|
|
160
|
+
exampleOfContent: t({
|
|
161
|
+
en: "Example of returned content in English",
|
|
162
|
+
fr: "Exemple de contenu renvoyé en français",
|
|
163
|
+
"es-ES": "Ejemplo de contenido devuelto en español (España)",
|
|
164
|
+
"es-MX": "Ejemplo de contenido devuelto en español (México)",
|
|
165
|
+
}),
|
|
166
|
+
},
|
|
167
|
+
};
|
|
168
|
+
|
|
169
|
+
export default indexContent;
|
|
170
|
+
```
|
|
171
|
+
|
|
172
|
+
```javascript fileName="src/index.content.cjs" contentDeclarationFormat="commonjs"
|
|
173
|
+
const { t } = require("intlayer");
|
|
174
|
+
|
|
175
|
+
/** @type {import('intlayer').Dictionary} */
|
|
176
|
+
const indexContent = {
|
|
177
|
+
key: "index",
|
|
178
|
+
content: {
|
|
179
|
+
exampleOfContent: t({
|
|
180
|
+
en: "Example of returned content in English",
|
|
181
|
+
fr: "Exemple de contenu renvoyé en français",
|
|
182
|
+
"es-ES": "Ejemplo de contenido devuelto en español (España)",
|
|
183
|
+
"es-MX": "Ejemplo de contenido devuelto en español (México)",
|
|
184
|
+
}),
|
|
185
|
+
},
|
|
186
|
+
};
|
|
187
|
+
|
|
188
|
+
module.exports = indexContent;
|
|
189
|
+
```
|
|
190
|
+
|
|
191
|
+
```json fileName="src/index.content.json" contentDeclarationFormat="json"
|
|
192
|
+
{
|
|
193
|
+
"$schema": "https://intlayer.org/schema.json",
|
|
194
|
+
"key": "index",
|
|
195
|
+
"content": {
|
|
196
|
+
"exampleOfContent": {
|
|
197
|
+
"nodeType": "translation",
|
|
198
|
+
"translation": {
|
|
199
|
+
"en": "Example of returned content in English",
|
|
200
|
+
"fr": "Exemple de contenu renvoyé en français",
|
|
201
|
+
"es-ES": "Ejemplo de contenido devuelto en español (España)",
|
|
202
|
+
"es-MX": "Ejemplo de contenido devuelto en español (México)"
|
|
203
|
+
}
|
|
204
|
+
}
|
|
205
|
+
}
|
|
206
|
+
}
|
|
207
|
+
```
|
|
208
|
+
|
|
209
|
+
> Your content declarations can be defined anywhere in your application as soon as they are included into the `contentDir` directory (by default, `./src`). And match the content declaration file extension (by default, `.content.{json,ts,tsx,js,jsx,mjs,mjx,cjs,cjx}`).
|
|
210
|
+
|
|
211
|
+
> For more details, refer to the [content declaration documentation](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/dictionary/content_file.md).
|
|
212
|
+
|
|
213
|
+
### Fastify Application Setup
|
|
214
|
+
|
|
215
|
+
Setup your Fastify application to use `fastify-intlayer`:
|
|
216
|
+
|
|
217
|
+
```typescript fileName="src/index.ts" codeFormat="typescript"
|
|
218
|
+
import Fastify from "fastify";
|
|
219
|
+
import { intlayer, t, getDictionary, getIntlayer } from "fastify-intlayer";
|
|
220
|
+
import dictionaryExample from "./index.content";
|
|
221
|
+
|
|
222
|
+
const fastify = Fastify({ logger: true });
|
|
223
|
+
|
|
224
|
+
// Load internationalization plugin
|
|
225
|
+
await fastify.register(intlayer);
|
|
226
|
+
|
|
227
|
+
// Routes
|
|
228
|
+
fastify.get("/t_example", async (_req, reply) => {
|
|
229
|
+
return t({
|
|
230
|
+
en: "Example of returned content in English",
|
|
231
|
+
fr: "Exemple de contenu renvoyé en français",
|
|
232
|
+
"es-ES": "Ejemplo de contenido devuelto en español (España)",
|
|
233
|
+
"es-MX": "Ejemplo de contenido devuelto en español (México)",
|
|
234
|
+
});
|
|
235
|
+
});
|
|
236
|
+
|
|
237
|
+
fastify.get("/getIntlayer_example", async (_req, reply) => {
|
|
238
|
+
return getIntlayer("index").exampleOfContent;
|
|
239
|
+
});
|
|
240
|
+
|
|
241
|
+
fastify.get("/getDictionary_example", async (_req, reply) => {
|
|
242
|
+
return getDictionary(dictionaryExample).exampleOfContent;
|
|
243
|
+
});
|
|
244
|
+
|
|
245
|
+
// Start server
|
|
246
|
+
const start = async () => {
|
|
247
|
+
try {
|
|
248
|
+
await fastify.listen({ port: 3000 });
|
|
249
|
+
} catch (err) {
|
|
250
|
+
fastify.log.error(err);
|
|
251
|
+
process.exit(1);
|
|
252
|
+
}
|
|
253
|
+
};
|
|
254
|
+
|
|
255
|
+
start();
|
|
256
|
+
```
|
|
257
|
+
|
|
258
|
+
```javascript fileName="src/index.mjs" codeFormat="esm"
|
|
259
|
+
import Fastify from "fastify";
|
|
260
|
+
import { intlayer, t, getDictionary, getIntlayer } from "fastify-intlayer";
|
|
261
|
+
import dictionaryExample from "./index.content";
|
|
262
|
+
|
|
263
|
+
const fastify = Fastify({ logger: true });
|
|
264
|
+
|
|
265
|
+
// Load internationalization plugin
|
|
266
|
+
await fastify.register(intlayer);
|
|
267
|
+
|
|
268
|
+
// Routes
|
|
269
|
+
fastify.get("/t_example", async (_req, reply) => {
|
|
270
|
+
return t({
|
|
271
|
+
en: "Example of returned content in English",
|
|
272
|
+
fr: "Exemple de contenu renvoyé en français",
|
|
273
|
+
"es-ES": "Ejemplo de contenido devuelto en español (España)",
|
|
274
|
+
"es-MX": "Ejemplo de contenido devuelto en español (México)",
|
|
275
|
+
});
|
|
276
|
+
});
|
|
277
|
+
|
|
278
|
+
fastify.get("/getIntlayer_example", async (_req, reply) => {
|
|
279
|
+
return getIntlayer("index").exampleOfContent;
|
|
280
|
+
});
|
|
281
|
+
|
|
282
|
+
fastify.get("/getDictionary_example", async (_req, reply) => {
|
|
283
|
+
return getDictionary(dictionaryExample).exampleOfContent;
|
|
284
|
+
});
|
|
285
|
+
|
|
286
|
+
// Start server
|
|
287
|
+
const start = async () => {
|
|
288
|
+
try {
|
|
289
|
+
await fastify.listen({ port: 3000 });
|
|
290
|
+
} catch (err) {
|
|
291
|
+
fastify.log.error(err);
|
|
292
|
+
process.exit(1);
|
|
293
|
+
}
|
|
294
|
+
};
|
|
295
|
+
|
|
296
|
+
start();
|
|
297
|
+
```
|
|
298
|
+
|
|
299
|
+
```javascript fileName="src/index.cjs" codeFormat="commonjs"
|
|
300
|
+
const Fastify = require("fastify");
|
|
301
|
+
const { intlayer, t, getDictionary, getIntlayer } = require("fastify-intlayer");
|
|
302
|
+
const dictionaryExample = require("./index.content");
|
|
303
|
+
|
|
304
|
+
const fastify = Fastify({ logger: true });
|
|
305
|
+
|
|
306
|
+
// Start server wrapper for async/await
|
|
307
|
+
const start = async () => {
|
|
308
|
+
try {
|
|
309
|
+
// Load internationalization plugin
|
|
310
|
+
await fastify.register(intlayer);
|
|
311
|
+
|
|
312
|
+
// Routes
|
|
313
|
+
fastify.get("/t_example", async (_req, reply) => {
|
|
314
|
+
return t({
|
|
315
|
+
en: "Example of returned content in English",
|
|
316
|
+
fr: "Exemple de contenu renvoyé en français",
|
|
317
|
+
"es-ES": "Ejemplo de contenido devuelto en español (España)",
|
|
318
|
+
"es-MX": "Ejemplo de contenido devuelto en español (México)",
|
|
319
|
+
});
|
|
320
|
+
});
|
|
321
|
+
|
|
322
|
+
fastify.get("/getIntlayer_example", async (_req, reply) => {
|
|
323
|
+
return getIntlayer("index").exampleOfContent;
|
|
324
|
+
});
|
|
325
|
+
|
|
326
|
+
fastify.get("/getDictionary_example", async (_req, reply) => {
|
|
327
|
+
return getDictionary(dictionaryExample).exampleOfContent;
|
|
328
|
+
});
|
|
329
|
+
|
|
330
|
+
await fastify.listen({ port: 3000 });
|
|
331
|
+
} catch (err) {
|
|
332
|
+
fastify.log.error(err);
|
|
333
|
+
process.exit(1);
|
|
334
|
+
}
|
|
335
|
+
};
|
|
336
|
+
|
|
337
|
+
start();
|
|
338
|
+
```
|
|
339
|
+
|
|
340
|
+
### Compatibility
|
|
341
|
+
|
|
342
|
+
`fastify-intlayer` is fully compatible with:
|
|
343
|
+
|
|
344
|
+
- [`react-intlayer`](<https://www.google.com/search?q=%5Bhttps://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/react-intlayer/index.md%5D(https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/react-intlayer/index.md)>) for React applications
|
|
345
|
+
- [`next-intlayer`](<https://www.google.com/search?q=%5Bhttps://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/next-intlayer/index.md%5D(https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/next-intlayer/index.md)>) for Next.js applications
|
|
346
|
+
- [`vite-intlayer`](<https://www.google.com/search?q=%5Bhttps://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/vite-intlayer/index.md%5D(https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/vite-intlayer/index.md)>) for Vite applications
|
|
347
|
+
|
|
348
|
+
It also works seamlessly with any internationalization solution across various environments, including browsers and API requests. You can customize the middleware to detect locale through headers or cookies:
|
|
349
|
+
|
|
350
|
+
```typescript fileName="intlayer.config.ts" codeFormat="typescript"
|
|
351
|
+
import { Locales, type IntlayerConfig } from "intlayer";
|
|
352
|
+
|
|
353
|
+
const config: IntlayerConfig = {
|
|
354
|
+
// ... Other configuration options
|
|
355
|
+
middleware: {
|
|
356
|
+
headerName: "my-locale-header",
|
|
357
|
+
cookieName: "my-locale-cookie",
|
|
358
|
+
},
|
|
359
|
+
};
|
|
360
|
+
|
|
361
|
+
export default config;
|
|
362
|
+
```
|
|
363
|
+
|
|
364
|
+
```javascript fileName="intlayer.config.mjs" codeFormat="esm"
|
|
365
|
+
import { Locales } from "intlayer";
|
|
366
|
+
|
|
367
|
+
/** @type {import('intlayer').IntlayerConfig} */
|
|
368
|
+
const config = {
|
|
369
|
+
// ... Other configuration options
|
|
370
|
+
middleware: {
|
|
371
|
+
headerName: "my-locale-header",
|
|
372
|
+
cookieName: "my-locale-cookie",
|
|
373
|
+
},
|
|
374
|
+
};
|
|
375
|
+
|
|
376
|
+
export default config;
|
|
377
|
+
```
|
|
378
|
+
|
|
379
|
+
```javascript fileName="intlayer.config.cjs" codeFormat="commonjs"
|
|
380
|
+
const { Locales } = require("intlayer");
|
|
381
|
+
|
|
382
|
+
/** @type {import('intlayer').IntlayerConfig} */
|
|
383
|
+
const config = {
|
|
384
|
+
// ... Other configuration options
|
|
385
|
+
middleware: {
|
|
386
|
+
headerName: "my-locale-header",
|
|
387
|
+
cookieName: "my-locale-cookie",
|
|
388
|
+
},
|
|
389
|
+
};
|
|
390
|
+
|
|
391
|
+
module.exports = config;
|
|
392
|
+
```
|
|
393
|
+
|
|
394
|
+
By default, `fastify-intlayer` will interpret the `Accept-Language` header to determine the client's preferred language.
|
|
395
|
+
|
|
396
|
+
> For more information on configuration and advanced topics, visit our [documentation](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/configuration.md).
|
|
397
|
+
|
|
398
|
+
### Configure TypeScript
|
|
399
|
+
|
|
400
|
+
`fastify-intlayer` leverages the robust capabilities of TypeScript to enhance the internationalization process. TypeScript's static typing ensures that every translation key is accounted for, reducing the risk of missing translations and improving maintainability.
|
|
401
|
+
|
|
402
|
+
Ensure the autogenerated types (by default at ./types/intlayer.d.ts) are included in your tsconfig.json file.
|
|
403
|
+
|
|
404
|
+
```json5 fileName="tsconfig.json"
|
|
405
|
+
{
|
|
406
|
+
// ... Your existing TypeScript configurations
|
|
407
|
+
"include": [
|
|
408
|
+
// ... Your existing TypeScript configurations
|
|
409
|
+
".intlayer/**/*.ts", // Include the auto-generated types
|
|
410
|
+
],
|
|
411
|
+
}
|
|
412
|
+
```
|
|
413
|
+
|
|
414
|
+
### VS Code Extension
|
|
415
|
+
|
|
416
|
+
To improve your development experience with Intlayer, you can install the official **Intlayer VS Code Extension**.
|
|
417
|
+
|
|
418
|
+
[Install from the VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=intlayer.intlayer-vs-code-extension)
|
|
419
|
+
|
|
420
|
+
This extension provides:
|
|
421
|
+
|
|
422
|
+
- **Autocompletion** for translation keys.
|
|
423
|
+
- **Real-time error detection** for missing translations.
|
|
424
|
+
- **Inline previews** of translated content.
|
|
425
|
+
- **Quick actions** to easily create and update translations.
|
|
426
|
+
|
|
427
|
+
For more details on how to use the extension, refer to the [Intlayer VS Code Extension documentation](https://intlayer.org/doc/vs-code-extension).
|
|
428
|
+
|
|
429
|
+
### Git Configuration
|
|
430
|
+
|
|
431
|
+
It is recommended to ignore the files generated by Intlayer. This allows you to avoid committing them to your Git repository.
|
|
432
|
+
|
|
433
|
+
To do this, you can add the following instructions to your `.gitignore` file:
|
|
434
|
+
|
|
435
|
+
```plaintext fileName=".gitignore"
|
|
436
|
+
# Ignore the files generated by Intlayer
|
|
437
|
+
.intlayer
|
|
438
|
+
|
|
439
|
+
```
|
package/docs/en/readme.md
CHANGED
|
@@ -52,7 +52,7 @@ With **per-locale content files**, **TypeScript autocompletion**, **tree-shakabl
|
|
|
52
52
|
| Feature | Description |
|
|
53
53
|
| --------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
54
54
|
| <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/frameworks.png?raw=true" alt="Feature" width="700"> | **Cross-Frameworks Support**<br><br>Intlayer is compatible with all major frameworks and libraries, including Next.js, React, Vite, Vue.js, Nuxt, Preact, Express, and more. |
|
|
55
|
-
| <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/javascript_content_management.
|
|
55
|
+
| <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/javascript_content_management.jpg?raw=true" alt="Feature" width="700"> | **JavaScript-Powered Content Management**<br><br>Harness the flexibility of JavaScript to define and manage your content efficiently. <br><br> - [Content declaration](https://intlayer.org/doc/concept/content) |
|
|
56
56
|
| <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/per_locale_content_declaration_file.png?raw=true" alt="Feature" width="700"> | **Per-Locale Content Declaration File**<br><br>Speed up your development by declaring your content once, before auto generation.<br><br> - [Per-Locale Content Declaration File](https://intlayer.org/doc/concept/per-locale-file) |
|
|
57
57
|
| <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/autocompletion.png?raw=true" alt="Feature" width="700"> | **Type-Safe Environment**<br><br>Leverage TypeScript to ensure your content definitions and code are error-free, while also benefiting from IDE autocompletion.<br><br> - [TypeScript configuration](https://intlayer.org/doc/environment/vite-and-react#configure-typescript) |
|
|
58
58
|
| <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/config_file.png?raw=true" alt="Feature" width="700"> | **Simplified Setup**<br><br>Get up and running quickly with minimal configuration. Adjust settings for internationalization, routing, AI, build, and content handling with ease. <br><br> - [Explore Next.js integration](https://intlayer.org/doc/environment/nextjs) |
|
|
@@ -256,6 +256,8 @@ You can also follow us on :
|
|
|
256
256
|
|
|
257
257
|
For more detailed guidelines on contributing to this project, please refer to the [`CONTRIBUTING.md`](https://github.com/aymericzip/intlayer/blob/main/CONTRIBUTING.md) file. It contains essential information on our development process, commit message conventions, and release procedures. Your contributions are valuable to us, and we appreciate your efforts in making this project better!
|
|
258
258
|
|
|
259
|
+
Contribute on [GitHub](https://github.com/aymericzip/intlayer), [GitLab](https://gitlab.com/ay.pineau/intlayer), or [Bitbucket](https://bitbucket.org/intlayer/intlayer/).
|
|
260
|
+
|
|
259
261
|
### Thank You for the Support
|
|
260
262
|
|
|
261
263
|
If you like Intlayer, give us a ⭐ on GitHub. It helps others discover the project!
|
package/docs/en-GB/cli/push.md
CHANGED
|
@@ -23,7 +23,7 @@ slugs:
|
|
|
23
23
|
npx intlayer dictionary push
|
|
24
24
|
```
|
|
25
25
|
|
|
26
|
-
If the [intlayer editor](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/intlayer_visual_editor.md) is installed, you can also push dictionaries to the editor. This command will allow you to make the dictionaries available to [the editor](https://intlayer.org/
|
|
26
|
+
If the [intlayer editor](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/intlayer_visual_editor.md) is installed, you can also push dictionaries to the editor. This command will allow you to make the dictionaries available to [the editor](https://app.intlayer.org/). In this way, you can share your dictionaries with your team and edit your content without modifying the code of your application.
|
|
27
27
|
|
|
28
28
|
## Aliases:
|
|
29
29
|
|
|
@@ -246,14 +246,14 @@ Defines settings related to the integrated editor, including server port and act
|
|
|
246
246
|
- **clientId**:
|
|
247
247
|
- _Type_: `string` | `undefined`
|
|
248
248
|
- _Default_: `undefined`
|
|
249
|
-
- _Description_: clientId and clientSecret allow the intlayer packages to authenticate with the backend using oAuth2 authentication. An access token is used to authenticate the user related to the project. To obtain an access token, visit https://intlayer.org/
|
|
249
|
+
- _Description_: clientId and clientSecret allow the intlayer packages to authenticate with the backend using oAuth2 authentication. An access token is used to authenticate the user related to the project. To obtain an access token, visit https://app.intlayer.org/project and create an account.
|
|
250
250
|
- _Example_: `true`
|
|
251
251
|
- _Note_: Important: The clientId and clientSecret should be kept confidential and not shared publicly. Please ensure they are stored securely, such as in environment variables.
|
|
252
252
|
|
|
253
253
|
- **clientSecret**:
|
|
254
254
|
- _Type_: `string` | `undefined`
|
|
255
255
|
- _Default_: `undefined`
|
|
256
|
-
- _Description_: clientId and clientSecret allow the intlayer packages to authenticate with the backend using oAuth2 authentication. An access token is used to authenticate the user related to the project. To obtain an access token, visit https://intlayer.org/
|
|
256
|
+
- _Description_: clientId and clientSecret allow the intlayer packages to authenticate with the backend using oAuth2 authentication. An access token is used to authenticate the user related to the project. To obtain an access token, visit https://app.intlayer.org/project and create an account.
|
|
257
257
|
- _Example_: `true`
|
|
258
258
|
- _Note_: Important: The clientId and clientSecret should be kept confidential and not shared publicly. Please ensure they are stored securely, such as in environment variables.
|
|
259
259
|
|
|
@@ -469,7 +469,7 @@ Settings that control the logger, including the prefix to use.
|
|
|
469
469
|
|
|
470
470
|
Settings that control the AI features of Intlayer, including the provider, model, and API key.
|
|
471
471
|
|
|
472
|
-
This configuration is optional if you are registered on the [Intlayer Dashboard](https://intlayer.org/
|
|
472
|
+
This configuration is optional if you are registered on the [Intlayer Dashboard](https://app.intlayer.org/project) using an access key. Intlayer will automatically manage the most efficient and cost-effective AI solution for your needs. Using the default options ensures better long-term maintainability as Intlayer continuously updates to use the most relevant models.
|
|
473
473
|
|
|
474
474
|
If you prefer to use your own API key or specific model, you can define your custom AI configuration.
|
|
475
475
|
This AI configuration will be used globally across your Intlayer environment. CLI commands will use these settings as defaults for the commands (e.g. `fill`), as well as the SDK, Visual Editor, and CMS. You can override these default values for specific use cases using command parameters.
|
|
@@ -226,7 +226,7 @@ This approach allows you to:
|
|
|
226
226
|
| ------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
227
227
|
| ------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
228
228
|
|  | **Cross-Framework Support**<br><br>Intlayer is compatible with all major frameworks and libraries, including Next.js, React, Vite, Vue.js, Nuxt, Preact, Express, and more. |
|
|
229
|
-
|  | **JavaScript-Powered Content Management**<br><br>Harness the flexibility of JavaScript to define and manage your content efficiently. <br><br> - [Content declaration](https://intlayer.org/doc/concept/content) |
|
|
230
230
|
|  | **Per-Locale Content Declaration File**<br><br>Accelerate your development by declaring your content once, prior to auto-generation.<br><br> - [Per-Locale Content Declaration File](https://intlayer.org/doc/concept/per-locale-file) |
|
|
231
231
|
|  | **Type-Safe Environment**<br><br>Leverage TypeScript to ensure your content definitions and code are error-free, while also benefiting from IDE autocompletion.<br><br> - [TypeScript configuration](https://intlayer.org/doc/environment/vite-and-react#configure-typescript) |
|
|
232
232
|
|  | **Simplified Setup**<br><br>Get up and running quickly with minimal configuration. Adjust settings for internationalisation, routing, AI, build, and content handling with ease. <br><br> - [Explore Next.js integration](https://intlayer.org/doc/environment/nextjs) |
|
|
@@ -92,7 +92,7 @@ const config: IntlayerConfig = {
|
|
|
92
92
|
*
|
|
93
93
|
* Client ID and client secret are required to enable the editor.
|
|
94
94
|
* They allow the identification of the user who is editing the content.
|
|
95
|
-
* They can be obtained by creating a new client in the Intlayer Dashboard - Projects (https://intlayer.org/
|
|
95
|
+
* They can be obtained by creating a new client in the Intlayer Dashboard - Projects (https://app.intlayer.org/projects).
|
|
96
96
|
* clientId: process.env.INTLAYER_CLIENT_ID,
|
|
97
97
|
* clientSecret: process.env.INTLAYER_CLIENT_SECRET,
|
|
98
98
|
*/
|
|
@@ -142,7 +142,7 @@ const config = {
|
|
|
142
142
|
*
|
|
143
143
|
* Client ID and client secret are required to enable the editor.
|
|
144
144
|
* They allow the identification of the user who is editing the content.
|
|
145
|
-
* They can be obtained by creating a new client in the Intlayer Dashboard - Projects (https://intlayer.org/
|
|
145
|
+
* They can be obtained by creating a new client in the Intlayer Dashboard - Projects (https://app.intlayer.org/projects).
|
|
146
146
|
* clientId: process.env.INTLAYER_CLIENT_ID,
|
|
147
147
|
* clientSecret: process.env.INTLAYER_CLIENT_SECRET,
|
|
148
148
|
*/
|
|
@@ -192,7 +192,7 @@ const config = {
|
|
|
192
192
|
*
|
|
193
193
|
* Client ID and client secret are required to enable the editor.
|
|
194
194
|
* They allow the identification of the user who is editing the content.
|
|
195
|
-
* They can be obtained by creating a new client in the Intlayer Dashboard - Projects (https://intlayer.org/
|
|
195
|
+
* They can be obtained by creating a new client in the Intlayer Dashboard - Projects (https://app.intlayer.org/projects).
|
|
196
196
|
* clientId: process.env.INTLAYER_CLIENT_ID,
|
|
197
197
|
* clientSecret: process.env.INTLAYER_CLIENT_SECRET,
|
|
198
198
|
*/
|
|
@@ -224,7 +224,7 @@ const config = {
|
|
|
224
224
|
module.exports = config;
|
|
225
225
|
```
|
|
226
226
|
|
|
227
|
-
> If you do not have a client ID and client secret, you can obtain them by creating a new client in the [Intlayer Dashboard - Projects](https://intlayer.org/
|
|
227
|
+
> If you do not have a client ID and client secret, you can obtain them by creating a new client in the [Intlayer Dashboard - Projects](https://app.intlayer.org/projects).
|
|
228
228
|
|
|
229
229
|
> To see all available parameters, refer to the [configuration documentation](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/configuration.md).
|
|
230
230
|
|
|
@@ -264,7 +264,7 @@ This command uploads your initial content dictionaries, making them available fo
|
|
|
264
264
|
|
|
265
265
|
### Edit the dictionary
|
|
266
266
|
|
|
267
|
-
You will then be able to view and manage your dictionary in the [Intlayer CMS](https://intlayer.org/
|
|
267
|
+
You will then be able to view and manage your dictionary in the [Intlayer CMS](https://app.intlayer.org/content).
|
|
268
268
|
|
|
269
269
|
## Live sync
|
|
270
270
|
|