@nodesecure/i18n

Internationalization (i18n) utilities for NodeSecure tools like CLI.

Supported languages:

• french
• english

Requirements

• Node.js v18 or higher

Getting Started

This package is available in the Node Package Repository and can be easily installed with npm or yarn.

$ npm i @nodesecure/i18n
# or
$ yarn add @nodesecure/i18n

Usage example

import * as i18n from "@nodesecure/i18n";

await i18n.setLocalLang("french");

console.log(i18n.getToken("cli.executing_at"));

// Using parameters
console.log(i18n.getToken("cli.min_nodejs_version", "14"));

You can consult the real use case of the API in the following codes: here and here.

API

See TypeScript definition file.

type languages = "french" | "english";

export function getLocalLang(): Promise<languages>;
export function setLocalLang(newLanguage: languages): Promise<void>;
export function getToken(token: string, ...parameters): Promise<string>;
export function getTokenSync(token: string, ...parameters): string;
export function getLanguages(): Promise<languages[]>;
export function taggedString(str: string, ...keys: any[]): (...keys: any[]) => string;
export function extend(language: string, tokens: Record<string, any>): void;
export function extendFromSystemPath(path: string): Promise<void>;

[!NOTE] Local lang must be updated otherwise getTokenSync() will throws. Make sure to use await i18n.getLocalLang() before any synchronous usage.

Generate documentation

You can generate a static webpage by using the build:documentation npm script:

$ npm run build:documentation

Contributing

Feel free to add a new language. You need to take inspiration from the two supported languages and replicate the same keys.

Then export it in the index.js file (example if we want to add a chinese translation).

export * as chinese  from "./chinese.js";

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Gentilhomme 💻 📖 👀 🛡️ 🐛	Nicolas Hallaert 📖	Quentin Lepateley 📖	Antoine Neff 🌍	Kévin VOYER 🌍	Alexandre Malaj 🌍	Vincent Dhennin 💻 📖
Mathieu 💻 🌍	Antoine Coulon 🚧 👀	im_codebreaker 💻 📖 🎨	PierreDemailly 💻 🌍	Kouadio Fabrice Nguessan 💻	Ayushmaan Shrotriya 📖	Inès & Mélu 📖

License

MIT