El contenido de esta página ha sido traducido con una IA.
Ver la última versión del contenido original en inglésCómo funciona Intlayer
Resumen
La idea principal detrás de Intlayer es adoptar una gestión de contenido por componente. Entonces, la idea detrás de Intlayer es permitirte declarar tu contenido en cualquier lugar de tu base de código, como en el mismo directorio que tu componente.
.└── Components └── MyComponent ├── index.content.cjs └── index.mjsPara hacer esto, el rol de Intlayer es encontrar todos tus archivos de declaración de contenido, en todos los formatos diferentes presentes en tu proyecto, y luego generará los diccionarios a partir de ellos.
Entonces, hay dos pasos principales:
- Paso de construcción
- Paso de interpretación
Paso de construcción de diccionarios
El paso de construcción se puede realizar de tres maneras:
- usando la CLI con npx intlayer build
- usando extensión de vscode
- usando los plugins de la aplicación como el paquete vite-intlayer, o sus equivalentes para Next.js. Cuando usas uno de estos plugins, Intlayer construirá automáticamente tus diccionarios cuando inicies (dev) o construyas (prod) tu aplicación.
Declaración de archivos de contenido
- Los archivos de contenido pueden definirse en varios formatos, como TypeScript, ECMAScript, CommonJS o JSON.
- Los archivos de contenido pueden definirse en cualquier lugar del proyecto, lo que permite un mejor mantenimiento y escalabilidad. Es importante respetar las convenciones de extensión de archivo para los archivos de contenido. Esta extensión es por defecto *.content.{js|cjs|mjs|ts|tsx|json}, pero puede modificarse en el archivo de configuración.
Generación de diccionarios
- Los diccionarios se generan a partir de los archivos de contenido. Por defecto, los diccionarios de Intlayer se generan en el directorio .intlayer/dictionaries del proyecto.
- Esos diccionarios se generan en diferentes formatos para satisfacer todas las necesidades y optimizar el rendimiento de la aplicación.
Generación de tipos de diccionario
Basado en tus diccionarios, Intlayer generará tipos para hacerlos utilizables en tu aplicación.
Los tipos de diccionario se generan a partir de los diccionarios de Intlayer. Por defecto, los tipos de diccionario de Intlayer se generan en el directorio .intlayer/types del proyecto.
La ampliación de módulos de Intlayer es una característica de TypeScript que te permite definir tipos adicionales para Intlayer. Esto facilita la experiencia de desarrollo al sugerir argumentos disponibles o requeridos. Entre los tipos generados, los tipos de diccionario de Intlayer o incluso los tipos de configuración de idioma se añaden al archivo types/intlayer.d.ts, y son utilizados por otros paquetes. Para hacer esto, es necesario que el archivo tsconfig.json esté configurado para incluir el directorio types del proyecto.
Paso de interpretación de diccionarios
Usando Intlayer, accederás a tu contenido en tu aplicación usando el hook useIntlayer.
const MyComponent = () => { const content = useIntlayer("my-component"); return <div>{content.title}</div>;};Este hook gestionará la detección del idioma por ti y devolverá el contenido para el idioma actual. Usando este hook, también podrás interpretar markdown, gestionar pluralización y más.
Para ver todas las características de Intlayer, puedes leer la documentación de diccionarios.
Contenido remoto
Intlayer te permite declarar contenido localmente y luego exportarlo al CMS para que sea editable por tu equipo no técnico.
Así podrás enviar y recibir contenido del CMS a tu aplicación, de manera similar a lo que haces con Git para tu código.
Si está configurado en tu proyecto, Intlayer gestionará automáticamente la obtención del contenido desde el CMS cuando la aplicación inicie (dev) / se construya (prod).
Editor visual
Intlayer también proporciona un editor visual para permitirte editar tu contenido de manera visual. Este editor visual está disponible en el paquete externo intlayer-editor.
Optimización de construcción de la aplicación
Para optimizar el tamaño del paquete de tu aplicación, Intlayer proporciona dos plugins para optimizar la construcción de tu aplicación: los plugins @intlayer/babel y @intlayer/swc.
En modo de desarrollo, Intlayer utiliza una importación estática centralizada para los diccionarios para simplificar la experiencia de desarrollo.
Al optimizar la construcción, Intlayer reemplazará todas las llamadas de diccionarios para optimizar la división de archivos. De esta manera, el paquete final importará solo los diccionarios que se utilicen.
Al activar la opción activateDynamicImport en la configuración, Intlayer usará la importación dinámica para cargar los diccionarios. Esta opción está desactivada por defecto para evitar el procesamiento asíncrono al renderizar la aplicación.
@intlayer/babel está disponible por defecto en el paquete vite-intlayer,
@intlayer/swc no está instalado por defecto en el paquete next-intlayer ya que los plugins SWC aún son experimentales en Next.js.
Para ver cómo configurar la construcción de tu aplicación, puedes leer la documentación de configuración.
Paquetes
Intlayer está compuesto por varios paquetes, cada uno con un rol específico en el proceso de traducción. Aquí hay una representación gráfica de la estructura de este paquete:
intlayer
El paquete intlayer se utiliza en aplicaciones para declarar contenido en archivos de contenido.
react-intlayer
El paquete react-intlayer se utiliza para interpretar los diccionarios de Intlayer y hacerlos utilizables en aplicaciones React.
next-intlayer
El paquete next-intlayer se utiliza como una capa sobre react-intlayer para hacer que los diccionarios de Intlayer sean utilizables en aplicaciones Next.js. Integra características esenciales para que Intlayer funcione en un entorno Next.js, como middleware de traducción, enrutamiento o la configuración del archivo next.config.js.
vue-intlayer
El paquete vue-intlayer se utiliza para interpretar los diccionarios de Intlayer y hacerlos utilizables en aplicaciones Vue.
svelte-intlayer (WIP)
El paquete svelte-intlayer se utiliza para interpretar los diccionarios de Intlayer y hacerlos utilizables en aplicaciones Svelte.
solid-intlayer (WIP)
El paquete solid-intlayer se utiliza para interpretar los diccionarios de Intlayer y hacerlos utilizables en aplicaciones Solid.js.
preact-intlayer
El paquete preact-intlayer se utiliza para interpretar los diccionarios de Intlayer y hacerlos utilizables en aplicaciones Preact.
angular-intlayer (WIP)
El paquete angular-intlayer se utiliza para interpretar los diccionarios de Intlayer y hacerlos utilizables en aplicaciones Angular.
express-intlayer
El paquete express-intlayer se utiliza para usar Intlayer en un backend de Express.js.
react-native-intlayer
El paquete react-native-intlayer proporciona herramientas que integran plugins para que Intlayer funcione con el empaquetador Metro.
lynx-intlayer
El paquete lynx-intlayer proporciona herramientas que integran plugins para que Intlayer funcione con el empaquetador Lynx.
vite-intlayer
Incluye el plugin de Vite para integrar Intlayer con el empaquetador Vite, así como middleware para detectar el idioma preferido del usuario, gestionar cookies y manejar redirecciones de URL.
react-scripts-intlayer
intlayer-editor
El paquete intlayer-editor se utiliza para permitir el uso del editor visual. Este paquete, opcional, puede instalarse en aplicaciones y será utilizado por el paquete react-intlayer. Consiste en dos partes: el servidor y el cliente.
El cliente contiene elementos de interfaz de usuario que serán utilizados por react-intlayer.
El servidor, basado en Express, se utiliza para recibir solicitudes del editor visual y gestionar o modificar archivos de contenido.
intlayer-cli
El paquete intlayer-cli puede ser utilizado para generar diccionarios usando el comando npx intlayer dictionaries build. Si intlayer ya está instalado, la CLI se instala automáticamente y este paquete no es necesario.
@intlayer/core
El paquete @intlayer/core es el paquete principal de Intlayer. Contiene funciones de traducción y gestión de diccionarios. @intlayer/core es multiplataforma y es utilizado por otros paquetes para realizar la interpretación de diccionarios.
@intlayer/config
El paquete @intlayer/config se utiliza para configurar los ajustes de Intlayer, como los idiomas disponibles, los parámetros del middleware de Next.js o los ajustes del editor integrado.
@intlayer/webpack
El paquete @intlayer/webpack se utiliza para proporcionar una configuración de Webpack que permita que una aplicación basada en Webpack funcione con Intlayer. El paquete también proporciona un plugin para añadir a una aplicación existente de Webpack.
@intlayer/cli
El paquete @intlayer/cli es un paquete de NPM que se utiliza para declarar los scripts relacionados con las interfaces de línea de comandos de Intlayer. Garantiza la uniformidad de todos los comandos CLI de Intlayer. Este paquete es consumido notablemente por los paquetes intlayer-cli y intlayer.
@intlayer/dictionaries-entry & @intlayer/unmerged-dictionaries-entry & @intlayer/dynamic-dictionaries-entry
Los paquetes @intlayer/dictionaries-entry, @intlayer/unmerged-dictionaries-entry y @intlayer/dynamic-dictionaries-entry devuelven la ruta de entrada de los diccionarios de Intlayer. Dado que buscar en el sistema de archivos desde el navegador es imposible, usar empaquetadores como Webpack o Rollup para recuperar la ruta de entrada de los diccionarios no es posible. Estos paquetes están diseñados para ser alias, permitiendo la optimización del empaquetado en varios empaquetadores como Vite, Webpack y Turbopack.
@intlayer/chokidar
El paquete @intlayer/chokidar se utiliza para monitorear archivos de contenido y regenerar el diccionario modificado en cada modificación.
@intlayer/editor
El paquete @intlayer/editor proporciona las utilidades relacionadas con el editor de diccionarios. Incluye notablemente la API para interconectar una aplicación con el editor de Intlayer y utilidades para manipular diccionarios. Este paquete es multiplataforma.
@intlayer/editor-react
El paquete @intlayer/editor-react proporciona estados, contextos, hooks y componentes para interconectar una aplicación React con el editor de Intlayer.
@intlayer/babel
El paquete @intlayer/babel proporciona herramientas que optimizan el empaquetado de diccionarios para aplicaciones basadas en Vite y Webpack.
@intlayer/swc
El paquete @intlayer/swc proporciona herramientas que optimizan el empaquetado de diccionarios para aplicaciones Next.js.
@intlayer/api
El paquete @intlayer/api es un SDK de API para interactuar con el backend.
@intlayer/design-system
El paquete @intlayer/design-system se utiliza para compartir elementos de diseño entre el CMS y el editor visual.
@intlayer/backend
El paquete @intlayer/backend exporta tipos de backend y eventualmente ofrecerá el backend como un paquete independiente en el futuro.
Chatea con nuestra documentación inteligente
Si tienes una idea para mejorar esta documentación, no dudes en contribuir enviando una pull request en GitHub.
Enlace de GitHub a la documentación