@intlayer/core 6.0.2-canary.0 → 6.1.0

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 CHANGED
@@ -1,87 +1,276 @@
1
- <div align="center">
2
- <a href="https://intlayer.org">
3
- <img src="https://raw.githubusercontent.com/aymericzip/intlayer/572ae9c9acafb74307b81530c1931a8e98990aef/docs/assets/logo.png" width="500" alt="intlayer" />
1
+ <p align="center">
2
+ <a href="https://intlayer.org" rel="">
3
+ <img src="https://raw.githubusercontent.com/aymericzip/intlayer/main/docs/assets/cover.png" width="60%" alt="Intlayer Logo" />
4
4
  </a>
5
- </div>
5
+ </p>
6
6
 
7
- <div align="center">
8
- <a href="https://www.npmjs.com/package/intlayer" target="blank"><img
9
- align="center"
10
- alt="npm"
11
- src="https://img.shields.io/npm/v/intlayer.svg?labelColor=49516F&color=8994BC&style=for-the-badge"
12
- height="30" /></a>
13
- <a href="https://npmjs.org/package/intlayer" target="blank"><img
14
- align="center"
15
- src="https://img.shields.io/npm/dm/intlayer?labelColor=49516F&color=8994BC&style=for-the-badge"
16
- alt="monthly downloads"
17
- height="30"
18
- /></a>
19
- <a href="https://npmjs.org/package/intlayer" target="blank"><img
20
- align="center"
21
- src="https://img.shields.io/npm/types/intlayer?label=types%20included&labelColor=49516F&color=8994BC&style=for-the-badge"
22
- alt="types included"
23
- height="30"
24
- /></a>
25
- </div>
7
+ <h1 align="center">
8
+ <strong> Intlayer : an Open-source, per-component i18n toolkit with AI-powered translation & CMS.</strong>
9
+ </h1>
10
+
11
+ <br />
12
+
13
+ <p align="center">
14
+ <a href="https://intlayer.org/doc/concept/content" rel="">Docs</a> •
15
+ <a href="https://intlayer.org/doc/environment/nextjs" rel="">Next.js</a> •
16
+ <a href="https://intlayer.org/doc/environment/vite-and-react" rel="">React + Vite</a> •
17
+ <a href="https://intlayer.org/doc/concept/cms" rel="">CMS</a> •
18
+ <a href="https://discord.gg/7uxamYVeCk" rel="noopener noreferrer nofollow">Discord</a>
19
+ </p>
20
+ <p align="center" style="margin-top:15px;">
21
+ <a href="https://www.npmjs.com/package/intlayer" target="_blank" rel="noopener noreferrer nofollow"><img src="https://img.shields.io/npm/v/intlayer?style=for-the-badge&labelColor=FFFFFF&color=000000&logoColor=FFFFFF" alt="npm version" height="24"/></a>
22
+ <a href="https://github.com/aymericzip/intlayer/stargazers" target="_blank" rel="noopener noreferrer nofollow"><img src="https://img.shields.io/github/stars/aymericzip/intlayer?style=for-the-badge&labelColor=000000&color=FFFFFF&logo=github&logoColor=FFD700" alt="GitHub Stars" height="24"/></a>
23
+ <a href="https://www.npmjs.org/package/intlayer" target="_blank" rel="noopener noreferrer nofollow"><img src="https://img.shields.io/npm/dm/intlayer?style=for-the-badge&labelColor=000000&color=FFFFFF&logoColor=000000" alt="monthly downloads" height="24"/></a>
24
+ <a href="https://github.com/aymericzip/intlayer/blob/main/LICENSE" target="_blank" rel="noopener noreferrer nofollow"><img src="https://img.shields.io/github/license/aymericzip/intlayer?style=for-the-badge&labelColor=000000&color=FFFFFF&logoColor=000000" alt="license"/></a>
25
+ <a href="https://github.com/aymericzip/intlayer/commits/main" target="_blank" rel="noopener noreferrer nofollow"><img src="https://img.shields.io/github/last-commit/aymericzip/intlayer?style=for-the-badge&labelColor=000000&color=FFFFFF&logoColor=000000" alt="last commit"/>
26
+ </a>
27
+ </p>
28
+
29
+ ![Watch the video](https://github.com/aymericzip/intlayer/blob/main/docs/assets/demo_video.gif)
30
+
31
+ <a href="https://intlayer.org/doc/concept/content" rel="">
32
+ <img src="https://img.shields.io/badge/Get_Started-FFFFFF?style=for-the-badge&logo=rocket&logoColor=black" />
33
+ </a>
34
+
35
+ ## What is Intlayer?
36
+
37
+ Most i18n libraries are either too complex, too rigid, or not built for modern frameworks.
38
+
39
+ Intlayer is a **modern i18n solution** for web and mobile apps.
40
+ It’s framework-agnostic, **AI-powered**, and includes a free **CMS & visual editor**.
41
+
42
+ With **per-locale content files**, **TypeScript autocompletion**, **tree-shakable dictionaries**, and **CI/CD integration**, Intlayer makes internationalization **faster, cleaner, and smarter**.
43
+
44
+ ## Keys benefits of Intlayer:
45
+
46
+ | Feature | Description |
47
+ | --------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
48
+ | <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. |
49
+ | <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/javascript_content_management.png?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) |
50
+ | <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) |
51
+ | <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) |
52
+ | <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) |
53
+ | <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/content_retrieval.png?raw=true" alt="Feature" width="700"> | **Simplified Content Retrieval**<br><br>No need to call your `t` function for each piece of content. Retrieve all your content directly using a single hook.<br><br> - [React integration](https://intlayer.org/doc/environment/create-react-app) |
54
+ | <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/server_component.png?raw=true" alt="Feature" width="700"> | **Consistent Server Component Implementation**<br><br>Perfectly suited for Next.js server components, use the same implementation for both client and server components, no need to pass your `t` function across each server component. <br><br> - [Server Components](https://intlayer.org/doc/environment/nextjs#step-7-utilize-content-in-your-code) |
55
+ | <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/file_tree.png?raw=true" alt="Feature" width="700"> | **Organized Codebase**<br><br>Keep your codebase more organized: 1 component = 1 dictionary in the same folder. Translations close to their respective components, enhance maintainability and clarity. <br><br> - [How Intlayer works](https://intlayer.org/doc/concept/how-works-intlayer) |
56
+ | <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/url_routing.png?raw=true" alt="Feature" width="700"> | **Enhanced Routing**<br><br>Full support of app routing, adapting seamlessly to complex application structures, for Next.js, React, Vite, Vue.js, etc.<br><br> - [Explore Next.js integration](https://intlayer.org/doc/environment/nextjs) |
57
+ | <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/markdown.png?raw=true" alt="Feature" width="700"> | **Markdown Support**<br><br>Import and interpret, locale files and remote Markdown for multilingual content like privacy policies, documentation, etc. Interpret and make Markdown metadata accessible in your code.<br><br> - [Content files](https://intlayer.org/doc/concept/content/file) |
58
+ | <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/visual_editor.png?raw=true" alt="Feature" width="700"> | **Free Visual Editor & CMS**<br><br>A free visual editor and CMS are available for content writers, removing the need for a localization platform. Keep your content synchronized using Git, or externalize it totally or partially with the CMS.<br><br> - [Intlayer Editor](https://intlayer.org/doc/concept/editor) <br> - [Intlayer CMS](https://intlayer.org/doc/concept/cms) |
59
+ | <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/bundle.png?raw=true" alt="Feature" width="700"> | **Tree-shakable Content**<br><br>Tree-shakable content, reducing the size of the final bundle. Loads content per component, excluding any unused content from your bundle. Supports lazy loading to enhance app loading efficiency. <br><br> - [App build optimization](https://intlayer.org/doc/concept/how-works-intlayer#app-build-optimization) |
60
+ | <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/static_rendering.png?raw=true" alt="Feature" width="700"> | **Static Rendering**<br><br>Doesn't block Static Rendering. <br><br> - [Next.js integration](https://intlayer.org/doc/environment/nextjs) |
61
+ | <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/AI_translation.png?raw=true" alt="Feature" width="700"> | **AI-Powered Translation**<br><br>Transform your website into 231 languages with just one click using Intlayer's advanced AI-powered translation tools using your own AI provider / API key. <br><br> - [CI/CD integration](https://intlayer.org/doc/concept/ci-cd) <br> - [Intlayer CLI](https://intlayer.org/doc/concept/cli) <br> - [Auto fill](https://intlayer.org/doc/concept/auto-fill) |
62
+ | <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/mcp.png?raw=true" alt="Feature" width="700"> | **MCP Server Integration**<br><br>Provides an MCP (Model Context Protocol) server for IDE automation, enabling seamless content management and i18n workflows directly within your development environment. <br><br> - [MCP Server](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/mcp_server.md) |
63
+ | <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/vscode_extension.png?raw=true" alt="Feature" width="700"> | **VSCode Extension**<br><br>Intlayer provides a VSCode extension to help you manage your content and translations, builting your dictionaries, translating your content, and more. <br><br> - [VSCode Extension](https://intlayer.org/doc/vs-code-extension) |
64
+ | <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/interoperability.png?raw=true" alt="Feature" width="700"> | **Interoperability**<br><br>Allow interoperability with react-i18next, next-i18next, next-intl, and react-intl. <br><br> - [Intlayer and react-intl](https://intlayer.org/blog/intlayer-with-react-intl) <br> - [Intlayer and next-intl](https://intlayer.org/blog/intlayer-with-next-intl) <br> - [Intlayer and next-i18next](https://intlayer.org/blog/intlayer-with-next-i18next) |
65
+
66
+ ---
67
+
68
+ ## 📦 Installation
69
+
70
+ Start your journey with Intlayer today and experience a smoother, more powerful approach to internationalization.
71
+
72
+ <a href="https://intlayer.org/doc/concept/content" rel="">
73
+ <img src="https://img.shields.io/badge/Get_Started-FFFFFF?style=for-the-badge&logo=rocket&logoColor=black" />
74
+ </a>
75
+
76
+ ```bash
77
+ npm install intlayer react-intlayer
78
+ ```
79
+
80
+ ⚡ Quick Start (Next.js)
81
+
82
+ ```ts
83
+ // intlayer.config.ts
84
+ import { Locales, type IntlayerConfig } from "intlayer";
85
+
86
+ const config: IntlayerConfig = {
87
+ internationalization: {
88
+ locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
89
+ defaultLocale: Locales.ENGLISH,
90
+ },
91
+ };
92
+
93
+ export default config;
94
+ ```
95
+
96
+ ```ts
97
+ // app/home.content.ts
98
+ import { t, type Dictionary } from "intlayer";
99
+
100
+ const content = {
101
+ key: "home",
102
+ content: {
103
+ title: t({
104
+ en: "Home",
105
+ fr: "Accueil",
106
+ es: "Inicio",
107
+ }),
108
+ },
109
+ } satisfies Dictionary;
110
+
111
+ export default content;
112
+ ```
113
+
114
+ ```tsx
115
+ // app/page.tsx
116
+ import { useIntlayer } from "react-intlayer";
26
117
 
27
- <div>
118
+ const HomePage = () => {
119
+ const { title } = useIntlayer("home");
120
+
121
+ return <h1>{title}</h1>;
122
+ };
123
+ ```
124
+
125
+ <a href="https://intlayer.org/doc/environment/nextjs"> Get the full guide → </a>
126
+
127
+ ## 🎥 Live tutorial on YouTube
128
+
129
+ [![How to Internationalize your application using Intlayer](https://i.ytimg.com/vi/e_PPG7PTqGU/hqdefault.jpg?sqp=-oaymwEcCNACELwBSFXyq4qpAw4IARUAAIhCGAFwAcABBg==&rs=AOn4CLDtyJ4uYotEjl12nZ_gZKZ_kjEgOQ)](https://youtu.be/e_PPG7PTqGU?si=GyU_KpVhr61razRw)
130
+
131
+ <a href="https://intlayer.org/doc/concept/content" rel="">
132
+ <img src="https://img.shields.io/badge/Get_Started-FFFFFF?style=for-the-badge&logo=rocket&logoColor=black" />
133
+ </a>
134
+
135
+ ## Table of Contents
136
+
137
+ Explore our comprehensive documentation to get started with Intlayer and learn how to integrate it into your projects.
138
+
139
+ <details open>
140
+ <summary style="font-size:16px; font-weight:bold;">📘 Get Started</summary>
141
+ <ul>
142
+ <li><a href="https://intlayer.org/doc/why" rel=''>Why Intlayer?</a></li>
143
+ <li><a href="https://intlayer.org/doc" rel=''>Introduction</a></li>
144
+ </ul>
145
+ </details>
146
+
147
+ <details>
148
+ <summary style="font-size:16px; font-weight:bold;">⚙️ Concept</summary>
149
+ <ul>
150
+ <li><a href="https://intlayer.org/doc/concept/how-works-intlayer" rel=''>How Intlayer Works</a></li>
151
+ <li><a href="https://intlayer.org/doc/concept/configuration" rel=''>Configuration</a></li>
152
+ <li><a href="https://intlayer.org/doc/concept/cli" rel=''>Intlayer CLI</a></li>
153
+ <li><a href="https://intlayer.org/doc/concept/editor" rel=''>Intlayer Editor</a></li>
154
+ <li><a href="https://intlayer.org/doc/concept/cms" rel=''>Intlayer CMS</a></li>
155
+ <li><a href="https://intlayer.org/doc/concept/content" rel=''>Dictionary</a>
156
+ <ul>
157
+ <li><a href="https://intlayer.org/doc/concept/content/per-locale-file" rel=''>Per-Locale Content Declaration File</a></li>
158
+ <li><a href="https://intlayer.org/doc/concept/content/translation" rel=''>Translation</a></li>
159
+ <li><a href="https://intlayer.org/doc/concept/content/enumeration" rel=''>Enumeration</a></li>
160
+ <li><a href="https://intlayer.org/doc/concept/content/condition" rel=''>Condition</a></li>
161
+ <li><a href="https://intlayer.org/doc/concept/content/nesting" rel=''>Nesting</a></li>
162
+ <li><a href="https://intlayer.org/doc/concept/content/markdown" rel=''>Markdown</a></li>
163
+ <li><a href="https://intlayer.org/doc/concept/content/function-fetching" rel=''>Function Fetching</a></li>
164
+ <li><a href="https://intlayer.org/doc/concept/content/insertion" rel=''>Insertion</a></li>
165
+ <li><a href="https://intlayer.org/doc/concept/content/file" rel=''>File</a></li>
166
+ </ul>
167
+ </li>
168
+ </ul>
169
+ </details>
170
+
171
+ <details open>
172
+ <summary style="font-size:16px; font-weight:bold;">🌐 Environment</summary>
173
+ <ul>
174
+ <li><a href="https://intlayer.org/doc/environment/nextjs" rel=''>Intlayer with Next.js 15</a>
175
+ <ul>
176
+ <li><a href="https://intlayer.org/doc/environment/nextjs/14" rel=''>Next.js 14 (App Router)</a></li>
177
+ <li><a href="https://intlayer.org/doc/environment/nextjs/next-with-Page-Router" rel=''>Next.js Page Router</a></li>
178
+ </ul>
179
+ </li>
180
+ <li><a href="https://intlayer.org/doc/environment/create-react-app" rel=''>React CRA</a></li>
181
+ <li><a href="https://intlayer.org/doc/environment/vite-and-react" rel=''>Vite + React</a>
182
+ <ul>
183
+ <li><a href="https://intlayer.org/doc/environment/vite-and-react/react-router-v7" rel=''>React-router-v7</a></li>
184
+ <li><a href="https://intlayer.org/doc/environment/vite-and-react/tanstack-start" rel=''>Tanstack start</a></li>
185
+ </ul>
186
+ </li>
187
+ <li><a href="https://intlayer.org/doc/environment/react-native-and-expo" rel=''>React Native</a></li>
188
+ <li><a href="https://intlayer.org/doc/environment/lynx-and-react" rel=''>Lynx + React</a></li>
189
+ <li><a href="https://intlayer.org/doc/environment/vite-and-svelte" rel=''>Vite + Svelte</a></li>
190
+ <li><a href="https://intlayer.org/doc/environment/vite-and-preact" rel=''>Vite + Preact</a></li>
191
+ <li><a href="https://intlayer.org/doc/environment/vite-and-vue" rel=''>Vite + Vue</a></li>
192
+ <li><a href="https://intlayer.org/doc/environment/vite-and-nuxt" rel=''>Vite + Nuxt</a></li>
193
+ <li><a href="https://intlayer.org/doc/environment/vite-and-solid" rel=''>Vite + Solid</a></li>
194
+ <li><a href="https://intlayer.org/doc/environment/angular" rel=''>Angular</a></li>
195
+ <li><a href="https://intlayer.org/doc/environment/express" rel=''>Express</a></li>
196
+ <li><a href="https://intlayer.org/doc/environment/nest" rel=''>NestJS</a></li>
197
+ </ul>
198
+ </details>
199
+
200
+ <details>
201
+ <summary style="font-size:16px; font-weight:bold;">📰 Blog</summary>
202
+ <ul>
203
+ <li><a href="https://github.com/aymericzip/intlayer/blob/main/docs/blog/en/what_is_internationalization.md" rel=''>What is i18n</a></li>
204
+ <li><a href="https://intlayer.org/blog/SEO-and-i18n" rel=''>i18n and SEO</a></li>
205
+ <li><a href="https://intlayer.org/blog/intlayer-with-next-i18next" rel=''>Intlayer and i18next</a></li>
206
+ <li><a href="https://intlayer.org/blog/intlayer-with-react-i18next" rel=''>Intlayer and react-intl</a></li>
207
+ <li><a href="https://intlayer.org/blog/intlayer-with-next-intl" rel=''>Intlayer and next-intl</a></li>
208
+ </ul>
209
+ </details>
210
+
211
+ ## 🌐 Readme in other languages
212
+
213
+ <p align="center">
214
+ <a href="https://github.com/aymericzip/intlayer/blob/main/readme.md">English</a> •
215
+ <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/readme.md">简体中文</a> •
216
+ <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/ru/readme.md">Русский</a> •
217
+ <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/ja/readme.md">日本語</a> •
218
+ <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/fr/readme.md">Français</a> •
219
+ <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/ko/readme.md">한국어</a> •
220
+ <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/es/readme.md">Español</a> •
221
+ <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/de/readme.md">Deutsch</a> •
222
+ <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/ar/readme.md">العربية</a> •
223
+ <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/it/readme.md">Italiano</a> •
224
+ <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/readme.md">English (UK)</a> •
225
+ <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/pt/readme.md">Português</a> •
226
+ <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/hi/readme.md">हिन्दी</a> •
227
+ <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/tr/readme.md">Türkçe</a>
228
+ </p>
229
+
230
+ ## 🤝 Community
231
+
232
+ Intlayer is built with and for the community and we’d love your input!
233
+
234
+ - Have a suggestion? [Open an issue](https://github.com/aymericzip/intlayer/issues)
235
+ - Found a bug or improvement? [Submit a PR](https://github.com/aymericzip/intlayer/pulls)
236
+ - Need help or want to connect? [Join our Discord](https://discord.gg/7uxamYVeCk)
237
+
238
+ You can also follow us on :
239
+
240
+ <div>
28
241
  <br/>
29
242
  <p align="center">
30
- <a href="https://discord.gg/528mBV4N" target="blank"><img align="center"
243
+ <a href="https://discord.gg/528mBV4N" target="blank" rel='noopener noreferrer nofollow'><img align="center"
31
244
  src="https://img.shields.io/badge/discord-5865F2.svg?style=for-the-badge&logo=discord&logoColor=white"
32
245
  alt="Intlayer Discord" height="30"/></a>
33
- <a href="https://www.linkedin.com/company/intlayerorg" target="blank"><img align="center"
246
+ <a href="https://www.linkedin.com/company/intlayerorg" target="blank" rel='noopener noreferrer nofollow'><img align="center"
34
247
  src="https://img.shields.io/badge/linkedin-%231DA1F2.svg?style=for-the-badge&logo=linkedin&logoColor=white"
35
248
  alt="Intlayer LinkedIn" height="30"/></a>
36
- <a href="https://www.facebook.com/intlayer" target="blank"><img align="center"
249
+ <a href="https://www.facebook.com/intlayer" target="blank" rel='noopener noreferrer nofollow'><img align="center"
37
250
  src="https://img.shields.io/badge/facebook-4267B2.svg?style=for-the-badge&logo=facebook&logoColor=white"
38
251
  alt="Intlayer Facebook" height="30"/></a>
39
- <a href="https://www.instagram.com/intlayer/" target="blank"><img align="center"
252
+ <a href="https://www.instagram.com/intlayer/" target="blank" rel='noopener noreferrer nofollow'><img align="center"
40
253
  src="https://img.shields.io/badge/instagram-%23E4405F.svg?style=for-the-badge&logo=Instagram&logoColor=white"
41
254
  alt="Intlayer Instagram" height="30"/></a>
42
- <a href="https://x.com/Intlayer183096" target="blank"><img align="center"
255
+ <a href="https://x.com/Intlayer183096" target="blank" rel='noopener noreferrer nofollow'><img align="center"
43
256
  src="https://img.shields.io/badge/x-1DA1F2.svg?style=for-the-badge&logo=x&logoColor=white"
44
257
  alt="Intlayer X" height="30"/></a>
45
- <a href="https://www.youtube.com/@intlayer" target="blank"><img align="center"
258
+ <a href="https://www.youtube.com/@intlayer" target="blank" rel='noopener noreferrer nofollow'><img align="center"
46
259
  src="https://img.shields.io/badge/youtube-FF0000.svg?style=for-the-badge&logo=youtube&logoColor=white"
47
260
  alt="Intlayer YouTube" height="30"/></a>
48
- <a href="https://www.tiktok.com/@intlayer" target="blank"><img align="center"
261
+ <a href="https://www.tiktok.com/@intlayer" target="blank" rel='noopener noreferrer nofollow'><img align="center"
49
262
  src="https://img.shields.io/badge/tiktok-000000.svg?style=for-the-badge&logo=tiktok&logoColor=white"
50
263
  alt="Intlayer TikTok" height="30"/></a>
51
264
  <br>
52
265
  </p>
53
266
  </div>
54
267
 
55
- # @intlayer/core: Containing Intlayer core functions
56
-
57
- **Intlayer** is a suite of packages designed specifically for JavaScript developers. It is compatible with frameworks like React, React, and Express.js.
58
-
59
- The **`@intlayer/core`** package is a NPM package including core functions of Intlayer shared by multiple packages. It notably includes:
60
-
61
- - Translation functions
62
- - Dictionary functions
63
- - Utility functions
268
+ ### Contribution
64
269
 
65
- ## Installation
66
-
67
- Install the necessary package using your preferred package manager:
68
-
69
- ```bash packageManager="npm"
70
- npm install @intlayer/core
71
- ```
72
-
73
- ```bash packageManager="pnpm"
74
- pnpm add @intlayer/core
75
- ```
76
-
77
- ```bash packageManager="yarn"
78
- yarn add @intlayer/core
79
- ```
270
+ 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!
80
271
 
81
- ## Read about Intlayer
272
+ ### Thank You for the Support
82
273
 
83
- - [Intlayer Website](https://intlayer.org)
84
- - [Intlayer Documentation](https://intlayer.org/doc)
85
- - [Intlayer GitHub](https://github.com/aymericzip/intlayer)
274
+ If you like Intlayer, give us a ⭐ on GitHub. It helps others discover the project! [See why GitHub Stars matter](https://github.com/aymericzip/intlayer/blob/main/CONTRIBUTING.md#why-github-stars-matter-).
86
275
 
87
- - [Ask your questions to our smart documentation](https://intlayer.org/docchat)
276
+ [![Star History Chart](https://api.star-history.com/svg?repos=aymericzip/intlayer&type=Date)](https://star-history.com/#aymericzip/intlayer&Date)
@@ -0,0 +1,49 @@
1
+ "use strict";
2
+ var __defProp = Object.defineProperty;
3
+ var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
4
+ var __getOwnPropNames = Object.getOwnPropertyNames;
5
+ var __hasOwnProp = Object.prototype.hasOwnProperty;
6
+ var __export = (target, all) => {
7
+ for (var name in all)
8
+ __defProp(target, name, { get: all[name], enumerable: true });
9
+ };
10
+ var __copyProps = (to, from, except, desc) => {
11
+ if (from && typeof from === "object" || typeof from === "function") {
12
+ for (let key of __getOwnPropNames(from))
13
+ if (!__hasOwnProp.call(to, key) && key !== except)
14
+ __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
15
+ }
16
+ return to;
17
+ };
18
+ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
19
+ var getMaskContent_exports = {};
20
+ __export(getMaskContent_exports, {
21
+ buildMaskPlugin: () => buildMaskPlugin,
22
+ getMaskContent: () => getMaskContent
23
+ });
24
+ module.exports = __toCommonJS(getMaskContent_exports);
25
+ var import_interpreter = require('../interpreter/index.cjs');
26
+ const passTypedNodePlugin = {
27
+ id: "pass-typed-node-plugin",
28
+ canHandle: (node) => typeof node === "object" && typeof node?.nodeType === "string",
29
+ transform: (node, props, deepTransformNode2) => deepTransformNode2(node[node.nodeType], props)
30
+ };
31
+ const buildMaskPlugin = {
32
+ id: "build-mask-plugin",
33
+ canHandle: (node) => typeof node === "string" || typeof node === "number",
34
+ transform: () => true
35
+ };
36
+ const getMaskContent = (source) => ({
37
+ ...source,
38
+ content: (0, import_interpreter.deepTransformNode)(source.content, {
39
+ dictionaryKey: source.key,
40
+ keyPath: [],
41
+ plugins: [passTypedNodePlugin, buildMaskPlugin]
42
+ })
43
+ });
44
+ // Annotate the CommonJS export names for ESM import in node:
45
+ 0 && (module.exports = {
46
+ buildMaskPlugin,
47
+ getMaskContent
48
+ });
49
+ //# sourceMappingURL=getMaskContent.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../../../src/deepTranformPlugins/getMaskContent.ts"],"sourcesContent":["import { deepTransformNode, type Plugins } from '../interpreter';\nimport { type Dictionary } from '../types';\n\nconst passTypedNodePlugin: Plugins = {\n id: 'pass-typed-node-plugin',\n canHandle: (node) =>\n typeof node === 'object' && typeof node?.nodeType === 'string',\n transform: (node, props, deepTransformNode) =>\n deepTransformNode(node[node.nodeType], props),\n};\n\n/** Translation plugin. Replaces node with a locale string if nodeType = Translation. */\nexport const buildMaskPlugin: Plugins = {\n id: 'build-mask-plugin',\n canHandle: (node) => typeof node === 'string' || typeof node === 'number',\n transform: () => true,\n};\n\nexport const getMaskContent = (source: Dictionary): any => ({\n ...source,\n content: deepTransformNode(source.content, {\n dictionaryKey: source.key,\n keyPath: [],\n plugins: [passTypedNodePlugin, buildMaskPlugin],\n }),\n});\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,yBAAgD;AAGhD,MAAM,sBAA+B;AAAA,EACnC,IAAI;AAAA,EACJ,WAAW,CAAC,SACV,OAAO,SAAS,YAAY,OAAO,MAAM,aAAa;AAAA,EACxD,WAAW,CAAC,MAAM,OAAOA,uBACvBA,mBAAkB,KAAK,KAAK,QAAQ,GAAG,KAAK;AAChD;AAGO,MAAM,kBAA2B;AAAA,EACtC,IAAI;AAAA,EACJ,WAAW,CAAC,SAAS,OAAO,SAAS,YAAY,OAAO,SAAS;AAAA,EACjE,WAAW,MAAM;AACnB;AAEO,MAAM,iBAAiB,CAAC,YAA6B;AAAA,EAC1D,GAAG;AAAA,EACH,aAAS,sCAAkB,OAAO,SAAS;AAAA,IACzC,eAAe,OAAO;AAAA,IACtB,SAAS,CAAC;AAAA,IACV,SAAS,CAAC,qBAAqB,eAAe;AAAA,EAChD,CAAC;AACH;","names":["deepTransformNode"]}
@@ -18,6 +18,7 @@ module.exports = __toCommonJS(deepTranformPlugins_exports);
18
18
  __reExport(deepTranformPlugins_exports, require('./getFilteredLocalesContent.cjs'), module.exports);
19
19
  __reExport(deepTranformPlugins_exports, require('./getFilterTranslationsOnlyContent.cjs'), module.exports);
20
20
  __reExport(deepTranformPlugins_exports, require('./getLocalisedContent.cjs'), module.exports);
21
+ __reExport(deepTranformPlugins_exports, require('./getMaskContent.cjs'), module.exports);
21
22
  __reExport(deepTranformPlugins_exports, require('./getMissingLocalesContent.cjs'), module.exports);
22
23
  __reExport(deepTranformPlugins_exports, require('./getReplacedValuesContent.cjs'), module.exports);
23
24
  // Annotate the CommonJS export names for ESM import in node:
@@ -25,6 +26,7 @@ __reExport(deepTranformPlugins_exports, require('./getReplacedValuesContent.cjs'
25
26
  ...require('./getFilteredLocalesContent.cjs'),
26
27
  ...require('./getFilterTranslationsOnlyContent.cjs'),
27
28
  ...require('./getLocalisedContent.cjs'),
29
+ ...require('./getMaskContent.cjs'),
28
30
  ...require('./getMissingLocalesContent.cjs'),
29
31
  ...require('./getReplacedValuesContent.cjs')
30
32
  });
@@ -1 +1 @@
1
- {"version":3,"sources":["../../../src/deepTranformPlugins/index.ts"],"sourcesContent":["export * from './getFilteredLocalesContent';\nexport * from './getFilterTranslationsOnlyContent';\nexport * from './getLocalisedContent';\nexport * from './getMissingLocalesContent';\nexport * from './getReplacedValuesContent';\n"],"mappings":";;;;;;;;;;;;;;;AAAA;AAAA;AAAA,wCAAc,wCAAd;AACA,wCAAc,+CADd;AAEA,wCAAc,kCAFd;AAGA,wCAAc,uCAHd;AAIA,wCAAc,uCAJd;","names":[]}
1
+ {"version":3,"sources":["../../../src/deepTranformPlugins/index.ts"],"sourcesContent":["export * from './getFilteredLocalesContent';\nexport * from './getFilterTranslationsOnlyContent';\nexport * from './getLocalisedContent';\nexport * from './getMaskContent';\nexport * from './getMissingLocalesContent';\nexport * from './getReplacedValuesContent';\n"],"mappings":";;;;;;;;;;;;;;;AAAA;AAAA;AAAA,wCAAc,wCAAd;AACA,wCAAc,+CADd;AAEA,wCAAc,kCAFd;AAGA,wCAAc,6BAHd;AAIA,wCAAc,uCAJd;AAKA,wCAAc,uCALd;","names":[]}
@@ -0,0 +1,24 @@
1
+ import { deepTransformNode } from "../interpreter/index.mjs";
2
+ const passTypedNodePlugin = {
3
+ id: "pass-typed-node-plugin",
4
+ canHandle: (node) => typeof node === "object" && typeof node?.nodeType === "string",
5
+ transform: (node, props, deepTransformNode2) => deepTransformNode2(node[node.nodeType], props)
6
+ };
7
+ const buildMaskPlugin = {
8
+ id: "build-mask-plugin",
9
+ canHandle: (node) => typeof node === "string" || typeof node === "number",
10
+ transform: () => true
11
+ };
12
+ const getMaskContent = (source) => ({
13
+ ...source,
14
+ content: deepTransformNode(source.content, {
15
+ dictionaryKey: source.key,
16
+ keyPath: [],
17
+ plugins: [passTypedNodePlugin, buildMaskPlugin]
18
+ })
19
+ });
20
+ export {
21
+ buildMaskPlugin,
22
+ getMaskContent
23
+ };
24
+ //# sourceMappingURL=getMaskContent.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../../../src/deepTranformPlugins/getMaskContent.ts"],"sourcesContent":["import { deepTransformNode, type Plugins } from '../interpreter';\nimport { type Dictionary } from '../types';\n\nconst passTypedNodePlugin: Plugins = {\n id: 'pass-typed-node-plugin',\n canHandle: (node) =>\n typeof node === 'object' && typeof node?.nodeType === 'string',\n transform: (node, props, deepTransformNode) =>\n deepTransformNode(node[node.nodeType], props),\n};\n\n/** Translation plugin. Replaces node with a locale string if nodeType = Translation. */\nexport const buildMaskPlugin: Plugins = {\n id: 'build-mask-plugin',\n canHandle: (node) => typeof node === 'string' || typeof node === 'number',\n transform: () => true,\n};\n\nexport const getMaskContent = (source: Dictionary): any => ({\n ...source,\n content: deepTransformNode(source.content, {\n dictionaryKey: source.key,\n keyPath: [],\n plugins: [passTypedNodePlugin, buildMaskPlugin],\n }),\n});\n"],"mappings":"AAAA,SAAS,yBAAuC;AAGhD,MAAM,sBAA+B;AAAA,EACnC,IAAI;AAAA,EACJ,WAAW,CAAC,SACV,OAAO,SAAS,YAAY,OAAO,MAAM,aAAa;AAAA,EACxD,WAAW,CAAC,MAAM,OAAOA,uBACvBA,mBAAkB,KAAK,KAAK,QAAQ,GAAG,KAAK;AAChD;AAGO,MAAM,kBAA2B;AAAA,EACtC,IAAI;AAAA,EACJ,WAAW,CAAC,SAAS,OAAO,SAAS,YAAY,OAAO,SAAS;AAAA,EACjE,WAAW,MAAM;AACnB;AAEO,MAAM,iBAAiB,CAAC,YAA6B;AAAA,EAC1D,GAAG;AAAA,EACH,SAAS,kBAAkB,OAAO,SAAS;AAAA,IACzC,eAAe,OAAO;AAAA,IACtB,SAAS,CAAC;AAAA,IACV,SAAS,CAAC,qBAAqB,eAAe;AAAA,EAChD,CAAC;AACH;","names":["deepTransformNode"]}
@@ -1,6 +1,7 @@
1
1
  export * from "./getFilteredLocalesContent.mjs";
2
2
  export * from "./getFilterTranslationsOnlyContent.mjs";
3
3
  export * from "./getLocalisedContent.mjs";
4
+ export * from "./getMaskContent.mjs";
4
5
  export * from "./getMissingLocalesContent.mjs";
5
6
  export * from "./getReplacedValuesContent.mjs";
6
7
  //# sourceMappingURL=index.mjs.map
@@ -1 +1 @@
1
- {"version":3,"sources":["../../../src/deepTranformPlugins/index.ts"],"sourcesContent":["export * from './getFilteredLocalesContent';\nexport * from './getFilterTranslationsOnlyContent';\nexport * from './getLocalisedContent';\nexport * from './getMissingLocalesContent';\nexport * from './getReplacedValuesContent';\n"],"mappings":"AAAA,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;","names":[]}
1
+ {"version":3,"sources":["../../../src/deepTranformPlugins/index.ts"],"sourcesContent":["export * from './getFilteredLocalesContent';\nexport * from './getFilterTranslationsOnlyContent';\nexport * from './getLocalisedContent';\nexport * from './getMaskContent';\nexport * from './getMissingLocalesContent';\nexport * from './getReplacedValuesContent';\n"],"mappings":"AAAA,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;","names":[]}
@@ -0,0 +1,6 @@
1
+ import { type Plugins } from '../interpreter';
2
+ import { type Dictionary } from '../types';
3
+ /** Translation plugin. Replaces node with a locale string if nodeType = Translation. */
4
+ export declare const buildMaskPlugin: Plugins;
5
+ export declare const getMaskContent: (source: Dictionary) => any;
6
+ //# sourceMappingURL=getMaskContent.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"getMaskContent.d.ts","sourceRoot":"","sources":["../../../src/deepTranformPlugins/getMaskContent.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqB,KAAK,OAAO,EAAE,MAAM,gBAAgB,CAAC;AACjE,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,UAAU,CAAC;AAU3C,wFAAwF;AACxF,eAAO,MAAM,eAAe,EAAE,OAI7B,CAAC;AAEF,eAAO,MAAM,cAAc,GAAI,QAAQ,UAAU,KAAG,GAOlD,CAAC"}
@@ -1,6 +1,7 @@
1
1
  export * from './getFilteredLocalesContent';
2
2
  export * from './getFilterTranslationsOnlyContent';
3
3
  export * from './getLocalisedContent';
4
+ export * from './getMaskContent';
4
5
  export * from './getMissingLocalesContent';
5
6
  export * from './getReplacedValuesContent';
6
7
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/deepTranformPlugins/index.ts"],"names":[],"mappings":"AAAA,cAAc,6BAA6B,CAAC;AAC5C,cAAc,oCAAoC,CAAC;AACnD,cAAc,uBAAuB,CAAC;AACtC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,4BAA4B,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/deepTranformPlugins/index.ts"],"names":[],"mappings":"AAAA,cAAc,6BAA6B,CAAC;AAC5C,cAAc,oCAAoC,CAAC;AACnD,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC;AACjC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,4BAA4B,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@intlayer/core",
3
- "version": "6.0.2-canary.0",
3
+ "version": "6.1.0",
4
4
  "private": false,
5
5
  "description": "Includes core Intlayer functions like translation, dictionary, and utility functions shared across multiple packages.",
6
6
  "keywords": [
@@ -120,17 +120,17 @@
120
120
  ],
121
121
  "dependencies": {
122
122
  "negotiator": "^1.0.0",
123
- "@intlayer/config": "6.0.2-canary.0",
124
- "@intlayer/api": "6.0.2-canary.0",
125
- "@intlayer/dictionaries-entry": "6.0.2-canary.0",
126
- "@intlayer/unmerged-dictionaries-entry": "6.0.2-canary.0"
123
+ "@intlayer/api": "6.1.0",
124
+ "@intlayer/dictionaries-entry": "6.1.0",
125
+ "@intlayer/unmerged-dictionaries-entry": "6.1.0",
126
+ "@intlayer/config": "6.1.0"
127
127
  },
128
128
  "devDependencies": {
129
129
  "@types/negotiator": "^0.6.3",
130
- "@types/node": "^24.2.1",
131
- "@typescript-eslint/parser": "^8.33.1",
132
- "concurrently": "^9.1.2",
133
- "eslint": "^9.34.0",
130
+ "@types/node": "^24.5.2",
131
+ "@typescript-eslint/parser": "^8.44.1",
132
+ "concurrently": "^9.2.1",
133
+ "eslint": "^9.36.0",
134
134
  "prettier": "^3.6.2",
135
135
  "rimraf": "^6.0.1",
136
136
  "tsc-alias": "^1.8.16",
@@ -138,16 +138,16 @@
138
138
  "typescript": "^5.9.2",
139
139
  "vitest": "^3.2.4",
140
140
  "@utils/eslint-config": "1.0.4",
141
- "@utils/ts-config-types": "1.0.4",
141
+ "@utils/ts-config": "1.0.4",
142
142
  "@utils/tsup-config": "1.0.4",
143
- "@utils/ts-config": "1.0.4"
143
+ "@utils/ts-config-types": "1.0.4"
144
144
  },
145
145
  "peerDependencies": {
146
- "@intlayer/dictionaries-entry": "6.0.2-canary.0",
147
- "intlayer": "6.0.2-canary.0",
148
- "@intlayer/unmerged-dictionaries-entry": "6.0.2-canary.0",
149
- "@intlayer/api": "6.0.2-canary.0",
150
- "@intlayer/config": "6.0.2-canary.0"
146
+ "@intlayer/config": "6.1.0",
147
+ "@intlayer/api": "6.1.0",
148
+ "@intlayer/dictionaries-entry": "6.1.0",
149
+ "@intlayer/unmerged-dictionaries-entry": "6.1.0",
150
+ "intlayer": "6.1.0"
151
151
  },
152
152
  "engines": {
153
153
  "node": ">=14.18"
@@ -170,6 +170,7 @@
170
170
  "prettier": "prettier . --check",
171
171
  "prettier:fix": "prettier . --write",
172
172
  "process-files": "ts-node src/transpiler/processFilesCLI.ts --dir $npm_config_dir --extension $npm_config_extension --no-node-snapshot",
173
+ "prepublish": "cp -f ../../../README.md ./README.md",
173
174
  "test": "vitest run",
174
175
  "test:watch": "vitest",
175
176
  "typecheck": "tsup --project ./tsconfig.json --noEmit"
@@ -1,2 +0,0 @@
1
- export {};
2
- //# sourceMappingURL=getFilterTranslationsOnlyContent.test.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"getFilterTranslationsOnlyContent.test.d.ts","sourceRoot":"","sources":["../../../src/deepTranformPlugins/getFilterTranslationsOnlyContent.test.ts"],"names":[],"mappings":""}
@@ -1,2 +0,0 @@
1
- export {};
2
- //# sourceMappingURL=getMissingLocalesContent.test.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"getMissingLocalesContent.test.d.ts","sourceRoot":"","sources":["../../../src/deepTranformPlugins/getMissingLocalesContent.test.ts"],"names":[],"mappings":""}
@@ -1,2 +0,0 @@
1
- export {};
2
- //# sourceMappingURL=getReplacedValuesContent.test.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"getReplacedValuesContent.test.d.ts","sourceRoot":"","sources":["../../../src/deepTranformPlugins/getReplacedValuesContent.test.ts"],"names":[],"mappings":""}
@@ -1,2 +0,0 @@
1
- export {};
2
- //# sourceMappingURL=getMarkdownMetadata.test.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"getMarkdownMetadata.test.d.ts","sourceRoot":"","sources":["../../../../src/transpiler/markdown/getMarkdownMetadata.test.ts"],"names":[],"mappings":""}