Soportando diferentes lenguajes

Seyfert tiene una función i18n incorporada que te permite crear archivos de idioma y utilizarlos en tu bot.

Nota

Para esta sección vamos a seguir la configuración que hicimos en Empezando a modo de ejemplo.

Actualizando seyfert config

Antes de empezar este capítulo debe actualizar seyfert.config.mjs para decirle a seyfert donde estará nuestro fichero de idiomas.

seyfert.config.mjs

// @ts-check
import { config } from "seyfert";

export default config.bot({
  token: process.env.BOT_TOKEN ?? "",
  intents: ["Guilds"],
  locations: {
    base: "dist",
    commands: "commands",
    events: "events",
    langs: "languages" // - src/languages será nuestro directorio de idiomas
  }
});

Creación de un archivo de traducciones

Cada fichero de idioma exportará por defecto un objeto que contendrá las traducciones del idioma.

languages/en.ts

export default {
  hello: "Each key value pair will be the translation for the key",
  foo: {
    bar: "You may nest objects to create a more complex language file",
    baz: () => `You may also use functions to pass variables to the translation and add some logic`,
    ping: ({ ping }: { ping: number }) => `The ping is ${ping}`
  },
  qux: [
    "You may also use arrays to create a list of translations",
    "This is the second item in the list"
  ].join("\n")
}

Puedes crear tantos archivos de idioma como quieras, seyfert los cargará y estarán disponibles para usar en tu bot.

languages/es.ts

import type English from "./en";

export default {
  hello: "Hola, mundo!",
  foo: {
    bar: "Puedes anidar objetos para crear un archivo de idioma más complejo",
    baz: () => `Puedes usar funciones para pasar variables a la traducción y agregar lógica`,
    ping: ({ ping }) => `El ping es ${ping}`
  },
  qux: [
    "También puedes usar arrays para crear una lista de traducciones",
    "Este es el segundo elemento de la lista"
  ].join("\n")
} satisfies typeof English; // Este es un type de utilidad para asegurar que el objeto es el mismo en todos los idiomas

Nota

Cada clave debe devolver una cadena o una función que devuelva una cadena.

Precaución

El nombre del archivo será el código de idioma que utilizará para obtener las traducciones.

NA continuación debemos hacer algunas actualizaciones al declare module en el archivo index:

src/index.ts

import type English from './languages/en';
import { Client, type ParseClient, type ParseLocales } from "seyfert";

const client = new Client();

client.start();

declare module 'seyfert' {
  interface UsingClient extends ParseClient<Client<true>> { }
  // interface UsingClient extends ParseClient<HttpClient> { } // Si utiliza la API Rest

  interface DefaultLocale extends ParseLocales<typeof English> { }
}

Previniendo errores

Puedes asignar un lenguaje por defecto para evitar obtener undefined

import { Client } from "seyfert";
const client = new Client();
// ---cut--- snoopy
client.setServices({ langs: { default: 'en-US' } });

Nota

Puedes pasar cualquiera de los archivos de idioma a la interfaz DefaultLocale ya que deben tener la misma estructura de objeto.

Una vez hecho esto, podrá utilizar el idioma en sus comandos, eventos, componentes, etc.

Usando traducciones en tus comandos

Veamos un ejemplo con nuestro comando ping añadiendo una opción para responder en un idioma específico

src/commands/ping.ts

import {
  Command,
  Declare,
  Options,
  createBooleanOption,
  createStringOption,
  type CommandContext
} from 'seyfert';
import { MessageFlags } from 'seyfert/lib/types';

const options = {
  hide: createBooleanOption({
    description: "Hide command output",
  }),
  language: createStringOption({
    description: "Language to respond in",
    choices: [
      { name: "English", value: "en" },
      { name: "Spanish", value: "es" }
    ]
  })
}

@Declare({
  name: 'ping',
  description: 'Show the ping with discord'
})
@Options(options)
export default class PingCommand extends Command {

  async run(ctx: CommandContext<typeof options>) {
    const flags = ctx.options.hide ? MessageFlags.Ephemeral : undefined;
    const lang = ctx.options.language;

    // Obtener las traducciones del idioma
    const t = ctx.t.get(lang);

    // latencia promedio entre shards
    const ping = ctx.client.gateway.latency;

    await ctx.write({
      content: t.foo.ping({ ping }),
      flags,
    });
  }

}

A continuación se muestra el árbol de archivos actual del proyecto si ha seguido los pasos anteriores.

• Directorysrc

  • Directorycommands

    • ping.ts
  • Directoryevents

    • botReady.ts
    • guildDelete.ts
  • Directorylanguages

    • en.ts
    • es.ts
  • index.ts
• package.json
• seyfert.config.mjs
• .env
• tsconfig.json