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

Merge pull request #3 from sern-handler/feat/localization

Browse Source 
@sern/localizer
This commit is contained in:
Jacob Nguyen
2024-06-08 13:45:26 -05:00
committed by GitHub
parent 3b89861937 d761ab8bcd
commit b8475a7e65
11 changed files with 2934 additions and 474 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

3
packages/builder/package.json
View File

@@ -18,8 +18,7 @@
"discord-api-types": "latest"
},
"devDependencies": {
"@types/node": "^20.1.0",
"typescript": "^5.0.4"
"@types/node": "^20.1.0"
},
"keywords": [],
"author": "",

2
packages/localizer/.gitignore vendored Normal file
View File

@@ -0,0 +1,2 @@
dist/
*.tgz

75
packages/localizer/index.mdx Normal file
View File

@@ -0,0 +1,75 @@
---
title: Localizer
description: Translate your bot for the world
sidebar:
order: 1
---
# @sern/localizer
A localization module for managing translations and providing localized content in your application.
## Installation
```
npm i @sern/localizer
```
## Usage
**Initializing the Localizer**
```ts
import { makeDependencies } from '@sern/handler';
import { Localization } from '@sern/localizer';
await makeDependencies(({ add }) => {
add('localizer', Localization());
});
```
This localizer is **FILE BASED**.
Create the directory `assets/locals`. Each json file in here must be named after the `locale`
import { Tabs, TabItem } from "@astrojs/starlight/components";
<Tabs>
<TabItem label="Spanish">
```json title=~/assets/locals/es.json
{
"salute": {
"hello": "hola"
}
}
```
</TabItem>
<TabItem label="English">
```json title=~/assets/locals/en-US.json
{
"salute": {
"hello": "hello"
}
}
```
</TabItem>
</Tabs>
**Accessing translations**
- If you are in a command execute callback, use `deps` from SDT.
```ts
execute : (ctx, { deps }) => {
//the localizer object from makeDependencies
deps.localizer
// Returns the Spanish translation for 'salute.hello'
deps.localizer.translate("salute.hello", "es");
}
```
```ts
import { local } from '@sern/localizer';
// Returns the Spanish translation for 'salute.hello'
const greeting = local('salute.hello', 'es');
```

145
packages/localizer/index.ts Normal file
View File

@@ -0,0 +1,145 @@
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 { dfsApplyLocalization } from './internal'
/**
* @since 3.4.0
* @internal
*/
class ShrimpleLocalizer implements Init {
private __localization!: LocalsProvider;
private currentLocale: string = "en";
translationsFor(path: string): Record<string, any> {
return this.__localization.localizationFor(path);
}
translate(text: string, local?: string): string {
return this.__localization.get(text, local);
}
setCurrentLocale(local: string): void {
this.__localization.changeLanguage(local);
}
async init() {
const map = await this.readLocalizationDirectory();
this.__localization = new LocalsProvider({
defaultLocale: this.currentLocale,
fallbackLocale: "en",
locales: map
});
}
private async readLocalizationDirectory() {
const translationFiles = [];
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('.'));
translationFiles.push({ [name]: parsed })
}
return translationFiles.reduce((acc, cur) => ({ ...cur, ...acc }), {});
}
}
/**
* Translates a string to its respective local
* Note: this method only works AFTER your container has been initiated
* @example
* ```ts
* assert.deepEqual(locals("salute.hello", "es"), "hola")
* ```
*/
export const local = (i: string, local: string) => {
return Service('localizer').translate(i, local)
}
/**
* An init plugin to add localization fields to a command module.
* Your localization configuration should look like,
* @param root {string} If you have conflicting command names, you may configure the root of the name. (= command/{root})
* Below is es.json (spanish)
* ```json
{
"command/comer" : {
"description": "Comer en Texas",
"options": {
"chicken": {
"name": "pollo",
"description": "un pollo largo"
}
}
}
}
```
*/
export const localize = (root?: string) =>
//@ts-ignore
CommandInitPlugin(({ module, deps }) => {
if(module.type === CommandType.Slash || module.type === CommandType.Both) {
deps['@sern/logger'].info({ message: "Localizing "+ module.name });
const resolvedLocalization= 'command/'+(root??module.name);
Reflect.set(module, 'name_localizations', deps.localizer.translationsFor(resolvedLocalization+".name"));
Reflect.set(module, 'description_localizations', deps.localizer.translationsFor(resolvedLocalization+'.description'));
const newOpts = module.options ?? [];
//@ts-ignore
dfsApplyLocalization(newOpts, deps, [resolvedLocalization]);
return controller.next();
} else {
//@ts-ignore
return controller.stop("Cannot localize this type of module " + module.name);
}
})
export interface Localizer {
/**
* Returns an object containing translations for the given path.
* The object keys are the translation keys, and the values are the translated strings.
*
* @param path - The path to the translations file or directory.
* @returns An object with translation keys and their corresponding translated strings.
*/
translationsFor(path: string): Record<string, any>;
/**
* Translates the given text to the specified locale.
*
* @param text - The text to be translated.
* @param locale - The locale to translate the text to.
* @returns The translated text.
*/
translate(text: string, locale?: string): string;
/**
* Sets the current locale to be used for translation.
* @param locale - The locale to set as the current locale.
*/
setCurrentLocale(locale: string): void;
}
/**
* A service which provides simple file based localization. Add this while making dependencies.
* @example
* ```ts
* await makeDependencies(({ add }) => {
* add('localizer', Localization());
* });
* ```
**/
export const Localization = (defaultLocale?: string) => {
const localizer = new ShrimpleLocalizer;
if (defaultLocale) {
localizer.setCurrentLocale(defaultLocale);
}
return localizer as Localizer;
}

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

@@ -0,0 +1,50 @@
export interface Option {
name:string,
type: number,
options?: Array<Option>
}
//Add props[i]_localizations fields to the current item
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
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]);
}
}

3
packages/localizer/metadata.json Normal file
View File

@@ -0,0 +1,3 @@
{
"type": "service"
}

26
packages/localizer/package.json Normal file
View File

@@ -0,0 +1,26 @@
{
"name": "@sern/localizer",
"version": "1.1.0",
"description": "Localizer",
"main": "dist/index.js",
"scripts": {
"build": "tsc",
"watch": "tsc --watch",
"test": "vitest"
},
"dependencies": {
"shrimple-locales": "^0.2.1"
},
"devDependencies": {
"@sern/handler": "^3.3.0",
"discord.js": "^14.15.3",
"vitest": "^1.2.2"
},
"keywords": [],
"author": "",
"license": "ISC",
"publishConfig": {
"access": "public",
"tag": "alpha"
}
}

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

@@ -0,0 +1,102 @@
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(() => true) } };
const path = ['root'];
dfsApplyLocalization(items, deps, path);
expect(items).to.deep.equal([
{
name: 'item1',
type: 1,
options: [{ type: 3, name: 'subItem1', name_localizations: true, description_localizations: true }],
name_localizations: true,
description_localizations: true
},
])
});
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);
expect(items).to.deep.equal([
{
name: 'item1',
name_localizations: 'a',
description_localizations: 'a',
//@ts-ignore
choices: [{ name: 'choice1', name_localizations: 'a' },
{ name: 'choice2', name_localizations: 'a' }],
}
])
});
});

113
packages/localizer/tsconfig.json Normal file
View File

@@ -0,0 +1,113 @@
{
"files": [
"./index.ts",
"./internal.ts"
],
"compilerOptions": {
/* Visit https://aka.ms/tsconfig to read more about this file */
/* Projects */
// "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
// "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */
// "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */
// "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */
// "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */
// "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */
/* Language and Environment */
"target": "ESNext", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
// "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
// "jsx": "preserve", /* Specify what JSX code is generated. */
// "experimentalDecorators": true, /* Enable experimental support for legacy experimental decorators. */
// "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
// "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
// "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
// "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
// "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
// "noLib": true, /* Disable including any library files, including the default lib.d.ts. */
// "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */
// "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */
/* Modules */
"module": "CommonJS", /* Specify what module code is generated. */
// "rootDir": "./", /* Specify the root folder within your source files. */
"moduleResolution": "node", /* Specify how TypeScript looks up a file from a given module specifier. */
// "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
// "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
// "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
// "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */
// "types": [], /* Specify type package names to be included without being referenced in a source file. */
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
// "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */
// "allowImportingTsExtensions": true, /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
// "resolvePackageJsonExports": true, /* Use the package.json 'exports' field when resolving package imports. */
// "resolvePackageJsonImports": true, /* Use the package.json 'imports' field when resolving imports. */
// "customConditions": [], /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
// "resolveJsonModule": true, /* Enable importing .json files. */
// "allowArbitraryExtensions": true, /* Enable importing files with any extension, provided a declaration file is present. */
// "noResolve": true, /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
/* JavaScript Support */
"allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
// "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */
// "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
/* Emit */
"declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
// "declarationMap": true, /* Create sourcemaps for d.ts files. */
// "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */
// "sourceMap": true, /* Create source map files for emitted JavaScript files. */
// "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */
// "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
"outDir": "./dist", /* Specify an output folder for all emitted files. */
// "removeComments": true, /* Disable emitting comments. */
// "noEmit": true, /* Disable emitting files from a compilation. */
// "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
// "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */
// "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
// "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
// "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */
// "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
// "newLine": "crlf", /* Set the newline character for emitting files. */
// "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
// "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */
// "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */
// "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */
// "declarationDir": "./", /* Specify the output directory for generated declaration files. */
// "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
/* Interop Constraints */
// "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */
// "verbatimModuleSyntax": true, /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
// "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
"esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
// "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
"forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */
/* Type Checking */
"strict": true, /* Enable all strict type-checking options. */
// "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */
// "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */
// "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
// "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
// "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */
// "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */
// "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */
// "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */
// "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */
// "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */
// "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
// "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */
// "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */
// "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */
// "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */
// "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */
// "allowUnusedLabels": true, /* Disable error reporting for unused labels. */
// "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */
/* Completeness */
// "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
"skipLibCheck": true /* Skip type checking all .d.ts files. */
}
}

2888
yarn.lock
View File

File diff suppressed because it is too large Load Diff