romanize 0.0.1

romanize: ^0.0.1 copied to clipboard

A powerful Dart package for seamlessly converting multilingual text into its Romanized form.

Features #

• 🌏 Multi-language support: Korean, Japanese, Chinese, Cyrillic, and Arabic
• 🔍 Auto-detection: Automatically detects the languages present in the input text
• 🛠️ Flexible & extensible: Easily create your own custom romanizer for any language or writing system
• 📦 Lightweight: Minimal dependencies, fast performance

Installation #

Add romanize to your pubspec.yaml:

dependencies:
  romanize: ^0.0.1

Then run:

dart pub get

Usage #

Import the package:

import 'package:romanize/romanize.dart';

Romanize Text #

The romanize method automatically detects and romanizes each word separately, making it perfect for multi-language text:

// Multi-language text - each word is detected and romanized independently
final text = '你好 Hello 안녕';
final romanized = TextRomanizer.romanize(text);
print(romanized); // ni hao Hello annyeong

// Single language text also works
final koreanText = '안녕하세요';
final koreanRomanized = TextRomanizer.romanize(koreanText);
print(koreanRomanized); // annyeonghaseyo

It will fail to detect multiple languagues if they are not separated by spaces.

Detect Language #

Detect the first language present in the text:

final romanizer = TextRomanizer.detectLanguage('안녕하세요');
print(romanizer.language); // korean

Or detect all languages present in the text:

final romanizers = TextRomanizer.detectLanguages('안녕 Hello 你好 Привет мир');
print(romanizers.map((r) => r.language)); // {korean, chinese, cyrillic}

Specify Language #

You can also specify the language explicitly using the forLanguage method:

final japaneseText = 'こんにちは';
final japaneseRomanizer = TextRomanizer.forLanguage('japanese');
print(japaneseRomanizer.romanize(japaneseText)); // konnichiwa

Or you can instantiate the romanizer directly:

final chineseText = '你好';
final chineseRomanizer = ChineseRomanizer(toneAnnotation: ToneAnnotation.mark);
print(chineseRomanizer.romanize(chineseText)); // nǐ hǎo

Some romanizers have additional options. For example, the ChineseRomanizer has the toneAnnotation option to specify the tone annotation to use.

Supported Languages #

• Korean (한국어)
• Japanese (日本語) - Using kana_kit for Kana conversion
• Chinese (中文) - Using pinyin for Pinyin conversion (Simplified and Traditional)
• Cyrillic (Кириллица) - Custom transliteration for Russian, Ukrainian, Serbian, and more
• Arabic (العربية) - Custom transliteration based on ISO 233 and DIN 31635

API Reference #

TextRomanizer #

Main class for romanizing text.

Static Methods

• romanize(String input) - Processes each word separately, auto-detecting and romanizing each word. Perfect for multi-language text.
• detectLanguage(String input) - Detects the first matching language and returns the corresponding Romanizer. Returns EmptyRomanizer if no match is found.
• detectLanguages(String input) - Detects all matching languages and returns a Set<Romanizer>. Returns empty set if no matches are found.
• forLanguage(String language) - Returns a Romanizer for the specified language. Throws UnimplementedError if not found.
• forLanguageOrNull(String? language) - Returns a Romanizer? for the specified language, or null if not found.
• supportedLanguages - Returns a list of all supported language names.

Romanizer #

Interface for language-specific romanizers.

• language - The language name (e.g., 'korean', 'japanese', 'arabic')
• isValid(String input) - Checks if the input is valid for this romanizer
• romanize(String input) - Converts the input to Romanized form

Example #

See the example directory for a complete example.

Contributing #

Contributions are welcome! Please feel free to submit a Pull Request.

Creating a Custom Romanizer #

To create a custom romanizer for a new language or writing system, you can extend the Romanizer class and implement the romanize and isValid methods.

class EmojiRomanizer extends Romanizer {
  const EmojiRomanizer() : super(language: 'emoji');

  static const Map<String, String> _transliterationMap = {
    '👋': 'wave',
    '🌍': 'earth',
    '🚀': 'rocket',
    '🎉': 'party',
  };

  @override
  bool isValid(String input) {
    return RegExp(r'[\uD800-\uDBFF][\uDC00-\uDFFF]').hasMatch(input);
  }

  @override
  String romanize(String input) {
    final buffer = StringBuffer();
    for (final char in input.runes) {
      final charString = String.fromCharCode(char);
      if (isValid(charString)) {
        if (_transliterationMap.containsKey(charString)) {
          buffer.write(':${_transliterationMap[charString]}:');
        } else {
          buffer.write(':$charString:');
        }
      } else {
        buffer.write(charString);
      }
    }
    return buffer.toString();
  }
}

Then you can use your custom romanizer like this:

final emojiText = '👋 🌍 🚀 🎉 💜';
final emojiOutput = EmojiRomanizer().romanize(emojiText);
print('Emoji Romanization: \n$emojiOutput'); // :wave: :earth: :rocket: :party: :💜: