kaomoji-maker - npm Package Compare versions

Comparing version 0.1.1 to 0.2.0

lib/functions.js

@@ -7,2 +7,6 @@ 'use strict';
 
+/**
+ * Create kaomoji selecting the different parts
+ * @return {Promise}
+ */
 module.exports.create = () => {
@@ -85,4 +89,6 @@ const parts = ['arms_symmetric', 'arms_left', 'bodies_symmetric', 'bodies_left', 'cheeks', 'eyes', 'mouths_noses', 'bodies_right', 'arms_right'].map(fileName =>
           if (a.copy) {
+            ncp.copy(this.kaomoji);
             console.log('Kaomoji copied to clipboard')
           }
+          return true;
         }
@@ -92,8 +98,5 @@ }
   }).then(a => {
-    if (a.copy) {
-      ncp.copy(this.kaomoji);
-    }
     if (a.save) {
-      // TODO save kaomoji
-      console.log(`Kaomoji saved in ${homeDir}`)
+      fs.writeFileSync(`${homeDir}/saved_kaomoji.txt`, `\n${this.kaomoji}`, { flag: 'a' });
+      console.log(`Kaomoji saved in ${homeDir}`);
     }
@@ -103,2 +106,6 @@ });
 
+/**
+ * Choose kaomoji from list and copy it to the clipboard
+ * @return {Promise}
+ */
 module.exports.get = () => {
@@ -127,6 +134,13 @@ let kaomojiList;
 
+/**
+ * Remove multiple kaomoji from saved list
+ * TODO not implemented yet
+ */
 module.exports.remove = () => {
-  console.log('Not implemented yet (⊙︿⊙)')
+  console.log('Not implemented yet (⊙︿⊙)');
 }
 
+/**
+ * Exits app
+ */
 module.exports.exit = () => {
@@ -133,0 +147,0 @@ console.log('See you! (・ω・)ノ');

lib/index.js

@@ -5,2 +5,6 @@ 'use strict';
 
+/**
+ * CLI main menu
+ * @return {Promise}
+ */
 function showMenu () {
@@ -48,2 +52,3 @@ return inquirer.prompt([
 
+// Execute main menu and handle error
 module.exports = showMenu()
@@ -50,0 +55,0 @@ .catch(e => {

package.json

 {
   "name": "kaomoji-maker",
-  "version": "0.1.1",
-  "description": "Kaomoji maker running on Node.js",
+  "version": "0.2.0",
+  "description": "Interactive kaomoji maker running on Node.js",
   "bin": {
@@ -31,3 +31,6 @@ "kaomoji-maker": "./bin/kaomoji-maker"
   },
-  "homepage": "https://github.com/antonvs2/kaomoji-maker#readme"
+  "homepage": "https://github.com/antonvs2/kaomoji-maker#readme",
+  "engines": {
+    "node": ">=6.0.0"
+  }
 }

README.md

 # kaomoji-maker
 
-README coming soon.
+Create many types of kaomoji using an interactive CLI application run by Node.js.
+
+* [x] Interactive CLI powered by [Inquirer.js](https://github.com/SBoudrias/Inquirer.js/).
+* [x] ES6 usage making heavy use of Promises
+
+## But what is a kaomoji?
+
+Kaomoji is a kind of emoticon. According to [Wikipedia](https://en.wikipedia.org/wiki/Emoticon#/media/File:Emoticon_Smile_Face.svg):
+
+> An emoticon (ee-moht-i-kon), (/ᵻˈmoʊtᵻkɒn/, or /iˈmoʊtᵻkɒn/) is a pictorial representation of a facial expression using punctuation marks, numbers and letters, usually written to express a person's feelings or mood.
+
+> In Western countries, emoticons are usually written at a right angle to the direction of the text. Users from Japan popularized a kind of emoticon called kaomoji (顔文字; lit. 顔(kao)=face, 文字(moji)=character(s); often confused with emoji in the West) that can be understood without tilting one's head to the left.
+
+Also referred to as  dongers, text faces, emojicons, emotes or similar.
+
+## Install
+
+Install it through npm globally so it can be executed from anywhere in your terminal:
+
+```
+npm install -g kaomoji-maker
+```
+
+It also can be installed as a local module, or just cloning this repository and executing bin/kaomoji-maker through Node.js:
+
+```
+git clone https://github.com/antonvs2/kaomoji-maker.git
+cd kaomoji-maker
+npm install
+node bin/kaomoji-maker
+```
+
+## Functionality
+
+> Create kaomoji
+
+Create a kaomoji choosing part by part
+
+> Copy saved kaomoji
+
+Check your saved list and copy to clipboard.
+
+> Remove kaomoji
+
+Remove multiple kaomoji from saved list.
+
+> Exit
+
+Exit CLI.
+
+## Contribution
+
+Pull requests with new parts (under `lib/parts`) are welcome. Of course, PR or issues with new functionality and bug fixes are more than welcome too.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

7783

increased by40.26%

Lines of code

195

increased by10.8%

Number of lines in readme file

56

increased by1300%

No dependency changes