Skip to content

morkro/atom-emoji-syntax

Repository files navigation

Emoji Syntax

Build Status devDependencies Maintenance

Getting bored of your code? Already tried out hundreds of syntax highlighter but always felt something is missing?

Emoji Syntax is what you need!

An atom package adding emoji to language keywords.

Installation

Install Emoji Syntax either via apm

apm install emoji-syntax

or search for emoji syntax in your Atom settings panel.

Features 🔥

  • Emoji-Syntax is on top of your syntax theme; you can still choose any theme you like
  • Choose between four different emoji styles
  • Change existing keywords with any emoji you want
  • Define position and spacing of an emoji around the keyword
  • Disable entire languages or only specific keywords

This package does not actually add emoji characters to your code—don't worry—your linter or tests won't go crazy!

Supported Languages 🎤

Only official language packages are supported. Other language packages might use different selectors to highlight syntax and not work as intended.

Language Preview
JavaScript JavaScript
TypeScript TypeScript
CSS CSS
Sass SCSS
PHP PHP
Python Python

Icon Sets

Note: not all emoji are supported in each of the custom sets yet!

Emoji style Preview
Native Native
Twemoji Twemoji
Noto Emoji Noto Emoji
EmojiOne™ EmojiOne™

Settings 🔧

Name Default Options
Emoji Style: Lets you choose between different emoji icon sets Native Native, Twemoji, Noto Emoji, Emoji One

Emoji Settings Page 🔧

Emoji Syntax comes with its own settings page. There you can customise, activate and deactivate every emoji for each language. The settings page is available through Packages > Emoji Syntax > Settings or the emoji-syntax:settings command.

Emoji Settings Page

Each language has its own section which you can deactivate. Doing that, the entire language won't have any emoji. The following options are available:

  • Emoji: opens a modal of emoji to choose from
  • Position: the position of the emoji around the keyword (e.g. 📦 import or import 📦 )
  • Spacing: adds spacing between emoji and keyword (e.g. function 🔧 () {} or function🔧 () {})

Contribution 👪

If you want to contribute by either extending/improving a language set, adding a new language, fixing a bug or anything else you can do that by simply sending a pull request.

API documentation via Doclets.

License ©️

The code is available under MIT License.

Emoji graphics