Skip to content
This repository has been archived by the owner on Nov 6, 2022. It is now read-only.

Latest commit

 

History

History
78 lines (49 loc) · 2.97 KB

README.md

File metadata and controls

78 lines (49 loc) · 2.97 KB

npm package Build Status Code style Dependencies DevDependencies Test Coverage

Toba Say

http://targetveb.com/i18n-components-stenciljs.html https://dockyard.com/blog/2019/04/16/lazy-loading-custom-assets-with-stenciljs-part-1

A translation and localization library designed to optimize developer and translator ergonomics.

Developers

Leverage the ECMA-402 Internationalization API built into all modern browsers so verbose and complex logic, like plural rules,

Translations are defined in TypeScript files (.ts) to enable autocomplete and validation while editing.

export default {
   [Phrase.AccountBalance]: `Hello {name}, you have {balance, number, currency} in your bank account.`,
   [Label.Save]: 'Save'
} as { [key: string]: string };

Performance

Instead of parsing to an Abstract Syntax Tree, messages are parsed and cached directly as format functions.

Verification

Report tool flags translation literals that fail to parse and indicates how many translation phrases exist in the default language that aren't expressed in the other translation files.

Running a report

$ npx say-report ./locales

Unit testing

The output of the standard report can be made a unit test with an expect

import { reporter } from '@toba/say';

test('translations are valid', () => {
   expect(reporter('path').toBe('good');
});

Translators

Uses the International Components for Unicode (ICU) Message Syntax

This is a versatile syntax supported by the most popular translation services.

It is the format utilized by the ubiquitous FormatJS library

Import and Export

The development format is standard ICU Message Syntax. To

License

Copyright © 2019 Jason Abbott

This software is licensed under the MIT license. See the LICENSE file accompanying this software for terms of use.