1.0.0 β€’ Published 4 months ago

translit-js v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
4 months ago

Transliterate Service for JavaScript Applications

GitHub Actions Status Azure Pipelines Status npm version Gitter

General purpose transliterate service for JavaScript applications which can be used in swapping letters such as Ξ± β†’ a, ၎ β†’ αŽα€„α€Ία€Έ.

Features

  • Can transliterate/convert any script or Unicode letters by using from a simplest rule definition (just with from and to rules) to more powerful rule definition (with tplVar, tplSeq, when, postRules, etc.)
  • Can transliterate input phase by phase
  • Can define template variables with tplVar to reduce JSON size and to avoid repetition
  • Can define template loop sequences with tplSeq for sequential rules checking and replacement
  • Quick test input string checking with quickTests and minLength options for better performance
  • Can check converted left portion string with hasLeft boolean option and left regular expression option
  • Can check right part after matched input string with right regular expression option
  • Conditional rules processing with when and skip options
  • Can define post-rules with postRules for step-by-step conversions
  • Can use postRulesDef and postRulesRef to reduce JSON size and to avoid repetition in defining postRules
  • Conversion trace information can be included in output result for debugging purpose

Getting Started

Installation

npm

npm install @dagonmetric/translit-js

or yarn

yarn add  @dagonmetric/translit-js

Usage (app.component.ts)

import { TranslitRuleItem, translit } from '@dagonmetric/translit-js';

const zg2uniRules: TranslitRuleItem[] = [
  {
    from: '\u103B([\u1000-\u1021])',
    to: '$1\u103C'
  },
  {
    from: '\u1039',
    to: '\u103A'
  }
];

const result = translit('ျမန္မာစာ', zg2uniRules);

// output: မြန်မာစာ
console.log('output: ', result.outputText);

Transliterate Rules

Live Application

  • Zawgyi Unicode Converter - Progress Web Application designed to convert Myanmar font encodings between Zawgyi-One and Standard Myanmar Unicode

For Other Frameworks

Build & Test Tools

We use lib-tools for bundling, testing and packaging our library projects.

Lib Tools

Feedback and Contributing

Check out the Contributing page.

License

This repository is licensed with the MIT license.