Escanear

Uso

npx gtx-cli scan

El comando gtx-cli scan escanea tu proyecto en busca de contenido traducible. Hace esto analizando el árbol de archivos de tu proyecto y usando babel para envolver el componente <T> alrededor del contenido estático. Cualquier contenido dinámico será automáticamente envuelto con componentes <Var>.

Este comando es similar al comando setup, pero es más directo y solo envuelve el componente <T> alrededor del contenido.

No agrega otros componentes como <GTProvider>. Por lo tanto, recomendamos ejecutar este comando ocasionalmente para asegurar que todo el contenido en tu proyecto sea traducible.

Deberías ejecutar setup la primera vez que estés integrando General Translation en tu proyecto.

src/app/Home.js

import { T, Var } from 'gt-next'; 

export default function Home({ user }) {
  return (
    <div>
      <T id="app.home.0">
        Hello, World! My name is <Var>{ user.name }</Var>
      </T>
    </div>
  );
}

Parámetros

Parámetro	Descripción	Tipo	Opcional	Por defecto
`--src <path>`	El directorio fuente a escanear	`string`	`true`	`./src && ./app && ./pages && ./components`
`--config <path>`	La ruta al archivo de configuración GT	`string`	`true`	`"gt.config.json"`
`--disable-ids`	Deshabilitar la generación automática de IDs para componentes `<T>`	`flag`	`true`	`false`
`--disable-formatting`	Deshabilitar el auto-formateo	`flag`	`true`	`false`

Comportamiento

La prop `id`

El comando scan generará automáticamente IDs únicos para tus componentes <T>. Esto es útil para proyectos que usan muchos componentes <T> y quieren evitar tener que asignar manualmente un ID único a cada uno.

Este id es útil para referenciar traducciones específicas en el editor de traducciones y en la consola.

Para deshabilitar este comportamiento, puedes usar la bandera --disable-ids.

Comportamiento de inyección de `<T>`

Caso básico

El CLI envolverá elementos JSX al nivel más alto posible. Esto significa que envolverá todo el componente en un componente <T> si no está ya envuelto.

<div>Hello, World!</div> -> <T id="SOME_ID"><div>Hello, World!</div></T>

Consulta la referencia para más detalles sobre cómo se envuelve el componente <T>.

Auto-formateo

El comando scan formateará automáticamente los cambios que haga a tu código base con Prettier, Biome, o ESLint dependiendo de la configuración de tu proyecto.

Para deshabilitar este comportamiento, puedes usar la bandera --disable-formatting.