README.md

company-emojify

Company completion for Emojify

Table of Contents

• company-emojify
  • 🏆 Features
  • 💾 Quickstart
  • 🔨 Configuration
    • -
    • 🔍 company-emojify-emoji-styles
    • 🔍 company-emojify-annotation
    • 🔍 company-emojify-document
  • ❓ FAQ
    • -
    • 💫 How to add more emoji?
  • 🛠️ Contribute
    • 🔬 Development
  • ⚜️ License

🏆 Features

• Uses emojify
• Support both unicode and image displays

💾 Quickstart

(require 'company-emojify)
(add-to-list 'company-backends 'company-emojify)

🔨 Configuration

🔍 company-emojify-insert-unicode

Replace the :shortcode: with the real Unicode character upon completion.

🔍 company-emojify-emoji-styles

Display these emoji styles as candidates, default to '(ascii unicode github).

If you want to limit to a certain style, you can do the following

(setq company-emojify-emoji-styles '(github))  ; Show only the `github` style

See emojify-emoji-styles for more information.

🔍 company-emojify-annotation

Option to display emoji in annotation. It can either be one of the following values,

• nil
• unicode
• image (default)

Notice, it will display unicode if you are in non-graphical environment (terminal).

🔍 company-emojify-document

Display information about the emoji in document buffer, default to t.

❓ FAQ

💫 How is this different from company-emoji?

company-emoji is more lightweight and does not require emojify. However, it does not support display with emoji images. company-emoji would work on its own since it declares its emoji list in company-emoji-list.el. This package reuses the code from emojify hence this would be a better choice if you already have emojify installed.

💫 How to add more emoji?

Unlike company-emoji has specify it's own emoji list. Since we rely on package emojify, please consider contribute to the upstream.

🛠️ Contribute

If you would like to contribute to this project, you may either clone and make pull requests to this repository. Or you can clone the project and establish your own branch of this tool. Any methods are welcome!

🔬 Development

To run the test locally, you will need the following tools:

• Eask
• Make (optional)

Install all dependencies and development dependencies:

$ eask install-deps --dev

To test the package's installation:

$ eask package
$ eask install

To test compilation:

$ eask compile

🪧 The following steps are optional, but we recommend you follow these lint results!

The built-in checkdoc linter:

$ eask lint checkdoc

The standard package linter:

$ eask lint package

📝 P.S. For more information, find the Eask manual at https://emacs-eask.github.io/.

⚜️ License

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.

See LICENSE for details.