emojilib

README

📖 emojilib

The Emoji keyword library by @muan ported to Go. (using go generate)

Installation

go get -u github.com/peterhellberg/emojilib

Usage

package main

import (
	"fmt"

	"github.com/peterhellberg/emojilib"
)

func main() {
	fmt.Println(emojilib.ReplaceWithPadding("I :green_heart: You!"))
}

Generating a new version

$ go generate

This will download the latest version of emojis.json and generate a new version of generated.go

You’ll need to have the golang.org/x/tools/imports package installed in order to run the generator.

License (MIT)

Copyright (c) 2015-2019 Peter Hellberg

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Documentation

Overview

Package emojilib is a port of the Emoji keyword library to Go

Installation

Just go get the package:

go get -u github.com/peterhellberg/emojilib

Usage

A small usage example

package main

import (
	"fmt"

	"github.com/peterhellberg/emojilib"
)

func main() {
	fmt.Println(emojilib.ReplaceWithPadding("I :green_heart: You!"))
}

Index

• Variables
• func Replace(s string) string
• func ReplaceWithPadding(s string) string
• type Emoji
  • func Find(n string) (Emoji, error)
  • func Keyword(k string) ([]Emoji, error)
• type Emojis
  • func All() Emojis

Variables

var ErrUnknownEmoji = errors.New("unknown emoji")

ErrUnknownEmoji is returned from Find if provided with a unknown emoji name

var ErrUnknownKeyword = errors.New("unknown keyword")

ErrUnknownKeyword is returned from Keyword if provided with a unknown keyword

Functions

func Replace

func Replace(s string) string

Replace takes a string and replaces all emoji names with their emoji character

func ReplaceWithPadding

func ReplaceWithPadding(s string) string

ReplaceWithPadding takes a string and replaces all emoji names with their emoji character and a space in order to display better in terminals

Types

type Emoji

type Emoji struct {
	Keywords []string `json:"keywords"`
	Char     string   `json:"char"`
	Category string   `json:"category"`
}

Emoji contains the keywords, char and category for an emoji

func Find

func Find(n string) (Emoji, error)

Find returns an Emoji if provided with a known name

func Keyword

func Keyword(k string) ([]Emoji, error)

Keyword returns Emojis for the given keyword

type Emojis

type Emojis map[string]Emoji

Emojis contain emojis keyed on their name

func All

func All() Emojis

All returns all the emojis