refactor(commands): add localization to commands #1148

JPBM135 · 2022-10-23T14:01:36Z

My pt-BR when? 🥲

How?

i18next now supports a new namespace (fancy name for file) called commands.json, which is accessible through the commands: prefix under any valid key.
The command file uses an object-like structure (see details below).
All options are mapped by name, with the exception of choices which are mapped by value.
To take easy on crowding and remove duplicated stuff, the structure contains a commons object for things like hide or duration, the thing is some commands use a slightly different option, e.g: the ban command which has the default days as 0, not consistent with all other properties which have the default to 1. Because of this, the commons have a reasonably specific override property (see below).

This close #1123

JSON strucuture

category -> command.name
⮡ sub_command_group.name -> sub_command?.name -> option?.name -> choices?.value
⮡ sub_command.name -> option?.name -> choices?.value
⮡ option?.name -> choices?.value

Override system

Using the ban command for exemplification:

We have the common option for days:

"days": {
	"name": "days",
	"description": "The amount of days to delete messages for",
	"choices": {
		"0": "0 days",
		"1": "1 day (default)",
		"2": "2 days",
		"3": "3 days",
		"4": "4 days",
		"5": "5 days",
		"6": "6 days",
		"7": "7 days"
	}
},

But the ban command uses 0 as default, we can override only the choices portion of the days commons declaring it on the ban command:

"ban": {
	"name": "ban",
	"description": "Ban a member of(f) this guild",
	"options": {
		"days": {
			"choices": {
				"0": "0 days (default)",
				"1": "1 day",
			}
		}
	}
},

Resulting in:

{
    "name": "days",
    "description": "The amount of days to delete messages for",
    "type": 4,
    "choices": [
        {
            "name": "0 days (default)",
            "value": 0,
            "name_localizations": {
                "en-US": "0 days (default)"
            }
        },
        {
            "name": "1 day",
            "value": 1,
            "name_localizations": {
                "en-US": "1 day"
            }
        },
        {
            "name": "2 days",
            "value": 2,
            "name_localizations": {
                "en-US": "2 days"
            }
        },
        {
            "name": "3 days",
            "value": 3,
            "name_localizations": {
                "en-US": "3 days"
            }
        },
        {
            "name": "4 days",
            "value": 4,
            "name_localizations": {
                "en-US": "4 days"
            }
        },
        {
            "name": "5 days",
            "value": 5,
            "name_localizations": {
                "en-US": "5 days"
            }
        },
        {
            "name": "6 days",
            "value": 6,
            "name_localizations": {
                "en-US": "6 days"
            }
        },
        {
            "name": "7 days",
            "value": 7,
            "name_localizations": {
                "en-US": "7 days"
            }
        }
    ]
}

The system will get the name and description properties from the commons but will use the overriding choices from the ban command

vercel · 2022-10-23T14:01:40Z

@JPBM135 is attempting to deploy a commit to the discordjs Team on Vercel.

A member of the Team first needs to authorize it.

vercel · 2022-10-23T14:01:41Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Ignored Deployment

Name	Status	Preview	Updated
yuudachi-report	⬜️ Ignored (Inspect)		Nov 29, 2022 at 2:30AM (UTC)

packages/framework/src/types/Command.ts

iCrawl · 2022-11-29T02:17:13Z

packages/yuudachi/src/functions/commandsLocalization/utils.ts

+		locales.reduce<LocalizationMap>((acc, locale) => {
+			acc[locale] =
+				// eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
+				i18next.t(resolveKey(options, type), { lng: locale, fallbackLng: "dev", defaultValue: false }) || undefined;


fallbackLng: "dev" ?

Ensures that it will return undefined if not found, if not set, all the lang that doesn't have a translation would be set as English automatically by the English fallback

Ex:

EN => command.ping.description => "check the bot's health"
PT => command.ping.description => undef

i18next.t('command.ping.description', { lng: 'PT', defaultValue: false }) => check the bot's health

i18next.t('command.ping.description', { lng: 'PT', fallbackLng: 'dev', defaultValue: false }) => null/undefined

iCrawl · 2022-11-29T02:19:42Z

packages/yuudachi/src/deploy.ts

+		TimeoutCommand,
+		ClearCommand,
+		ReportUtilsCommand,
+	].map((command) => formatCommandToLocalizations("moderation", command as any));


The only way I could found to invalidate the as const

If you know a better way, pls let me know

iCrawl · 2022-11-29T02:24:01Z

One thing I can spot right now is:

Move the types.ts file for localizations to @yuudachi/framework maybe? Seems pretty generic to me and useful for everyone that uses the framework
Move the formatting functions maybe to @yuudachi/framework too?

This way things are nicely separated between "this is part of the framework" and "this is part of yuudachi specific code"

JPBM135 · 2022-11-29T03:00:32Z

One thing I can spot right now is:

Move the types.ts file for localizations to @yuudachi/framework maybe? Seems pretty generic to me and useful for everyone that uses the framework

Move the formatting functions maybe to @yuudachi/framework too?

This way things are nicely separated between "this is part of the framework" and "this is part of yuudachi specific code"

I agree with this, makes total sense to move the generic stuff to the framework

JPBM135 · 2022-11-29T03:02:15Z

I should probably add some comments for things like fallbackLng: 'dev'

JPBM135 · 2022-11-30T20:03:21Z

Add comments to sketchy stuff
Move types to the framework
Move common functions to the framework

framework/feat(type): Type for posting commands to the API

90a2228

JPBM135 marked this pull request as draft October 23, 2022 15:09

JPBM135 added 8 commits October 23, 2022 15:38

chore(i18n): move i18n to it's own function

9093591

feat(interactions): function to localize commands

cf88ed9

refactor(commands): localize commands

495f4cd

feat(i18n): namespace for command tranlsations

b0f4b27

chore(i18n): move i18n to it's own function

6c5c876

fix(typo): timeouts exist and tags doesn't

e8f386c

refactor(resolveLocales): modularize localization

a28f76f

fix(commands): missing import

028d8f8

JPBM135 changed the title ~~refactor(commands): allow commands to localize~~ refactor(commands): add localization to commands Oct 23, 2022

JPBM135 marked this pull request as ready for review October 23, 2022 21:00

fix(resolve): fix @ts-expect-error

b17da39

almostSouji added semver:minor packages:yuudachi labels Oct 24, 2022

JPBM135 commented Oct 27, 2022

View reviewed changes

packages/framework/src/types/Command.ts Outdated Show resolved Hide resolved

fix(merge): merge conflicts

cde3666

vercel bot had a problem deploying to Preview – yuudachi-report November 28, 2022 23:09 Failure

iCrawl reviewed Nov 29, 2022

View reviewed changes

chore(framework/type): improve RESTPostAPIApplicationCommand type

b86df6d

JPBM135 marked this pull request as draft November 30, 2022 20:02

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor(commands): add localization to commands #1148

refactor(commands): add localization to commands #1148

JPBM135 commented Oct 23, 2022 •

edited

Loading

vercel bot commented Oct 23, 2022

vercel bot commented Oct 23, 2022 •

edited

Loading

iCrawl Nov 29, 2022

JPBM135 Nov 29, 2022 •

edited

Loading

iCrawl Nov 29, 2022

JPBM135 Nov 29, 2022

JPBM135 Nov 29, 2022

iCrawl commented Nov 29, 2022

JPBM135 commented Nov 29, 2022 •

edited

Loading

JPBM135 commented Nov 29, 2022

JPBM135 commented Nov 30, 2022

refactor(commands): add localization to commands #1148

Are you sure you want to change the base?

refactor(commands): add localization to commands #1148

Conversation

JPBM135 commented Oct 23, 2022 • edited Loading

How?

vercel bot commented Oct 23, 2022

vercel bot commented Oct 23, 2022 • edited Loading

iCrawl Nov 29, 2022

Choose a reason for hiding this comment

JPBM135 Nov 29, 2022 • edited Loading

Choose a reason for hiding this comment

iCrawl Nov 29, 2022

Choose a reason for hiding this comment

JPBM135 Nov 29, 2022

Choose a reason for hiding this comment

JPBM135 Nov 29, 2022

Choose a reason for hiding this comment

iCrawl commented Nov 29, 2022

JPBM135 commented Nov 29, 2022 • edited Loading

JPBM135 commented Nov 29, 2022

JPBM135 commented Nov 30, 2022

JPBM135 commented Oct 23, 2022 •

edited

Loading

vercel bot commented Oct 23, 2022 •

edited

Loading

JPBM135 Nov 29, 2022 •

edited

Loading

JPBM135 commented Nov 29, 2022 •

edited

Loading