Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jcs-elpa/company-emojify
Company completion for Emojify
https://github.com/jcs-elpa/company-emojify
company emacs emoji emojify
Last synced: about 2 months ago
JSON representation
Company completion for Emojify
- Host: GitHub
- URL: https://github.com/jcs-elpa/company-emojify
- Owner: jcs-elpa
- License: gpl-3.0
- Created: 2021-07-16T06:51:26.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-07-21T09:34:23.000Z (6 months ago)
- Last Synced: 2024-08-07T18:30:51.219Z (5 months ago)
- Topics: company, emacs, emoji, emojify
- Language: Emacs Lisp
- Homepage:
- Size: 69.3 KB
- Stars: 10
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.gnu.org/licenses/gpl-3.0)
[](https://melpa.org/#/company-emojify)
[](https://stable.melpa.org/#/company-emojify)
# company-emojify
> Company completion for Emojify
[](https://github.com/jcs-elpa/company-emojify/actions/workflows/test.yml)
**Table of Contents**
- [company-emojify](#company-emojify)
- [🏆 Features](#🏆-features)
- [💾 Quickstart](#💾-quickstart)
- [🔨 Configuration](#🔨-configuration)
- [-](#-)
- [🔍 `company-emojify-emoji-styles`](#🔍-company-emojify-emoji-styles)
- [🔍 `company-emojify-annotation`](#🔍-company-emojify-annotation)
- [🔍 `company-emojify-document`](#🔍-company-emojify-document)
- [❓ FAQ](#❓-faq)
- [-](#--1)
- [💫 How to add more emoji?](#💫-how-to-add-more-emoji)
- [🛠️ Contribute](#🛠️-contribute)
- [🔬 Development](#🔬-development)
- [⚜️ License](#⚜️-license)
## 🏆 Features
* Uses [emojify](https://github.com/iqbalansari/emacs-emojify)
* Support both `unicode` and `image` displays
## 💾 Quickstart
```el
(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
```el
(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](https://github.com/dunn/company-emoji)?
`company-emoji` is more lightweight and does not require [emojify](https://github.com/iqbalansari/emacs-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](https://github.com/dunn/company-emoji/blob/trunk/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
[](http://makeapullrequest.com)
[](https://github.com/bbatsov/emacs-lisp-style-guide)
[](https://www.paypal.me/jcs090218)
[](https://www.patreon.com/jcs090218)
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](https://emacs-eask.github.io/)
- [Make](https://www.gnu.org/software/make/) (optional)
Install all dependencies and development dependencies:
```sh
$ eask install-deps --dev
```
To test the package's installation:
```sh
$ eask package
$ eask install
```
To test compilation:
```sh
$ eask compile
```
**🪧 The following steps are optional, but we recommend you follow these lint results!**
The built-in `checkdoc` linter:
```sh
$ eask lint checkdoc
```
The standard `package` linter:
```sh
$ 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 .
See [`LICENSE`](./LICENSE.txt) for details.