Skip to content

Commit

Permalink
update description
Browse files Browse the repository at this point in the history
  • Loading branch information
idleberg committed Jun 8, 2024
1 parent 860ce3e commit 47ae424
Show file tree
Hide file tree
Showing 5 changed files with 2,042 additions and 41 deletions.
30 changes: 13 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
[![Open VSX Downloads](https://img.shields.io/open-vsx/dt/idleberg/emoji-code?style=for-the-badge&label=Open%20VSX)](https://open-vsx.org/extension/idleberg/emoji-code)
[![Build](https://img.shields.io/github/actions/workflow/status/idleberg/vscode-emoji-code/default.yml?style=for-the-badge)](https://github.com/idleberg/vscode-emoji-code/actions)

Snippets to insert escaped Emoji code into a variety of languages, including:
Isnsert escaped Emoji code into a variety of languages, including:

- C#
- CSS
Expand All @@ -14,23 +14,18 @@ Snippets to insert escaped Emoji code into a variety of languages, including:
- JSON
- JavaScript
- Laravel Blade
- Less
- LiveScript
- Markdown
- Python
- React
- RMarkdown
- Ruby
- SCSS
- Svelte
- Twig
- TypeScript
- Vue

This package is also available for [Atom](https://github.com/idleberg/atom-emoji-code) and [Sublime Text](https://github.com/idleberg/sublime-emoji-code).

![Screenshot](https://raw.github.com/idleberg/vscode-emoji-code/main/resources/screenshot.gif)

*Screenshot nicked from the Atom package, but you get the idea*

## Installation

### Extension Marketplace
Expand Down Expand Up @@ -86,22 +81,23 @@ yarn || npm install

### Usage

All emojis are prefixed with `ji`, following the string of the official [Unicode terminology](http://unicode.org/Public/emoji/3.0/emoji-sequences.txt).
As of version v0.13, the `Emoji Code: Open Palette` command is exposed. This allows you picking an emoji by its name or tags.

**Examples:**

Let's say, you want to insert the 😄 emoji

* HTML: `ji:grinning-face` becomes `😀`
* CSS: `ji:grinning-face` becomes `content: '\1F600';`
* JavaScript: `ji:grinning-face` becomes `\u{1F600}`
* Markdown: `ji:grinning-face` inserts the emoji itself¹
* Python: `ji:grinning-face` becomes `\U0001F600`
* Ruby: `ji:grinning-face` becomes `\u{1F600}`
* HTML: `grinning face` becomes `😀`
* CSS: `grinning face` becomes `content: '\1F600';`
* JavaScript: `grinning face` becomes `\u{1F600}`
* Markdown: `grinning face` inserts the emoji itself
* Python: `grinning face` becomes `\U0001F600`
* Ruby: `grinning face` becomes `\u{1F600}`

¹ requires `editor.quickSuggestions` set to true for Markdown files
## Related

Keep in mind that Visual Studio Code supports fuzzy completion, inviting you to use abbreviations of your preference.
- [Atom](https://github.com/idleberg/atom-emoji-code)
- [Sublime Text](https://github.com/idleberg/sublime-emoji-code)

## License

Expand Down
14 changes: 9 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "emoji-code",
"displayName": "Emoji Code",
"description": "Snippets to insert escaped Emoji code into a variety of languages",
"description": "Insert escaped Emoji code into a variety of languages",
"version": "0.12.3",
"publisher": "idleberg",
"license": "MIT",
Expand All @@ -11,13 +11,14 @@
},
"scripts": {
"compile": "npm run build",
"build": "tsup",
"dev": "npm run start",
"build": "npm-run-all --parallel build:*",
"build:lib": "tsup",
"build:resources": "gulp",
"dev": "tsup --watch",
"fix": "eslint --fix ./src",
"lint:ts": "eslint ./src",
"lint": "npm-run-all --parallel lint:*",
"lint": "npm-run-all --parallel lint:*",
"prepare": "husky",
"start": "npm run build -- --watch",
"test": "npm run lint",
"vscode:prepublish": "npm run build"
},
Expand Down Expand Up @@ -68,6 +69,9 @@
"@typescript-eslint/parser": "^7.1.1",
"eslint": "9.1.1",
"eslint-plugin-jsonc": "^2.13.0",
"gulp": "^5.0.0",
"gulp-raster": "^0.2.0",
"gulp-rename": "^2.0.0",
"husky": "^9.0.11",
"lint-staged": "^15.2.2",
"npm-run-all2": "^6.1.2",
Expand Down
Loading

0 comments on commit 47ae424

Please sign in to comment.