EmojiToText 1.6.0

EmojiToText

Features

• Convert emojis to descriptive text.
• Convert text back into emojis.
• XUnit tests are implemented
• Supports the latest Unicode version 16.0

Installation

Install the package via NuGet:

dotnet add package EmojiToText

Or install it via Visual Studio NuGet package manager

Usage

Example usecases

• Accessibility: Convert emojis to text for screen readers, improving content accessibility.
• Text Processing: Enhance sentiment analysis or content moderation by converting emojis to readable text.
• Debugging: Simplify logs with emojis by converting them to descriptive text for easier analysis.

Emoji to Text

using EmojiToText;

class Program
{
    static void Main(string[] args)
    {
        // Use this if your console does not support UTF-8
        Console.OutputEncoding = System.Text.Encoding.UTF8;

        string input = "Hello 😀!";
        string result = EmojiConverter.ToText(input);
        Console.WriteLine(result);  // Output: Hello grinning face!
    }
}

Text To Emoji

using EmojiToText;

class Program
{
    static void Main(string[] args)
    {
        // Use this if your console does not support UTF-8
        Console.OutputEncoding = System.Text.Encoding.UTF8;

        string text = "grinning face";
        string emoji = EmojiConverter.ToEmoji(text);
        Console.WriteLine(emoji);  // Output: 😀
    }
}

Running Tests

First clone the repository:

git clone https://github.com/MeritonAliu/EmojiToText.git

To run the tests for this project, use the following command:

dotnet test

Roadmap

The roadmap can be fount at: ROADMAP

Benchmarks

The following benchmarks apply to the current EmojiConverter methods. The mutlitple benchmarks are done with 1000 emojis/texts.

If you want to benchmark it yourself, clone the repo and use:

dotnet run --project Benchmark/EmojiToText.Benchmarks.csproj -c Release

References

• Emoji List
• XUnit
• BenchmarkDotNet

Author

@MeritonAliu - 2024

Contributing

Bug reports and contributions are welcome! Feel free to submit pull requests or file issues.

License

• The main project is licensed under the MIT License.
• Emoji data is governed by the Unicode License.

Donation

If you want to support me and my work, feel free to donate a coffee