sern/tools
1
0
Fork 0
mirror of https://github.com/sern-handler/tools synced 2026-06-06 01:16:59 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

get more localizer work done

Browse Source
This commit is contained in:
Jacob Nguyen
2024-06-04 00:15:40 -05:00
parent b595cc8145
commit 71505e104f
7 changed files with 411 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@@ -11,3 +11,4 @@
node_modules/**/*
packages/ioc/node_modules/*
packages/poster/dts/discord.d.ts
packages/**/node_modules

43
packages/localizer/index.ts
View File

@@ -1,9 +1,10 @@
import { type Init, Service } from '@sern/handler'
import { type Init, Service, CommandInitPlugin, CommandType, controller } from '@sern/handler'
import { Localization as LocalsProvider } from 'shrimple-locales'
import fs from 'node:fs/promises'
import { existsSync } from 'node:fs'
import { join, resolve } from 'node:path';
import assert from 'node:assert';
import { applyLocalization, dfsApplyLocalization } from './internal'
/**
* @since 3.4.0
@@ -11,7 +12,6 @@ import assert from 'node:assert';
*/
class ShrimpleLocalizer implements Init {
private __localization!: LocalsProvider;
constructor(){}
currentLocale: string = "en-US";
translationsFor(path: string): Record<string, any> {
@@ -34,8 +34,8 @@ class ShrimpleLocalizer implements Init {
private async readLocalizationDirectory() {
const translationFiles = [];
const localPath = resolve('resources', 'locals');
assert(existsSync(localPath), "No directory \"resources/locals\" found for the localizer")
const localPath = resolve('assets', 'locals');
assert(existsSync(localPath), "No directory \"assets/locals\" found for the localizer")
for(const json_path of await fs.readdir(localPath)) {
const parsed = JSON.parse(await fs.readFile(join(localPath, json_path), 'utf8'))
const name = json_path.substring(0, json_path.lastIndexOf('.'));
@@ -69,6 +69,41 @@ export const localsFor = (path: string) => {
return Service('localizer').translationsFor(path)
}
/**
* An init plugin to add localization fields to a command module.
* Your localization configuration should look like,
* Below is es.json (spanish)
* {
"command/comer" : {
"description": "Comer en Texas",
"options": {
"chicken": {
"name": "pollo",
"description": "un pollo largo"
}
}
}
}
*/
export const localize = (root?: string) =>
//@ts-ignore
CommandInitPlugin(({ updateModule, module, deps }) => {
if(module.type === CommandType.Slash || module.type === CommandType.Both) {
const resolvedLocalization= 'command/'+root??module.name;
applyLocalization(module, [resolvedLocalization, resolvedLocalization+'.description'], [], deps)
const newOpts = module.options ?? [];
//@ts-ignore
dfsApplyLocalization(newOpts, deps, [resolvedLocalization]);
updateModule({
options: newOpts
});
} else {
console.error("Cannot localize this type of module");
return controller.next();
}
})
/**
* A service which provides simple file based localization. Add this while making dependencies.
* @example

49
packages/localizer/internal.ts Normal file
View File

@@ -0,0 +1,49 @@
export interface Option {
name:string,
type: number,
options?: Array<Option>
}
export const applyLocalization =
(item: Option, props: string[], basePath: string[], deps: any) => {
for(const n of props) {
const translated: string = deps.localizer.translationsFor(basePath.concat(n).join('.'))
Reflect.set(item, n+'_localizations', translated)
}
}
export function dfsApplyLocalization(
items: Array<Option>,
deps: Record<string,unknown>,
path: string[]) {
function dfs(item: Option, path: string[]) {
const basePath = [...path, item.name]
if (item.type === 1) {
for (const subItem of item?.options??[]) {
dfs(subItem, [...basePath, subItem.name]);
}
} else if (item.type === 2) {
for (const subItem of item?.options??[]) {
dfs(subItem, [...basePath, subItem.name]);
}
} else {
//@ts-ignore
if(Reflect.has(item, 'choices') && Array.isArray(item.choices)) {
//@ts-ignore
for(const choice of item.choices) {
applyLocalization(choice, ['name'], [...basePath, 'choices'], deps)
}
}
}
applyLocalization(item, ['name', 'description'], basePath, deps)
}
for (const item of items) {
dfs(item, [...path, 'options', item.name]);
}
}

7
packages/localizer/package.json
View File

@@ -4,13 +4,16 @@
"description": "Localizer",
"main": "dist/index.js",
"scripts": {
"build": "tsc"
"build": "tsc",
"test": "vitest"
},
"dependencies": {
"shrimple-locales": "^0.2.0"
},
"devDependencies": {
"@sern/handler": "^3.3.0"
"@sern/handler": "^3.3.0",
"discord.js": "^14.15.3",
"vitest": "^1.2.2"
},
"keywords": [],
"author": "",

98
packages/localizer/test/index.test.ts Normal file
View File

@@ -0,0 +1,98 @@
import { test, expect, describe, it, vi, afterEach } from 'vitest'
import { Localization } from '../index'
import { applyLocalization, dfsApplyLocalization, Option } from '../internal';
test('Localization Instance', () => {
expect(Localization()).toBeTruthy()
})
describe('applyLocalization', () => {
it('should apply localizations to the given item', () => {
const item: Record<string,any> = {};
const props = ['name', 'description'];
const basePath = ['app', 'pages'];
const localizer = {
translationsFor: vi.fn((key: string) => `translated.${key}`),
};
const deps = { localizer };
//@ts-ignore
applyLocalization(item, props, basePath, deps);
expect(item.name_localizations).toBe('translated.app.pages.name');
expect(item.description_localizations).toBe('translated.app.pages.description');
});
it('should not modify the item if no props are provided', () => {
//@ts-ignore
const item: Option = {};
const props: string[] = [];
const basePath = ['app', 'pages'];
const localizer = {
translationsFor: vi.fn(),
};
const deps = { localizer };
applyLocalization(item, props, basePath, deps);
expect(item).toEqual({});
});
});
describe('dfsApplyLocalization', () => {
afterEach(() => {
vi.resetAllMocks();
});
it('should apply localizations to top-level items', () => {
const items = [{ type: 3, name: 'item1' }, { type: 3, name: 'item2' }];
const deps = { localizer: { translationsFor: vi.fn() } };
const path = ['root'];
dfsApplyLocalization(items, deps, path);
});
it('should apply localizations to nested items', () => {
const items: Option[] = [
{
name: 'item1',
type: 1,
options: [{ type: 3, name: 'subItem1' }],
},
];
const deps = { localizer: { translationsFor: vi.fn() } };
const path = ['root'];
dfsApplyLocalization(items, deps, path);
});
it('should apply localizations to choices', () => {
const items: Option[] = [
{
name: 'item1',
//@ts-ignore
choices: [{ name: 'choice1' }, { name: 'choice2' }],
},
];
const deps = { localizer: { translationsFor: vi.fn(() => "a") } };
const path = ['root'];
dfsApplyLocalization(items, deps, path);
console.log(items[0].choices)
});
it('should call applyLocalization n times, n = num of options', () => {
const items: Option[] = [
{
name: 'item1',
type: 3,
},
{
name: "item2",
type: 4
}
];
})
});

4
packages/localizer/tsconfig.json
View File

@@ -1,4 +1,8 @@
{
"files": [
"./index.ts",
"./internal.ts"
],
"compilerOptions": {
/* Visit https://aka.ms/tsconfig to read more about this file */

216
yarn.lock
View File

@@ -5,6 +5,85 @@ __metadata:
version: 6
cacheKey: 8
"@discordjs/builders@npm:^1.8.2":
version: 1.8.2
resolution: "@discordjs/builders@npm:1.8.2"
dependencies:
"@discordjs/formatters": ^0.4.0
"@discordjs/util": ^1.1.0
"@sapphire/shapeshift": ^3.9.7
discord-api-types: 0.37.83
fast-deep-equal: ^3.1.3
ts-mixer: ^6.0.4
tslib: ^2.6.2
checksum: 65c707f28fb40b2875ebc08d580b6902eaf988c0e70ad674e33893abfdde74b52fc491476336a312c4f18de2fc599e1299341af152265d84864c907a12749a8e
languageName: node
linkType: hard
"@discordjs/collection@npm:1.5.3":
version: 1.5.3
resolution: "@discordjs/collection@npm:1.5.3"
checksum: fefed19bea0f69053d195f9d9dc8af07ca5d8c9b1064581e0aa14bda2b70e632b93c164d5ef3e4910f5442369612ff4eec8d52a700aec562510c19b223f67023
languageName: node
linkType: hard
"@discordjs/collection@npm:^2.1.0":
version: 2.1.0
resolution: "@discordjs/collection@npm:2.1.0"
checksum: ebe1a32769296f14a38b2c718c7e0d00830e37e68e59a3683aa0f7c25adf9487ebaca3ac3f78fd60e2c89cf314b7891312cac36e3b0885cceb4d2a677ae7d19b
languageName: node
linkType: hard
"@discordjs/formatters@npm:^0.4.0":
version: 0.4.0
resolution: "@discordjs/formatters@npm:0.4.0"
dependencies:
discord-api-types: 0.37.83
checksum: 130ab7ba104635d7d0f92f4c3de67dbc60cdab004e9db605e0f2c7f410a9808df8776e4d5d45632597dc7257713dc77bb616ee25bb0827117247b6bebfe35921
languageName: node
linkType: hard
"@discordjs/rest@npm:^2.3.0":
version: 2.3.0
resolution: "@discordjs/rest@npm:2.3.0"
dependencies:
"@discordjs/collection": ^2.1.0
"@discordjs/util": ^1.1.0
"@sapphire/async-queue": ^1.5.2
"@sapphire/snowflake": ^3.5.3
"@vladfrangu/async_event_emitter": ^2.2.4
discord-api-types: 0.37.83
magic-bytes.js: ^1.10.0
tslib: ^2.6.2
undici: 6.13.0
checksum: 01564bf108c359f5650318ccadc51bf762c99df56de865192b25adef4331c0729886e84b4ebd10dfc57818b97ff891f1857873811e7a2326d24fd0bf892a0201
languageName: node
linkType: hard
"@discordjs/util@npm:^1.1.0":
version: 1.1.0
resolution: "@discordjs/util@npm:1.1.0"
checksum: b4db3fc6017986cd0e7fd6aa50e890e1259e79c6e0ff9c07685a86b2c22409a42f146f282d907885444f37ca596220c166d8be11851fab7f9e2c1ee932fd524e
languageName: node
linkType: hard
"@discordjs/ws@npm:^1.1.1":
version: 1.1.1
resolution: "@discordjs/ws@npm:1.1.1"
dependencies:
"@discordjs/collection": ^2.1.0
"@discordjs/rest": ^2.3.0
"@discordjs/util": ^1.1.0
"@sapphire/async-queue": ^1.5.2
"@types/ws": ^8.5.10
"@vladfrangu/async_event_emitter": ^2.2.4
discord-api-types: 0.37.83
tslib: ^2.6.2
ws: ^8.16.0
checksum: 42ba6dad56d6d340b34e400144cb6cd0433c963b16c51e24496b43a1a23cc01c663cb24c492b9fc8c1f7dd528ce32f7d34e2ed379dbc57352468f5505fe21486
languageName: node
linkType: hard
"@esbuild/aix-ppc64@npm:0.20.2":
version: 0.20.2
resolution: "@esbuild/aix-ppc64@npm:0.20.2"
@@ -371,6 +450,30 @@ __metadata:
languageName: node
linkType: hard
"@sapphire/async-queue@npm:^1.5.2":
version: 1.5.2
resolution: "@sapphire/async-queue@npm:1.5.2"
checksum: 6252e72254f33c91da4887e324f17b59708b12c603216cc45f001460fd33265844301de47ab67c8caf8383ee280b39c8427ede242bd3b50b6ccdf13a386a5f1b
languageName: node
linkType: hard
"@sapphire/shapeshift@npm:^3.9.7":
version: 3.9.7
resolution: "@sapphire/shapeshift@npm:3.9.7"
dependencies:
fast-deep-equal: ^3.1.3
lodash: ^4.17.21
checksum: a36032ff8fc54056ea21e0cdbbea84c3d80c0c0fb19b2685e14e29111ab9c1172c9273e1e54d49e2a62ba5a393f18b3dab9330d34b97d3519d572e32dd64913d
languageName: node
linkType: hard
"@sapphire/snowflake@npm:3.5.3, @sapphire/snowflake@npm:^3.5.3":
version: 3.5.3
resolution: "@sapphire/snowflake@npm:3.5.3"
checksum: 821add76877e2786ddb1b5cd3ee5de130610b82014972d91a99b4b7ce5475839b9a26f94de322f48a66f9ba2e2c578ffe46a60d06cbb9a36fd8fb96ef78be248
languageName: node
linkType: hard
"@sern/builder@workspace:packages/builder":
version: 0.0.0-use.local
resolution: "@sern/builder@workspace:packages/builder"
@@ -405,7 +508,9 @@ __metadata:
resolution: "@sern/localizer@workspace:packages/localizer"
dependencies:
"@sern/handler": ^3.3.0
discord.js: ^14.15.3
shrimple-locales: ^0.2.0
vitest: ^1.2.2
languageName: unknown
linkType: soft
@@ -431,6 +536,15 @@ __metadata:
languageName: node
linkType: hard
"@types/node@npm:*":
version: 20.14.1
resolution: "@types/node@npm:20.14.1"
dependencies:
undici-types: ~5.26.4
checksum: 268d8ca09ce2bd6106af5eca118b06ec4c781be5b43ed1865371d0d09c5f4892353d2069bfcaf4cecc3d68a2016d730e44d9793a574c7e49bec2ba68871b94c8
languageName: node
linkType: hard
"@types/node@npm:^18.16.0":
version: 18.19.33
resolution: "@types/node@npm:18.19.33"
@@ -449,6 +563,15 @@ __metadata:
languageName: node
linkType: hard
"@types/ws@npm:^8.5.10":
version: 8.5.10
resolution: "@types/ws@npm:8.5.10"
dependencies:
"@types/node": "*"
checksum: 3ec416ea2be24042ebd677932a462cf16d2080393d8d7d0b1b3f5d6eaa4a7387aaf0eefb99193c0bfd29444857cf2e0c3ac89899e130550dc6c14ada8a46d25e
languageName: node
linkType: hard
"@vitest/expect@npm:1.6.0":
version: 1.6.0
resolution: "@vitest/expect@npm:1.6.0"
@@ -503,6 +626,13 @@ __metadata:
languageName: node
linkType: hard
"@vladfrangu/async_event_emitter@npm:^2.2.4":
version: 2.2.4
resolution: "@vladfrangu/async_event_emitter@npm:2.2.4"
checksum: ff65ebc4d89639adecd249e24e4f6f97b7696404f2a4461160efdff628d91de543e982727c18de62a4edada3f66381b5a3cd1d4f4f33098075d839c1b4f46979
languageName: node
linkType: hard
"abbrev@npm:^2.0.0":
version: 2.0.0
resolution: "abbrev@npm:2.0.0"
@@ -798,6 +928,13 @@ __metadata:
languageName: node
linkType: hard
"discord-api-types@npm:0.37.83":
version: 0.37.83
resolution: "discord-api-types@npm:0.37.83"
checksum: ab2a31188352d9c742f09a114a95322e7f7de90199cb9f5571f7f5ac25765e7abc9b83c15c14d513ffc5e1d63d9e3ea5ff088fa8a1c5d9c1e1f395b27027cef0
languageName: node
linkType: hard
"discord-api-types@npm:latest":
version: 0.37.87
resolution: "discord-api-types@npm:0.37.87"
@@ -805,6 +942,26 @@ __metadata:
languageName: node
linkType: hard
"discord.js@npm:^14.15.3":
version: 14.15.3
resolution: "discord.js@npm:14.15.3"
dependencies:
"@discordjs/builders": ^1.8.2
"@discordjs/collection": 1.5.3
"@discordjs/formatters": ^0.4.0
"@discordjs/rest": ^2.3.0
"@discordjs/util": ^1.1.0
"@discordjs/ws": ^1.1.1
"@sapphire/snowflake": 3.5.3
discord-api-types: 0.37.83
fast-deep-equal: 3.1.3
lodash.snakecase: 4.1.1
tslib: 2.6.2
undici: 6.13.0
checksum: 0b521caee9040c3a39200e6bf01b60230e9abd89b13e632054be2a2e08b74708b0776dd61ccf5e737968c33907e824c7fca9aeb62a293700cd5d517ce82f795d
languageName: node
linkType: hard
"eastasianwidth@npm:^0.2.0":
version: 0.2.0
resolution: "eastasianwidth@npm:0.2.0"
@@ -962,6 +1119,13 @@ __metadata:
languageName: node
linkType: hard
"fast-deep-equal@npm:3.1.3, fast-deep-equal@npm:^3.1.3":
version: 3.1.3
resolution: "fast-deep-equal@npm:3.1.3"
checksum: e21a9d8d84f53493b6aa15efc9cfd53dd5b714a1f23f67fb5dc8f574af80df889b3bce25dc081887c6d25457cce704e636395333abad896ccdec03abaf1f3f9d
languageName: node
linkType: hard
"fast-glob@npm:^3.3.2":
version: 3.3.2
resolution: "fast-glob@npm:3.3.2"
@@ -1276,6 +1440,20 @@ __metadata:
languageName: node
linkType: hard
"lodash.snakecase@npm:4.1.1":
version: 4.1.1
resolution: "lodash.snakecase@npm:4.1.1"
checksum: 1685ed3e83dda6eae5a4dcaee161a51cd210aabb3e1c09c57150e7dd8feda19e4ca0d27d0631eabe8d0f4eaa51e376da64e8c018ae5415417c5890d42feb72a8
languageName: node
linkType: hard
"lodash@npm:^4.17.21":
version: 4.17.21
resolution: "lodash@npm:4.17.21"
checksum: eb835a2e51d381e561e508ce932ea50a8e5a68f4ebdd771ea240d3048244a8d13658acbd502cd4829768c56f2e16bdd4340b9ea141297d472517b83868e677f7
languageName: node
linkType: hard
"loupe@npm:^2.3.6, loupe@npm:^2.3.7":
version: 2.3.7
resolution: "loupe@npm:2.3.7"
@@ -1292,6 +1470,13 @@ __metadata:
languageName: node
linkType: hard
"magic-bytes.js@npm:^1.10.0":
version: 1.10.0
resolution: "magic-bytes.js@npm:1.10.0"
checksum: c10e7fc3fe584e4b0767554fb6a12dfc4a9db0782d5005cbdd46bc9b36a8bb420f5266a4b02e089ea4db587937fde289ea467a7a379ad969fb906bf4a0ec3f38
languageName: node
linkType: hard
"magic-string@npm:^0.30.5":
version: 0.30.10
resolution: "magic-string@npm:0.30.10"
@@ -2053,6 +2238,13 @@ __metadata:
languageName: unknown
linkType: soft
"ts-mixer@npm:^6.0.4":
version: 6.0.4
resolution: "ts-mixer@npm:6.0.4"
checksum: 36b1af526befd74345e736e9aa16f5c28876ebcea07784da14d929149fd7e6028cfd2fe9304c8efe8cb91b588443a9cc9e991df58e4c6e602326edbaae2af3ab
languageName: node
linkType: hard
"ts-results-es@npm:^4.0.0":
version: 4.2.0
resolution: "ts-results-es@npm:4.2.0"
@@ -2060,7 +2252,7 @@ __metadata:
languageName: node
linkType: hard
"tslib@npm:^2.1.0":
"tslib@npm:2.6.2, tslib@npm:^2.1.0, tslib@npm:^2.6.2":
version: 2.6.2
resolution: "tslib@npm:2.6.2"
checksum: 329ea56123005922f39642318e3d1f0f8265d1e7fcb92c633e0809521da75eeaca28d2cf96d7248229deb40e5c19adf408259f4b9640afd20d13aecc1430f3ad
@@ -2108,6 +2300,13 @@ __metadata:
languageName: node
linkType: hard
"undici@npm:6.13.0":
version: 6.13.0
resolution: "undici@npm:6.13.0"
checksum: 47495e93aceeab18664678b6fb0ea2395b7c13a33d2ed4f7f36eb9be9ec5cd6f8e3a4ddaec18127da5e2012e5d7666ca824c7dc70af606dcfe6fdb8441ee3a7a
languageName: node
linkType: hard
"undici@npm:^5.28.4":
version: 5.28.4
resolution: "undici@npm:5.28.4"
@@ -2303,6 +2502,21 @@ __metadata:
languageName: node
linkType: hard
"ws@npm:^8.16.0":
version: 8.17.0
resolution: "ws@npm:8.17.0"
peerDependencies:
bufferutil: ^4.0.1
utf-8-validate: ">=5.0.2"
peerDependenciesMeta:
bufferutil:
optional: true
utf-8-validate:
optional: true
checksum: 147ef9eab0251364e1d2c55338ad0efb15e6913923ccbfdf20f7a8a6cb8f88432bcd7f4d8f66977135bfad35575644f9983201c1a361019594a4e53977bf6d4e
languageName: node
linkType: hard
"yallist@npm:^4.0.0":
version: 4.0.0
resolution: "yallist@npm:4.0.0"