@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,445 @@
|
|
|
1
|
+
---
|
|
2
|
+
createdAt: 2025-12-30
|
|
3
|
+
updatedAt: 2025-12-30
|
|
4
|
+
title: How to translate your Fastify back end – i18n guide 2026
|
|
5
|
+
description: Discover how to make your Fastify back end multilingual. Follow the documentation to internationalise (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 back end site using Intlayer | Internationalisation (i18n)
|
|
28
|
+
|
|
29
|
+
`fastify-intlayer` is a powerful internationalisation (i18n) plugin for Fastify applications, designed to make your back end services globally accessible by providing localised responses based on the client's preferences.
|
|
30
|
+
|
|
31
|
+
### Practical Use Cases
|
|
32
|
+
|
|
33
|
+
- **Displaying back end errors in the 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, internationalisation ensures that you can serve this content in multiple languages. This is crucial for platforms such as 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 improving the overall user experience.
|
|
38
|
+
|
|
39
|
+
By internationalising the backend, your application not only respects cultural differences but also better aligns 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 internationalisation 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-GB": "Example of returned content in English",
|
|
143
|
+
en: "Example of returned content in English",
|
|
144
|
+
fr: "Exemple de contenu renvoyé en français",
|
|
145
|
+
"es-ES": "Ejemplo de contenido devuelto en español (España)",
|
|
146
|
+
"es-MX": "Ejemplo de contenido devuelto en español (México)",
|
|
147
|
+
}),
|
|
148
|
+
},
|
|
149
|
+
} satisfies Dictionary;
|
|
150
|
+
|
|
151
|
+
export default indexContent;
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
```javascript fileName="src/index.content.mjs" contentDeclarationFormat="esm"
|
|
155
|
+
import { t } from "intlayer";
|
|
156
|
+
|
|
157
|
+
/** @type {import('intlayer').Dictionary} */
|
|
158
|
+
const indexContent = {
|
|
159
|
+
key: "index",
|
|
160
|
+
content: {
|
|
161
|
+
exampleOfContent: t({
|
|
162
|
+
"en-GB": "Example of returned content in English",
|
|
163
|
+
en: "Example of returned content in English",
|
|
164
|
+
fr: "Exemple de contenu renvoyé en français",
|
|
165
|
+
"es-ES": "Ejemplo de contenido devuelto en español (España)",
|
|
166
|
+
"es-MX": "Ejemplo de contenido devuelto en español (México)",
|
|
167
|
+
}),
|
|
168
|
+
},
|
|
169
|
+
};
|
|
170
|
+
|
|
171
|
+
export default indexContent;
|
|
172
|
+
```
|
|
173
|
+
|
|
174
|
+
```javascript fileName="src/index.content.cjs" contentDeclarationFormat="commonjs"
|
|
175
|
+
const { t } = require("intlayer");
|
|
176
|
+
|
|
177
|
+
/** @type {import('intlayer').Dictionary} */
|
|
178
|
+
const indexContent = {
|
|
179
|
+
key: "index",
|
|
180
|
+
content: {
|
|
181
|
+
exampleOfContent: t({
|
|
182
|
+
"en-GB": "Example of returned content in English",
|
|
183
|
+
en: "Example of returned content in English",
|
|
184
|
+
fr: "Exemple de contenu renvoyé en français",
|
|
185
|
+
"es-ES": "Ejemplo de contenido devuelto en español (España)",
|
|
186
|
+
"es-MX": "Ejemplo de contenido devuelto en español (México)",
|
|
187
|
+
}),
|
|
188
|
+
},
|
|
189
|
+
};
|
|
190
|
+
|
|
191
|
+
module.exports = indexContent;
|
|
192
|
+
```
|
|
193
|
+
|
|
194
|
+
```json fileName="src/index.content.json" contentDeclarationFormat="json"
|
|
195
|
+
{
|
|
196
|
+
"$schema": "https://intlayer.org/schema.json",
|
|
197
|
+
"key": "index",
|
|
198
|
+
"content": {
|
|
199
|
+
"exampleOfContent": {
|
|
200
|
+
"nodeType": "translation",
|
|
201
|
+
"translation": {
|
|
202
|
+
"en-GB": "Example of returned content in English",
|
|
203
|
+
"en": "Example of returned content in English",
|
|
204
|
+
"fr": "Exemple de contenu renvoyé en français",
|
|
205
|
+
"es-ES": "Ejemplo de contenido devuelto en español (España)",
|
|
206
|
+
"es-MX": "Ejemplo de contenido devuelto en español (México)"
|
|
207
|
+
}
|
|
208
|
+
}
|
|
209
|
+
}
|
|
210
|
+
}
|
|
211
|
+
```
|
|
212
|
+
|
|
213
|
+
> Your content declarations can be placed anywhere in your application provided they are included in 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}`).
|
|
214
|
+
|
|
215
|
+
> For more details, refer to the [content declaration documentation](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/dictionary/content_file.md).
|
|
216
|
+
|
|
217
|
+
### Fastify application setup
|
|
218
|
+
|
|
219
|
+
Set up your Fastify application to use `fastify-intlayer`:
|
|
220
|
+
|
|
221
|
+
```typescript fileName="src/index.ts" codeFormat="typescript"
|
|
222
|
+
import Fastify from "fastify";
|
|
223
|
+
import { intlayer, t, getDictionary, getIntlayer } from "fastify-intlayer";
|
|
224
|
+
import dictionaryExample from "./index.content";
|
|
225
|
+
|
|
226
|
+
const fastify = Fastify({ logger: true });
|
|
227
|
+
|
|
228
|
+
// Load internationalisation plugin
|
|
229
|
+
await fastify.register(intlayer);
|
|
230
|
+
|
|
231
|
+
// Routes
|
|
232
|
+
fastify.get("/t_example", async (_req, reply) => {
|
|
233
|
+
return t({
|
|
234
|
+
"en-GB": "Example of returned content in English",
|
|
235
|
+
en: "Example of returned content in English",
|
|
236
|
+
fr: "Exemple de contenu renvoyé en français",
|
|
237
|
+
"es-ES": "Ejemplo de contenido devuelto en español (España)",
|
|
238
|
+
"es-MX": "Ejemplo de contenido devuelto en español (México)",
|
|
239
|
+
});
|
|
240
|
+
});
|
|
241
|
+
|
|
242
|
+
fastify.get("/getIntlayer_example", async (_req, reply) => {
|
|
243
|
+
return getIntlayer("index").exampleOfContent;
|
|
244
|
+
});
|
|
245
|
+
|
|
246
|
+
fastify.get("/getDictionary_example", async (_req, reply) => {
|
|
247
|
+
return getDictionary(dictionaryExample).exampleOfContent;
|
|
248
|
+
});
|
|
249
|
+
|
|
250
|
+
// Start server
|
|
251
|
+
const start = async () => {
|
|
252
|
+
try {
|
|
253
|
+
await fastify.listen({ port: 3000 });
|
|
254
|
+
} catch (err) {
|
|
255
|
+
fastify.log.error(err);
|
|
256
|
+
process.exit(1);
|
|
257
|
+
}
|
|
258
|
+
};
|
|
259
|
+
|
|
260
|
+
start();
|
|
261
|
+
```
|
|
262
|
+
|
|
263
|
+
```javascript fileName="src/index.mjs" codeFormat="esm"
|
|
264
|
+
import Fastify from "fastify";
|
|
265
|
+
import { intlayer, t, getDictionary, getIntlayer } from "fastify-intlayer";
|
|
266
|
+
import dictionaryExample from "./index.content";
|
|
267
|
+
|
|
268
|
+
const fastify = Fastify({ logger: true });
|
|
269
|
+
|
|
270
|
+
// Load internationalisation plugin
|
|
271
|
+
await fastify.register(intlayer);
|
|
272
|
+
|
|
273
|
+
// Routes
|
|
274
|
+
fastify.get("/t_example", async (_req, reply) => {
|
|
275
|
+
return t({
|
|
276
|
+
en: "Example of returned content in English",
|
|
277
|
+
fr: "Exemple de contenu renvoyé en français",
|
|
278
|
+
"es-ES": "Ejemplo de contenido devuelto en español (España)",
|
|
279
|
+
"es-MX": "Ejemplo de contenido devuelto en español (México)",
|
|
280
|
+
});
|
|
281
|
+
});
|
|
282
|
+
|
|
283
|
+
fastify.get("/getIntlayer_example", async (_req, reply) => {
|
|
284
|
+
return getIntlayer("index").exampleOfContent;
|
|
285
|
+
});
|
|
286
|
+
|
|
287
|
+
fastify.get("/getDictionary_example", async (_req, reply) => {
|
|
288
|
+
return getDictionary(dictionaryExample).exampleOfContent;
|
|
289
|
+
});
|
|
290
|
+
|
|
291
|
+
// Start the server
|
|
292
|
+
const start = async () => {
|
|
293
|
+
try {
|
|
294
|
+
await fastify.listen({ port: 3000 });
|
|
295
|
+
} catch (err) {
|
|
296
|
+
fastify.log.error(err);
|
|
297
|
+
process.exit(1);
|
|
298
|
+
}
|
|
299
|
+
};
|
|
300
|
+
|
|
301
|
+
start();
|
|
302
|
+
```
|
|
303
|
+
|
|
304
|
+
```javascript fileName="src/index.cjs" codeFormat="commonjs"
|
|
305
|
+
const Fastify = require("fastify");
|
|
306
|
+
const { intlayer, t, getDictionary, getIntlayer } = require("fastify-intlayer");
|
|
307
|
+
const dictionaryExample = require("./index.content");
|
|
308
|
+
|
|
309
|
+
const fastify = Fastify({ logger: true });
|
|
310
|
+
|
|
311
|
+
// Start the server wrapper for async/await
|
|
312
|
+
const start = async () => {
|
|
313
|
+
try {
|
|
314
|
+
// Load internationalisation plugin
|
|
315
|
+
await fastify.register(intlayer);
|
|
316
|
+
|
|
317
|
+
// Routes
|
|
318
|
+
fastify.get("/t_example", async (_req, reply) => {
|
|
319
|
+
return t({
|
|
320
|
+
"en-GB": "Example of returned content in English",
|
|
321
|
+
en: "Example of returned content in English",
|
|
322
|
+
fr: "Exemple de contenu renvoyé en français",
|
|
323
|
+
"es-ES": "Ejemplo de contenido devuelto en español (España)",
|
|
324
|
+
"es-MX": "Ejemplo de contenido devuelto en español (México)",
|
|
325
|
+
});
|
|
326
|
+
});
|
|
327
|
+
|
|
328
|
+
fastify.get("/getIntlayer_example", async (_req, reply) => {
|
|
329
|
+
return getIntlayer("index").exampleOfContent;
|
|
330
|
+
});
|
|
331
|
+
|
|
332
|
+
fastify.get("/getDictionary_example", async (_req, reply) => {
|
|
333
|
+
return getDictionary(dictionaryExample).exampleOfContent;
|
|
334
|
+
});
|
|
335
|
+
|
|
336
|
+
await fastify.listen({ port: 3000 });
|
|
337
|
+
} catch (err) {
|
|
338
|
+
fastify.log.error(err);
|
|
339
|
+
process.exit(1);
|
|
340
|
+
}
|
|
341
|
+
};
|
|
342
|
+
|
|
343
|
+
start();
|
|
344
|
+
```
|
|
345
|
+
|
|
346
|
+
### Compatibility
|
|
347
|
+
|
|
348
|
+
`fastify-intlayer` is fully compatible with:
|
|
349
|
+
|
|
350
|
+
- [`react-intlayer`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/packages/react-intlayer/index.md) for React applications
|
|
351
|
+
- [`next-intlayer`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/packages/next-intlayer/index.md) for Next.js applications
|
|
352
|
+
- [`vite-intlayer`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/packages/vite-intlayer/index.md) for Vite applications
|
|
353
|
+
|
|
354
|
+
It also works seamlessly with any internationalisation solution across various environments, including browsers and API requests. You can customise the middleware to detect locale through headers or cookies:
|
|
355
|
+
|
|
356
|
+
```typescript fileName="intlayer.config.ts" codeFormat="typescript"
|
|
357
|
+
import { Locales, type IntlayerConfig } from "intlayer";
|
|
358
|
+
|
|
359
|
+
const config: IntlayerConfig = {
|
|
360
|
+
// ... Other configuration options
|
|
361
|
+
middleware: {
|
|
362
|
+
headerName: "my-locale-header",
|
|
363
|
+
cookieName: "my-locale-cookie",
|
|
364
|
+
},
|
|
365
|
+
};
|
|
366
|
+
|
|
367
|
+
export default config;
|
|
368
|
+
```
|
|
369
|
+
|
|
370
|
+
```javascript fileName="intlayer.config.mjs" codeFormat="esm"
|
|
371
|
+
import { Locales } from "intlayer";
|
|
372
|
+
|
|
373
|
+
/** @type {import('intlayer').IntlayerConfig} */
|
|
374
|
+
const config = {
|
|
375
|
+
// ... Other configuration options
|
|
376
|
+
middleware: {
|
|
377
|
+
headerName: "my-locale-header",
|
|
378
|
+
cookieName: "my-locale-cookie",
|
|
379
|
+
},
|
|
380
|
+
};
|
|
381
|
+
|
|
382
|
+
export default config;
|
|
383
|
+
```
|
|
384
|
+
|
|
385
|
+
```javascript fileName="intlayer.config.cjs" codeFormat="commonjs"
|
|
386
|
+
const { Locales } = require("intlayer");
|
|
387
|
+
|
|
388
|
+
/** @type {import('intlayer').IntlayerConfig} */
|
|
389
|
+
const config = {
|
|
390
|
+
// ... Other configuration options
|
|
391
|
+
middleware: {
|
|
392
|
+
headerName: "my-locale-header",
|
|
393
|
+
cookieName: "my-locale-cookie",
|
|
394
|
+
},
|
|
395
|
+
};
|
|
396
|
+
|
|
397
|
+
module.exports = config;
|
|
398
|
+
```
|
|
399
|
+
|
|
400
|
+
By default, `fastify-intlayer` will interpret the `Accept-Language` header to determine the client's preferred language.
|
|
401
|
+
|
|
402
|
+
> For more information on configuration and advanced topics, visit our [documentation](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/configuration.md).
|
|
403
|
+
|
|
404
|
+
### Configure TypeScript
|
|
405
|
+
|
|
406
|
+
`fastify-intlayer` leverages the robust capabilities of TypeScript to enhance the internationalisation process. TypeScript's static typing ensures that every translation key is accounted for, reducing the risk of missing translations and improving maintainability.
|
|
407
|
+
|
|
408
|
+
Ensure the auto-generated types (by default at ./types/intlayer.d.ts) are included in your tsconfig.json file.
|
|
409
|
+
|
|
410
|
+
```json5 fileName="tsconfig.json"
|
|
411
|
+
{
|
|
412
|
+
// ... Your existing TypeScript configuration
|
|
413
|
+
"include": [
|
|
414
|
+
// ... Your existing TypeScript configuration
|
|
415
|
+
".intlayer/**/*.ts", // Include the auto-generated types
|
|
416
|
+
],
|
|
417
|
+
}
|
|
418
|
+
```
|
|
419
|
+
|
|
420
|
+
### VS Code Extension
|
|
421
|
+
|
|
422
|
+
To improve your development experience with Intlayer, you can install the official **Intlayer VS Code Extension**.
|
|
423
|
+
|
|
424
|
+
[Install from the Visual Studio Code Marketplace](https://marketplace.visualstudio.com/items?itemName=intlayer.intlayer-vs-code-extension)
|
|
425
|
+
|
|
426
|
+
This extension provides:
|
|
427
|
+
|
|
428
|
+
- **Auto-completion** for translation keys.
|
|
429
|
+
- **Real-time error detection** of missing translations.
|
|
430
|
+
- **Inline previews** of translated content.
|
|
431
|
+
- **Quick actions** to easily create and update translations.
|
|
432
|
+
|
|
433
|
+
For more details on how to use the extension, refer to the [Intlayer VS Code Extension documentation](https://intlayer.org/doc/vs-code-extension).
|
|
434
|
+
|
|
435
|
+
### Git Configuration
|
|
436
|
+
|
|
437
|
+
It is recommended to ignore files generated by Intlayer. This prevents them from being committed to your Git repository.
|
|
438
|
+
|
|
439
|
+
To do this, you can add the following instructions to your `.gitignore` file:
|
|
440
|
+
|
|
441
|
+
```plaintext fileName=".gitignore"
|
|
442
|
+
# Ignore the files generated by Intlayer
|
|
443
|
+
.intlayer
|
|
444
|
+
|
|
445
|
+
```
|
package/docs/en-GB/readme.md
CHANGED
|
@@ -50,7 +50,7 @@ With **per-locale content files**, **TypeScript autocompletion**, **tree-shakabl
|
|
|
50
50
|
| Feature | Description |
|
|
51
51
|
| --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
52
52
|
| <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/frameworks.png?raw=true" alt="Feature" width="700"> | **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. |
|
|
53
|
-
| <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/javascript_content_management.
|
|
53
|
+
| <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) |
|
|
54
54
|
| <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>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) |
|
|
55
55
|
| <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/autocompletion.png?raw=true" alt="Feature" width="700"> | **Type-Safe Environment**<br><br>Utilise 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) |
|
|
56
56
|
| <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 internationalisation, routing, AI, build, and content handling with ease. <br><br> - [Explore Next.js integration](https://intlayer.org/doc/environment/nextjs) |
|
|
@@ -254,6 +254,8 @@ You can also follow us on:
|
|
|
254
254
|
|
|
255
255
|
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!
|
|
256
256
|
|
|
257
|
+
Contribute on [GitHub](https://github.com/aymericzip/intlayer), [GitLab](https://gitlab.com/ay.pineau/intlayer), or [Bitbucket](https://bitbucket.org/intlayer/intlayer/).
|
|
258
|
+
|
|
257
259
|
### Thank You for the Support
|
|
258
260
|
|
|
259
261
|
If you like Intlayer, give us a ⭐ on GitHub. It helps others discover the project!
|
package/docs/es/cli/push.md
CHANGED
|
@@ -23,7 +23,7 @@ slugs:
|
|
|
23
23
|
npx intlayer dictionary push
|
|
24
24
|
```
|
|
25
25
|
|
|
26
|
-
Si el [editor de intlayer](https://github.com/aymericzip/intlayer/blob/main/docs/docs/es/intlayer_visual_editor.md) está instalado, también puedes empujar diccionarios al editor. Este comando permitirá que los diccionarios estén disponibles para [el editor](https://intlayer.org/
|
|
26
|
+
Si el [editor de intlayer](https://github.com/aymericzip/intlayer/blob/main/docs/docs/es/intlayer_visual_editor.md) está instalado, también puedes empujar diccionarios al editor. Este comando permitirá que los diccionarios estén disponibles para [el editor](https://app.intlayer.org/). De esta manera, puedes compartir tus diccionarios con tu equipo y editar tu contenido sin modificar el código de tu aplicación.
|
|
27
27
|
|
|
28
28
|
## Alias:
|
|
29
29
|
|
package/docs/es/configuration.md
CHANGED
|
@@ -242,14 +242,14 @@ Define configuraciones relacionadas con el editor integrado, incluyendo el puert
|
|
|
242
242
|
- **clientId**:
|
|
243
243
|
- _Tipo_: `string` | `undefined`
|
|
244
244
|
- _Por defecto_: `undefined`
|
|
245
|
-
- _Descripción_: clientId y clientSecret permiten que los paquetes de intlayer se autentiquen con el backend utilizando la autenticación oAuth2. Un token de acceso se usa para autenticar al usuario relacionado con el proyecto. Para obtener un token de acceso, visite https://intlayer.org/
|
|
245
|
+
- _Descripción_: clientId y clientSecret permiten que los paquetes de intlayer se autentiquen con el backend utilizando la autenticación oAuth2. Un token de acceso se usa para autenticar al usuario relacionado con el proyecto. Para obtener un token de acceso, visite https://app.intlayer.org/project y cree una cuenta.
|
|
246
246
|
- _Ejemplo_: `true`
|
|
247
247
|
- _Nota_: Importante: El clientId y clientSecret deben mantenerse en secreto y no compartirse públicamente. Asegúrese de guardarlos en un lugar seguro, como variables de entorno.
|
|
248
248
|
|
|
249
249
|
- **clientSecret**:
|
|
250
250
|
- _Tipo_: `string` | `undefined`
|
|
251
251
|
- _Por defecto_: `undefined`
|
|
252
|
-
- _Descripción_: clientId y clientSecret permiten que los paquetes de intlayer se autentiquen con el backend utilizando la autenticación oAuth2. Se utiliza un token de acceso para autenticar al usuario relacionado con el proyecto. Para obtener un token de acceso, vaya a https://intlayer.org/
|
|
252
|
+
- _Descripción_: clientId y clientSecret permiten que los paquetes de intlayer se autentiquen con el backend utilizando la autenticación oAuth2. Se utiliza un token de acceso para autenticar al usuario relacionado con el proyecto. Para obtener un token de acceso, vaya a https://app.intlayer.org/project y cree una cuenta.
|
|
253
253
|
- _Ejemplo_: `true`
|
|
254
254
|
- _Nota_: Importante: El clientId y clientSecret deben mantenerse en secreto y no compartirse públicamente. Por favor, asegúrese de mantenerlos en un lugar seguro, como variables de entorno.
|
|
255
255
|
|
|
@@ -465,7 +465,7 @@ Configuraciones que controlan el logger, incluyendo el prefijo a usar.
|
|
|
465
465
|
|
|
466
466
|
Configuraciones que controlan las funciones de IA de Intlayer, incluyendo el proveedor, modelo y clave API.
|
|
467
467
|
|
|
468
|
-
Esta configuración es opcional si estás registrado en el [Panel de Control de Intlayer](https://intlayer.org/
|
|
468
|
+
Esta configuración es opcional si estás registrado en el [Panel de Control de Intlayer](https://app.intlayer.org/project) usando una clave de acceso. Intlayer gestionará automáticamente la solución de IA más eficiente y rentable para tus necesidades. Usar las opciones predeterminadas asegura un mejor mantenimiento a largo plazo, ya que Intlayer se actualiza continuamente para usar los modelos más relevantes.
|
|
469
469
|
|
|
470
470
|
Si prefieres usar tu propia clave API o un modelo específico, puedes definir tu configuración personalizada de IA.
|
|
471
471
|
Esta configuración de IA se utilizará globalmente en todo su entorno Intlayer. Los comandos CLI usarán estas configuraciones como valores predeterminados para los comandos (por ejemplo, `fill`), así como el SDK, el Editor Visual y el CMS. Puede anular estos valores predeterminados para casos de uso específicos utilizando parámetros de comando.
|
|
@@ -225,7 +225,7 @@ Este enfoque te permite:
|
|
|
225
225
|
| Funcionalidad | Descripción |
|
|
226
226
|
| -------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
227
227
|
|  | **Compatibilidad entre Frameworks**<br><br>Intlayer es compatible con todos los principales frameworks y bibliotecas, incluyendo Next.js, React, Vite, Vue.js, Nuxt, Preact, Express y más. |
|
|
228
|
-
|  | **Gestión de Contenido Potenciada por JavaScript**<br><br>Aprovecha la flexibilidad de JavaScript para definir y gestionar tu contenido de manera eficiente. <br><br> - [Declaración de contenido](https://intlayer.org/doc/concept/content) |
|
|
229
229
|
|  | **Archivo de Declaración de Contenido por Localidad**<br><br>Acelera tu desarrollo declarando tu contenido una vez, antes de la generación automática.<br><br> - [Archivo de Declaración de Contenido por Localidad](https://intlayer.org/doc/concept/per-locale-file) |
|
|
230
230
|
|  | **Entorno con Tipos Seguros**<br><br>Aprovecha TypeScript para asegurar que tus definiciones de contenido y código estén libres de errores, además de beneficiarte de la autocompletación en el IDE.<br><br> - [Configuración de TypeScript](https://intlayer.org/doc/environment/vite-and-react#configure-typescript) |
|
|
231
231
|
|  | **Configuración Simplificada**<br><br>Pon en marcha rápidamente con una configuración mínima. Ajusta fácilmente los ajustes para internacionalización, enrutamiento, IA, compilación y manejo de contenido.<br><br> - [Explora la integración con Next.js](https://intlayer.org/doc/environment/nextjs) |
|
package/docs/es/intlayer_CMS.md
CHANGED
|
@@ -92,7 +92,7 @@ const config: IntlayerConfig = {
|
|
|
92
92
|
*
|
|
93
93
|
* El ID de cliente y el secreto de cliente son necesarios para habilitar el editor.
|
|
94
94
|
* Permiten identificar al usuario que está editando el contenido.
|
|
95
|
-
* Se pueden obtener creando un nuevo cliente en el Panel de Intlayer - Proyectos (https://intlayer.org/
|
|
95
|
+
* Se pueden obtener creando un nuevo cliente en el Panel de Intlayer - Proyectos (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
|
* El ID de cliente y el secreto de cliente son necesarios para habilitar el editor.
|
|
144
144
|
* Permiten identificar al usuario que está editando el contenido.
|
|
145
|
-
* Se pueden obtener creando un nuevo cliente en el Panel de Intlayer - Proyectos (https://intlayer.org/
|
|
145
|
+
* Se pueden obtener creando un nuevo cliente en el Panel de Intlayer - Proyectos (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
|
* El ID de cliente y el secreto de cliente son necesarios para habilitar el editor.
|
|
194
194
|
* Permiten identificar al usuario que está editando el contenido.
|
|
195
|
-
* Se pueden obtener creando un nuevo cliente en el Panel de Intlayer - Proyectos (https://intlayer.org/
|
|
195
|
+
* Se pueden obtener creando un nuevo cliente en el Panel de Intlayer - Proyectos (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
|
-
> Si no tienes un ID de cliente y un secreto de cliente, puedes obtenerlos creando un nuevo cliente en el [Panel de Intlayer - Proyectos](https://intlayer.org/
|
|
227
|
+
> Si no tienes un ID de cliente y un secreto de cliente, puedes obtenerlos creando un nuevo cliente en el [Panel de Intlayer - Proyectos](https://app.intlayer.org/projects).
|
|
228
228
|
|
|
229
229
|
> Para ver todos los parámetros disponibles, consulta la [documentación de configuración](https://github.com/aymericzip/intlayer/blob/main/docs/docs/es/configuration.md).
|
|
230
230
|
|
|
@@ -264,7 +264,7 @@ Este comando sube tus diccionarios de contenido inicial, haciéndolos disponible
|
|
|
264
264
|
|
|
265
265
|
### Editar el diccionario
|
|
266
266
|
|
|
267
|
-
Luego podrás ver y gestionar tu diccionario en el [Intlayer CMS](https://intlayer.org/
|
|
267
|
+
Luego podrás ver y gestionar tu diccionario en el [Intlayer CMS](https://app.intlayer.org/content).
|
|
268
268
|
|
|
269
269
|
## Sincronización en vivo
|
|
270
270
|
|