Newbies Pass Muster

    @sapphire/plugin-i18next
    TypeScript icon, indicating that this package has built-in type declarations

    4.0.1 • Public • Published

    Sapphire Logo

    @sapphire/plugin-i18next

    Plugin for @sapphire/framework to support i18next based internationalization.

    GitHub codecov npm bundle size npm

    Description

    An implementation of i18next's filesystem backend for Sapphire. It allows you to use a JSON-based languages directory to add internationalization for your bot using SapphireClient's fetchLanguage hook and a custom message extension, adding features such as sendTranslated and resolveKey.

    Features

    • Fully ready for TypeScript!
    • Includes ESM ready entrypoint
    • Framework agnostic
    • Includes convenience register for discord.js

    Installation

    @sapphire/plugin-i18next depends on the following packages. Be sure to install these along with this package!

    You can use the following command to install this package, or replace npm install with your package manager of choice.

    npm install @sapphire/plugin-i18next @sapphire/framework discord.js

    Usage

    This registers the methods and options necessary for message translations in the Sapphire client.

    // Main bot file
    // Be sure to register the plugin before instantiating the client.
    import '@sapphire/plugin-i18next/register';

    The basic structure of a translation file is as follows:

    // languages/en-US/commands/ping.json
    {
    	"success": "Pong!",
    	"success_with_args": "Pong! Took me {{latency}}ms to reply"
    }

    The resolveKey function can be used anywhere to get translated text by its key. In this example, it is used in a method to send a message.

    import { resolveKey } from '@sapphire/plugin-i18next';
    import { Command } from '@sapphire/framework';
    import type { Message } from 'discord.js';
    
    export class PingCommand extends Command {
    	public constructor(context: Command.Context, options: Command.Options) {
    		super(context, {
    			...options,
    			description: 'ping pong'
    		});
    	}
    
    	public async messageRun(message: Message) {
    		await message.channel.send(await resolveKey('commands/ping:success'));
    	}
    }

    sendLocalized will send translated text resolved from a key to a specified channel.

    import { sendLocalized } from '@sapphire/plugin-i18next';
    import { Command } from '@sapphire/framework';
    
    import type { Message } from 'discord.js';
    
    export class PingCommand extends Command {
    	public constructor(context: Command.Context, options: Command.Options) {
    		super(context, {
    			...options,
    			description: 'ping pong'
    		});
    	}
    
    	public async messageRun(message: Message) {
    		await sendLocalized(message, 'commands/ping:success');
    	}
    }

    editLocalized edits a message, replacing its content with translated text resolved from its key.

    import { editLocalized } from '@sapphire/plugin-i18next';
    import { Command } from '@sapphire/framework';
    
    import type { Message } from 'discord.js';
    
    export class PingCommand extends Command {
    	public constructor(context: Command.Context, options: Command.Options) {
    		super(context, {
    			...options,
    			description: 'ping pong'
    		});
    	}
    
    	public async messageRun(message: Message) {
    		await editLocalized(message, 'commands/ping:success_args', { latency: ws.ping });
    	}
    }

    fetchLanguage returns the guild-specific language that the client is using.

    import { fetchLanguage } from '@sapphire/plugin-i18next';
    import { Command } from '@sapphire/framework';
    
    import type { Message } from 'discord.js';
    
    export class PingCommand extends Command {
    	public constructor(context: Command.Context, options: Command.Options) {
    		super(context, {
    			...options,
    			description: 'ping pong'
    		});
    	}
    
    	public async messageRun(message: Message) {
    		return message.channel.send(await fetchLanguage(message));
    		// ===> en-US
    	}
    }

    Buy us some doughnuts

    Sapphire Community is and always will be open source, even if we don't get donations. That being said, we know there are amazing people who may still want to donate just to show their appreciation. Thank you very much in advance!

    We accept donations through Open Collective, Ko-fi, Paypal, Patreon and GitHub Sponsorships. You can use the buttons below to donate through your method of choice.

    Donate With Address
    Open Collective Click Here
    Ko-fi Click Here
    Patreon Click Here
    PayPal Click Here

    Contributors

    Thanks goes to these wonderful people (emoji key):


    Jeroen Claassens

    💻 🚇 📆

    Nejc Drobnic

    💻 📖

    Antonio Román

    💻

    Vlad Frangu

    👀

    depfu[bot]

    🚧

    dependabot[bot]

    🚧

    allcontributors[bot]

    📖

    Tyler J Russell

    💻 📖

    Stitch07

    💻 🐛

    PlatinBae

    📖

    Kaname

    💻 📖

    Elliot

    💻

    Lioness100

    💻 📖

    UndiedGamer

    💻

    Feralheart

    💻

    Jurien Hamaker

    💻

    renovate[bot]

    🚧

    WhiteSource Renovate

    🚧

    c43721

    💻

    megatank58

    💻

    FC

    💻

    Just a Badly Drawn TABS Dude

    💻

    newt :D

    💻

    Mzato

    💻

    Harry Allen

    💻

    Julian

    💻

    Krish

    💻

    Parbez

    💻

    ricardooow

    💻

    Hezekiah Hendry

    🔧

    yuansheng1549

    💻

    Ben

    💻

    Priyam

    💻

    Arcadia148

    💻

    This project follows the all-contributors specification. Contributions of any kind welcome!

    Install

    npm i @sapphire/plugin-i18next

    DownloadsWeekly Downloads

    836

    Version

    4.0.1

    License

    MIT

    Unpacked Size

    103 kB

    Total Files

    28

    Last publish

    Collaborators

    • favna
    • kyranet
    • vladfrangu