@sefinek/random-emoji 0.1.0 → 1.2.0

package/CHANGELOG.md

@@ -0,0 +1,19 @@
+## 📥・v1.2.0 (12.05.2022)
+1. Updated CHANGELOG.md, README.md and package.json.
+2. Added new function `circles()` with random circles.
+3. Removed `.slashes`.
+
+## 📥・v1.1.1 (11.05.2022)
+1. Added new function `hearts()` with random hearts.
+
+## 📥・v1.0.1 (08.05.2022)
+1. Added new function `cats()` with random cat emojis.  
+2. Added **CHANGELOG.md** file.  
+2. Changes:
+```diff
+- emoji()
++ emojis()
+```
+
+## 📥・v0.1.0 (07.05.2022)
+First release.

package/README.md

@@ -1,20 +1,61 @@
-## ⭐ » Information
-Returns a random emoticon and its name and type. 🐈 🐱 🙀
+<div align="center">
+    <h1>About this package</h1>
+    <p>Returns a random emoticon, its name and type. 🐱 🙀 ❤️</p>
+    <a href="https://www.npmjs.com/package/@sefinek/random-emoji" target="_blank" title="random-emoji - npm" style="text-decoration:none">
+        <img src="https://img.shields.io/npm/dt/@sefinek/random-emoji.svg?maxAge=3600" alt="The number of downloads">
+        <img src="https://img.shields.io/github/issues/sefinek24/random-emoji" alt="Issues">
+        <img src="https://img.shields.io/github/last-commit/sefinek24/random-emoji" alt="Last commit">
+        <img src="https://img.shields.io/github/commit-activity/w/sefinek24/random-emoji" alt="Commit activity">
+        <img src="https://img.shields.io/github/languages/code-size/sefinek24/random-emoji" alt="Code size">
+        <img src="https://img.shields.io/tokei/lines/github/sefinek24/random-emoji" alt="Total lines">
+    </a>
+</div>
 
-## 📥 » How to install?
+## 📥 • Installation
 > **$** npm install @sefinek/random-emoji
 
-## 📝 » Examples
+## 😼 • Examples
 ```js
 const random = require('@sefinek/random-emoji');
 
-// emoji()
-const { name, content, type } = random.emoji();
-console.log(`Name: ${name}; Type: ${type}; Emoji: ${content};`); // Name: Cat Face; Type: animal; Emoji: 🐱;
+// 1. A single emote
+console.log(unicode());
+// > 🥰
 
-// unicode()
-console.log(random.unicode()); // 🥰
+// 2. Random emoji with name and type
+const emoji = random.emojis();
+console.log(`Name: ${emoji.name}; Emoji: ${emoji.content};`);
+// > Name: Cat Face; Type: animal; Emoji: 🐱;
+
+// 3. Random cat
+const cat = random.cats();
+console.log(`Name: ${cat.name}; Emoji: ${cat.content};`);
+// > Name: smiley_cat; Emoji: 😺;
+
+// 4. Random heart
+const heart = random.hearts();
+console.log(`Name: ${heart.name}; Emoji: ${heart.content};`);
+// > Name: blue_heart; Emoji: 💙;
+
+// 5. Random circle
+const circle = random.circles();
+console.log(`Name: ${heart.name}; Emoji: ${heart.content};`);
+// > Name: blue_circle; Emoji: 🔵;
 ```
 
-## 🤝 » Help
-Open new <a href="https://github.com/sefinek24/random-emoji/issues/new/choose" target="_blank">Issue</a> on Github.
+## 😻 • Usage
+```js
+emojis()  // Random emoji with name and type
+unicode() // A single emote
+cats()    // Return random cat
+hearts()  // Return random heart
+circles() // Return random circle
+```
+
+## 📝 • Changelog
+> <a href="https://github.com/sefinek24/random-emoji/blob/main/CHANGELOG.md" target="_blank" title="random-emoji/CHANGELOG.md at main · sefinek24/random-emoji">https://github.com/sefinek24/random-emoji/blob/main/CHANGELOG.md</a>
+
+## 🤝 • Help
+Open new <a href="https://github.com/sefinek24/random-emoji/issues/new/choose" target="_blank">Issue</a> on Github.  
+  
+### Thank you ❤️

package/index.js

@@ -1,5 +1,11 @@
-const { emojis } = require('./json/emoji.json');
+const emojis = require('./json/emojis.json');
 const unicode = require('./json/unicode.json');
+const cats = require('./json/cats.json');
+const hearts = require('./json/hearts.json');
+const circles = require('./json/circles.json');
 
-exports.emoji = () => emojis[Math.floor(Math.random() * emojis.length)];
-exports.unicode = () => unicode[Math.floor(Math.random() * unicode.length)];
+exports.emojis = () => emojis[Math.floor(Math.random() * emojis.length)];
+exports.unicode = () => unicode[Math.floor(Math.random() * unicode.length)];
+exports.cats = () => cats[Math.floor(Math.random() * cats.length)];
+exports.hearts = () => hearts[Math.floor(Math.random() * hearts.length)];
+exports.circles = () => circles[Math.floor(Math.random() * circles.length)];

package/json/cats.json

@@ -0,0 +1 @@
+[{"content":"😺","name":"smiley_cat"},{"content":"😸","name":"smile_cat"},{"content":"😹","name":"joy_cat"},{"content":"😻","name":"heart_eyes_cat"},{"content":"😼","name":"smirk_cat"},{"content":"😽","name":"kissing_cat"},{"content":"🙀","name":"scream_cat"},{"content":"😿","name":"crying_cat_face"},{"content":"😾","name":"pouting_cat"},{"content":"🐱","name":"cat"},{"content":"🐈","name":"cat2"},{"content":"🐈‍⬛","name":"black_cat"}]

package/json/circles.json

@@ -0,0 +1 @@
+[{"content":"🔴","name":"red_circle"},{"content":"🟠","name":"orange_circle"},{"content":"🟡","name":"yellow_circle"},{"content":"🟢","name":"green_circle"},{"content":"🔵","name":"blue_circle"},{"content":"🟣","name":"purple_circle"},{"content":"🟤","name":"brown_circle"},{"content":"⚫","name":"black_circle"},{"content":"⚪","name":"white_circle"}]

package/json/emojis.json

@@ -0,0 +1 @@
+[{"name":"smiling face","content":"😀","type":"smiley"},{"name":"tears of joy","content":"😂","type":"smiley"},{"name":"winking face","content":"😉","type":"smiley"},{"name":"rofl","content":"🤣","type":"smiley"},{"name":"smiling face with halo","content":"😇","type":"smiley"},{"name":"beaming face","content":"😁","type":"smiley"},{"name":"Upside-Down Face","content":"🙃","type":"smiley"},{"name":"Sleepy Face","content":"😪","type":"smiley"},{"name":"Smiling Face with Sunglasses","content":"😎","type":"smiley"},{"name":"Nerd Face","content":"🤓","type":"smiley"},{"name":"Weary Face","content":"😩","type":"smiley"},{"name":"burger","content":"🍔","type":"food"},{"name":"Grapes","content":"🍇","type":"food"},{"name":"Melon","content":"🍈","type":"food"},{"name":"Banana","content":"🍌","type":"food"},{"name":"Red Apple","content":"🍎","type":"food"},{"name":"Green Apple","content":"🍏","type":"food"},{"name":"Broccoli","content":"🥦","type":"food"},{"name":"Mushroom","content":"🍄","type":"food"},{"name":"Bread","content":"🍞","type":"food"},{"name":"Pancakes","content":"🥞","type":"food"},{"name":"Pizza","content":"🍕","type":"food"},{"name":"Sandwich","content":"🥪","type":"food"},{"name":"Ice Cream","content":"🍨","type":"food"},{"name":"Birthday Cake","content":"🎂","type":"food"},{"name":"Pie","content":"🥧","type":"food"},{"name":"Chocolate Bar","content":"🍫","type":"food"},{"name":"Candy","content":"🍬","type":"food"},{"name":"See-No-Evil Monkey","content":"🙈","type":"animal"},{"name":"Hear-No-Evil Monkey","content":"🙉","type":"animal"},{"name":"Dog Face","content":"🐶","type":"animal"},{"name":"Wolf","content":"🐺","type":"animal"},{"name":"Cat Face","content":"🐱","type":"animal"},{"name":"Tiger Face","content":"🐯","type":"animal"},{"name":"Horse Face","content":"🐴","type":"animal"},{"name":"Cow Face","content":"🐮","type":"animal"},{"name":"Hamster","content":"🐹","type":"animal"},{"name":"Dragon","content":"🐉","type":"animal"},{"content":"🎃","name":"jack-o-lantern","type":"Activities"},{"content":"🎄","name":"Christmas tree","type":"Activities"},{"content":"🎆","name":"fireworks","type":"Activities"},{"content":"🎇","name":"sparkler","type":"Activities"},{"content":"🧨","name":"firecracker","type":"Activities"},{"content":"✨","name":"sparkles","type":"Activities"},{"content":"🎈","name":"balloon","type":"Activities"},{"content":"🎉","name":"party popper","type":"Activities"},{"content":"🎊","name":"confetti ball","type":"Activities"},{"content":"🎋","name":"tanabata tree","type":"Activities"},{"content":"🎍","name":"pine decoration","type":"Activities"},{"content":"🎎","name":"Japanese dolls","type":"Activities"},{"content":"🎏","name":"carp streamer","type":"Activities"},{"content":"🎐","name":"wind chime","type":"Activities"},{"content":"🎑","name":"moon viewing ceremony","type":"Activities"},{"content":"🧧","name":"red envelope","type":"Activities"},{"content":"🎀","name":"ribbon","type":"Activities"},{"content":"🎁","name":"wrapped gift","type":"Activities"},{"content":"🎗️","name":"reminder ribbon","type":"Activities"},{"content":"🎟️","name":"admission tickets","type":"Activities"},{"content":"🎫","name":"ticket","type":"Activities"},{"content":"🎖️","name":"military medal","type":"Activities"},{"content":"🏆","name":"trophy","type":"Activities"},{"content":"🏅","name":"sports medal","type":"Activities"},{"content":"🥇","name":"1st place medal","type":"Activities"},{"content":"🥈","name":"2nd place medal","type":"Activities"},{"content":"🥉","name":"3rd place medal","type":"Activities"},{"content":"⚽","name":"soccer ball","type":"Activities"},{"content":"⚾","name":"baseball","type":"Activities"},{"content":"🥎","name":"softball","type":"Activities"},{"content":"🏀","name":"basketball","type":"Activities"},{"content":"🏐","name":"volleyball","type":"Activities"},{"content":"🏈","name":"american football","type":"Activities"},{"content":"🏉","name":"rugby football","type":"Activities"},{"content":"🎾","name":"tennis","type":"Activities"},{"content":"🥏","name":"flying disc","type":"Activities"},{"content":"🎳","name":"bowling","type":"Activities"},{"content":"🏏","name":"cricket game","type":"Activities"},{"content":"🏑","name":"field hockey","type":"Activities"},{"content":"🏒","name":"ice hockey","type":"Activities"},{"content":"🥍","name":"lacrosse","type":"Activities"},{"content":"🏓","name":"ping pong","type":"Activities"},{"content":"🏸","name":"badminton","type":"Activities"},{"content":"🥊","name":"boxing glove","type":"Activities"},{"content":"🥋","name":"martial arts uniform","type":"Activities"},{"content":"🥅","name":"goal net","type":"Activities"},{"content":"⛳","name":"flag in hole","type":"Activities"},{"content":"⛸️","name":"ice skate","type":"Activities"},{"content":"🎣","name":"fishing pole","type":"Activities"},{"content":"🤿","name":"diving mask","type":"Activities"},{"content":"🎽","name":"running shirt","type":"Activities"},{"content":"🎿","name":"skis","type":"Activities"},{"content":"🛷","name":"sled","type":"Activities"},{"content":"🥌","name":"curling stone","type":"Activities"},{"content":"🎯","name":"direct hit","type":"Activities"},{"content":"🪀","name":"yo-yo","type":"Activities"},{"content":"🪁","name":"kite","type":"Activities"},{"content":"🎱","name":"pool 8 ball","type":"Activities"},{"content":"🔮","name":"crystal ball","type":"Activities"},{"content":"🪄","name":"magic wand","type":"Activities"},{"content":"🧿","name":"nazar amulet","type":"Activities"},{"content":"🎮","name":"video game","type":"Activities"},{"content":"🕹️","name":"joystick","type":"Activities"},{"content":"🎰","name":"slot machine","type":"Activities"},{"content":"🎲","name":"game die","type":"Activities"},{"content":"🧩","name":"puzzle piece","type":"Activities"},{"content":"🧸","name":"teddy bear","type":"Activities"},{"content":"🪅","name":"piñata","type":"Activities"},{"content":"🪆","name":"nesting dolls","type":"Activities"},{"content":"♠️","name":"spade suit","type":"Activities"},{"content":"♥️","name":"heart suit","type":"Activities"},{"content":"♦️","name":"diamond suit","type":"Activities"},{"content":"♣️","name":"club suit","type":"Activities"},{"content":"♟️","name":"chess pawn","type":"Activities"},{"content":"🃏","name":"joker","type":"Activities"},{"content":"🀄","name":"mahjong red dragon","type":"Activities"},{"content":"🎴","name":"flower playing cards","type":"Activities"},{"content":"🎭","name":"performing arts","type":"Activities"},{"content":"🖼️","name":"framed picture","type":"Activities"},{"content":"🎨","name":"artist palette","type":"Activities"},{"content":"🧵","name":"thread","type":"Activities"},{"content":"🪡","name":"sewing needle","type":"Activities"},{"content":"🧶","name":"yarn","type":"Activities"},{"content":"🪢","name":"knot","type":"Activities"}]

package/json/hearts.json

@@ -0,0 +1 @@
+[{"content":"💌","name":"love_letter"},{"content":"💝","name":"gift_heart"},{"content":"❣️","name":"heart_exclamation"},{"content":"💔","name":"broken_heart"},{"content":"❤️‍🔥","name":"heart_on_fire"},{"content":"❤️‍🩹","name":"mending_heart"},{"content":"❤️","name":"heart"},{"content":"💛","name":"yellow_heart"},{"content":"💚","name":"green_heart"},{"content":"💙","name":"blue_heart"},{"content":"💜","name":"purple_heart"},{"content":"🤎","name":"brown_heart"},{"content":"🖤","name":"black_heart"},{"content":"🤍","name":"white_heart"},{"content":"🫀","name":"anatomical_heart"},{"content":"💒","name":"wedding"},{"content":"💘","name":"cupid"},{"content":"💗","name":"heartpulse"}]

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@sefinek/random-emoji",
-  "version": "0.1.0",
-  "description": "Returns a random emoticon and its name and type.",
+  "version": "1.2.0",
+  "description": "Returns a random emoticon, its name and type.",
   "main": "index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "node test.js"
   },
   "repository": {
     "type": "git",
@@ -13,12 +13,19 @@
   "keywords": [
     "random",
     "emoji",
+    "emojis",
     "emoticon",
     "unicode",
+    "cat",
+    "cats",
+    "heart",
+    "hearts",
+    "circle",
+    "circles",
     "name",
     "type"
   ],
-  "author": "Sefinek",
+  "author": "Sefinek (https://skiffybot.xyz)",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/sefinek24/random-emoji/issues"

package/test.js

@@ -1,6 +1,20 @@
-const { emoji, unicode } = require('./index.js');
+const { unicode, emojis, cats, hearts, circles } = require('./index.js');
 
-const { name, type, content } = emoji();
-console.log(`Name: ${name}; Type: ${type}; Emoji: ${content};`);
+// A single emote
+console.log(unicode());
 
-console.log(unicode());
+// Random emoji with name and type
+const emoji = emojis();
+console.log(`Name: ${emoji.name}; Emoji: ${emoji.content};`);
+
+// Random cats
+const cat = cats();
+console.log(`Name: ${cat.name}; Emoji: ${cat.content};`);
+
+// Random hearts
+const heart = hearts();
+console.log(`Name: ${heart.name}; Emoji: ${heart.content};`);
+
+// Random circles
+const circle = circles();
+console.log(`Name: ${circle.name}; Emoji: ${circle.content};`);

package/json/emoji.json

@@ -1 +0,0 @@
-{"emojis":[{"name":"smiling face","content":"😀","type":"smiley"},{"name":"tears of joy","content":"😂","type":"smiley"},{"name":"winking face","content":"😉","type":"smiley"},{"name":"rofl","content":"🤣","type":"smiley"},{"name":"smiling face with halo","content":"😇","type":"smiley"},{"name":"beaming face","content":"😁","type":"smiley"},{"name":"Upside-Down Face","content":"🙃","type":"smiley"},{"name":"Sleepy Face","content":"😪","type":"smiley"},{"name":"Smiling Face with Sunglasses","content":"😎","type":"smiley"},{"name":"Nerd Face","content":"🤓","type":"smiley"},{"name":"Weary Face","content":"😩","type":"smiley"},{"name":"burger","content":"🍔","type":"food"},{"name":"Grapes","content":"🍇","type":"food"},{"name":"Melon","content":"🍈","type":"food"},{"name":"Banana","content":"🍌","type":"food"},{"name":"Red Apple","content":"🍎","type":"food"},{"name":"Green Apple","content":"🍏","type":"food"},{"name":"Broccoli","content":"🥦","type":"food"},{"name":"Mushroom","content":"🍄","type":"food"},{"name":"Bread","content":"🍞","type":"food"},{"name":"Pancakes","content":"🥞","type":"food"},{"name":"Pizza","content":"🍕","type":"food"},{"name":"Sandwich","content":"🥪","type":"food"},{"name":"Ice Cream","content":"🍨","type":"food"},{"name":"Birthday Cake","content":"🎂","type":"food"},{"name":"Pie","content":"🥧","type":"food"},{"name":"Chocolate Bar","content":"🍫","type":"food"},{"name":"Candy","content":"🍬","type":"food"},{"name":"See-No-Evil Monkey","content":"🙈","type":"animal"},{"name":"Hear-No-Evil Monkey","content":"🙉","type":"animal"},{"name":"Dog Face","content":"🐶","type":"animal"},{"name":"Wolf","content":"🐺","type":"animal"},{"name":"Cat Face","content":"🐱","type":"animal"},{"name":"Tiger Face","content":"🐯","type":"animal"},{"name":"Horse Face","content":"🐴","type":"animal"},{"name":"Cow Face","content":"🐮","type":"animal"},{"name":"Hamster","content":"🐹","type":"animal"},{"name":"Dragon","content":"🐉","type":"animal"},{"content":"🎃","name":"jack-o-lantern","type":"Activities"},{"content":"🎄","name":"Christmas tree","type":"Activities"},{"content":"🎆","name":"fireworks","type":"Activities"},{"content":"🎇","name":"sparkler","type":"Activities"},{"content":"🧨","name":"firecracker","type":"Activities"},{"content":"✨","name":"sparkles","type":"Activities"},{"content":"🎈","name":"balloon","type":"Activities"},{"content":"🎉","name":"party popper","type":"Activities"},{"content":"🎊","name":"confetti ball","type":"Activities"},{"content":"🎋","name":"tanabata tree","type":"Activities"},{"content":"🎍","name":"pine decoration","type":"Activities"},{"content":"🎎","name":"Japanese dolls","type":"Activities"},{"content":"🎏","name":"carp streamer","type":"Activities"},{"content":"🎐","name":"wind chime","type":"Activities"},{"content":"🎑","name":"moon viewing ceremony","type":"Activities"},{"content":"🧧","name":"red envelope","type":"Activities"},{"content":"🎀","name":"ribbon","type":"Activities"},{"content":"🎁","name":"wrapped gift","type":"Activities"},{"content":"🎗️","name":"reminder ribbon","type":"Activities"},{"content":"🎟️","name":"admission tickets","type":"Activities"},{"content":"🎫","name":"ticket","type":"Activities"},{"content":"🎖️","name":"military medal","type":"Activities"},{"content":"🏆","name":"trophy","type":"Activities"},{"content":"🏅","name":"sports medal","type":"Activities"},{"content":"🥇","name":"1st place medal","type":"Activities"},{"content":"🥈","name":"2nd place medal","type":"Activities"},{"content":"🥉","name":"3rd place medal","type":"Activities"},{"content":"⚽","name":"soccer ball","type":"Activities"},{"content":"⚾","name":"baseball","type":"Activities"},{"content":"🥎","name":"softball","type":"Activities"},{"content":"🏀","name":"basketball","type":"Activities"},{"content":"🏐","name":"volleyball","type":"Activities"},{"content":"🏈","name":"american football","type":"Activities"},{"content":"🏉","name":"rugby football","type":"Activities"},{"content":"🎾","name":"tennis","type":"Activities"},{"content":"🥏","name":"flying disc","type":"Activities"},{"content":"🎳","name":"bowling","type":"Activities"},{"content":"🏏","name":"cricket game","type":"Activities"},{"content":"🏑","name":"field hockey","type":"Activities"},{"content":"🏒","name":"ice hockey","type":"Activities"},{"content":"🥍","name":"lacrosse","type":"Activities"},{"content":"🏓","name":"ping pong","type":"Activities"},{"content":"🏸","name":"badminton","type":"Activities"},{"content":"🥊","name":"boxing glove","type":"Activities"},{"content":"🥋","name":"martial arts uniform","type":"Activities"},{"content":"🥅","name":"goal net","type":"Activities"},{"content":"⛳","name":"flag in hole","type":"Activities"},{"content":"⛸️","name":"ice skate","type":"Activities"},{"content":"🎣","name":"fishing pole","type":"Activities"},{"content":"🤿","name":"diving mask","type":"Activities"},{"content":"🎽","name":"running shirt","type":"Activities"},{"content":"🎿","name":"skis","type":"Activities"},{"content":"🛷","name":"sled","type":"Activities"},{"content":"🥌","name":"curling stone","type":"Activities"},{"content":"🎯","name":"direct hit","type":"Activities"},{"content":"🪀","name":"yo-yo","type":"Activities"},{"content":"🪁","name":"kite","type":"Activities"},{"content":"🎱","name":"pool 8 ball","type":"Activities"},{"content":"🔮","name":"crystal ball","type":"Activities"},{"content":"🪄","name":"magic wand","type":"Activities"},{"content":"🧿","name":"nazar amulet","type":"Activities"},{"content":"🎮","name":"video game","type":"Activities"},{"content":"🕹️","name":"joystick","type":"Activities"},{"content":"🎰","name":"slot machine","type":"Activities"},{"content":"🎲","name":"game die","type":"Activities"},{"content":"🧩","name":"puzzle piece","type":"Activities"},{"content":"🧸","name":"teddy bear","type":"Activities"},{"content":"🪅","name":"piñata","type":"Activities"},{"content":"🪆","name":"nesting dolls","type":"Activities"},{"content":"♠️","name":"spade suit","type":"Activities"},{"content":"♥️","name":"heart suit","type":"Activities"},{"content":"♦️","name":"diamond suit","type":"Activities"},{"content":"♣️","name":"club suit","type":"Activities"},{"content":"♟️","name":"chess pawn","type":"Activities"},{"content":"🃏","name":"joker","type":"Activities"},{"content":"🀄","name":"mahjong red dragon","type":"Activities"},{"content":"🎴","name":"flower playing cards","type":"Activities"},{"content":"🎭","name":"performing arts","type":"Activities"},{"content":"🖼️","name":"framed picture","type":"Activities"},{"content":"🎨","name":"artist palette","type":"Activities"},{"content":"🧵","name":"thread","type":"Activities"},{"content":"🪡","name":"sewing needle","type":"Activities"},{"content":"🧶","name":"yarn","type":"Activities"},{"content":"🪢","name":"knot","type":"Activities"}]}