Swiftpack.co - RISCfuture/Slackmoji as Swift Package

Swiftpack.co is a collection of thousands of indexed Swift packages. Search packages.
See all packages published by RISCfuture.
RISCfuture/Slackmoji 1.1.0
A simple Swift library that converts between emoji and Slack shortcodes
⭐️ 0
🕓 2 weeks ago
macOS
.package(url: "https://github.com/RISCfuture/Slackmoji.git", from: "1.1.0")

Slackmoji

This library is a shortcode-to-Unicode converter for Slack emoji. It is able to convert between (e.g.) :heart: and ❤️. Note that Slack shortcodes can be different from shortcodes used by other software such as GitHub.

Requirements

This library requires Swift Package Manager v5.3 or newer, since it uses bundled resources.

Usage

Simply include this repository in your Package.swift file and mark it as a dependency for your project. That will give you access to two functions:

import Slackmoji

let slackmoji = Slackmoji()
slackmoji.shortcodeToEmoji("heart") //-> ["❤️"]
slackmoji.emojiToShortcodes("❤️") //-> ["heart"]

Note that adding/removing the leading and trailing colons is your responsibility.

The plist data files

Slackmoji shortcodes are generated from this repository, which is included as a submodule. The Build Shortcode Plist file is an executable target that parses the emoji-data/build/data_emoji_names*.txt files and generates the property list file that is included as a bundled resource for this library.

To regenerate this plist file, simply run the Build Shortcode Plist target from the project root directory.

GitHub

link
Stars: 0
Last commit: 2 weeks ago
jonrohan Something's broken? Yell at me @ptrpavlik. Praise and feedback (and money) is also welcome.

Dependencies

Swiftpack is being maintained by Petr Pavlik | @ptrpavlik | @swiftpackco | API | Analytics