gemoji - npm Package Compare versions

Comparing version 0.2.1 to 0.2.2

index.js

 'use strict';
 
-/**
+/*
  * Data.
@@ -11,3 +11,3 @@ */
 
-/**
+/*
  * Cached methods.
@@ -20,3 +20,3 @@ */
 
-/**
+/*
  * Create a dictionary to hold the emoji by name.
@@ -32,6 +32,5 @@ */
  *
- * @param {string} emoji - Unicode emoji to extend.
+ * @param {string} character - Unicode emoji to extend.
  */
-
-function enhanceEmoji(emoji) {
+function enhanceEmoji(character) {
     var information,
@@ -42,6 +41,6 @@ names,
 
-    information = gemoji[emoji];
+    information = gemoji[character];
     names = information.names;
 
-    /**
+    /*
      * Add the main `name`.
@@ -52,9 +51,9 @@ */
 
-    /**
+    /*
      * Add the emoji to the object too.
      */
 
-    information.emoji = emoji;
+    information.emoji = character;
 
-    /**
+    /*
      * Add the main `name` to `named`.
@@ -65,3 +64,3 @@ */
 
-    /**
+    /*
      * If the emoji is known by other names,
@@ -79,3 +78,3 @@ * add those too to the map.
 
-/**
+/*
  * Transform all emoji.
@@ -93,3 +92,3 @@ */
 
-/**
+/*
  * Expose the extended data (`gemoji`) as `unicode`.
@@ -100,3 +99,3 @@ */
 
-/**
+/*
  * Expose the name-to-unicode dictionary (`named`) as `name`.
@@ -103,0 +102,0 @@ */

package.json

 {
   "name": "gemoji",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "description": "GitHub emoji: gemoji",
@@ -22,24 +22,24 @@ "license": "MIT",
   "devDependencies": {
-    "eslint": "^0.10.0",
+    "eslint": "^0.11.0",
     "istanbul": "^0.3.0",
     "jscs": "^1.0.0",
-    "markdown-table": "0.1.0",
+    "jscs-jsdoc": "^0.4.0",
+    "markdown-table": "0.3.0",
     "mocha": "^2.0.0"
   },
   "scripts": {
-    "test": "node_modules/.bin/_mocha --reporter spec --check-leaks -u exports test.js",
-    "test-travis": "node_modules/.bin/istanbul cover node_modules/.bin/_mocha --report lcovonly -- --reporter spec --check-leaks -u exports test.js",
-    "coverage": "node_modules/.bin/istanbul cover node_modules/.bin/_mocha -- -- test.js",
-    "lint": "npm run lint-api && npm run lint-test && npm run lint-style",
-    "lint-api": "node_modules/.bin/eslint index.js",
-    "lint-test": "node_modules/.bin/eslint test.js --env mocha",
-    "lint-script": "node_modules/.bin/eslint script/build-data.js script/build-support.js",
-    "lint-style": "node_modules/.bin/jscs index.js script/build-data.js script/build-support.js test.js --reporter=inline",
-    "make": "npm run lint && npm run coverage && npm run build-support",
-    "scrape-data": "curl --connect-timeout 5 --max-time 10 -H 'Accept: application/vnd.github.v3.raw' -L https://api.github.com/repos/github/gemoji/contents/db/emoji.json -o data/emoji.json || exit 0",
-    "build-data": "node script/build-data.js",
-    "build-support": "node script/build-support.js",
-    "build": "npm run scrape-data && npm run build-data && npm run build-support",
+    "test": "_mocha --check-leaks test.js",
+    "test-travis": "istanbul cover _mocha --report lcovonly -- --check-leaks test.js",
+    "coverage": "istanbul cover _mocha -- -- test.js",
+    "lint-api": "eslint index.js",
+    "lint-test": "eslint --env mocha test.js",
+    "lint-script": "eslint script/build-data.js script/build-support.js",
+    "lint-style": "jscs --reporter inline index.js test.js script/build-data.js script/build-support.js",
+    "lint": "npm run lint-api && npm run lint-test && npm run lint-script && npm run lint-style",
+    "make": "npm run lint && npm run coverage",
+    "prebuild": "curl --connect-timeout 5 --max-time 10 -H 'Accept: application/vnd.github.v3.raw' -L https://api.github.com/repos/github/gemoji/contents/db/emoji.json -o data/emoji.json || exit 0",
+    "build": "node script/build-data.js",
+    "postbuild": "node script/build-support.js",
     "prepublish": "npm run build"
   }
 }

Readme.md

@@ -7,20 +7,29 @@ # gemoji [![Build Status](https://img.shields.io/travis/wooorm/gemoji.svg?style=flat)](https://travis-ci.org/wooorm/gemoji) [![Coverage Status](https://img.shields.io/coveralls/wooorm/gemoji.svg?style=flat)](https://coveralls.io/r/wooorm/gemoji?branch=master)
 
-npm:
-```sh
+[npm](https://docs.npmjs.com/cli/install):
+
+```bash
 $ npm install gemoji
 ```
 
-Component:
-```sh
+[Component.js](https://github.com/componentjs/component):
+
+```bash
 $ component install wooorm/gemoji
 ```
 
-Bower:
-```sh
+[Bower](http://bower.io/#install-packages):
+
+```bash
 $ bower install gemoji
 ```
 
+[Duo](http://duojs.org/#getting-started):
+
+```javascript
+var gemoji = require('wooorm/gemoji');
+```
+
 ## Usage
 
-```js
+```javascript
 var gemoji = require('gemoji');
@@ -45,3 +54,3 @@
 
-```js
+```javascript
 gemoji.unicode['🐶'];
@@ -64,3 +73,3 @@ ```
 
-```js
+```javascript
 gemoji.unicode['\uD83D\uDCA9'];
@@ -94,2 +103,2 @@ ```
 
-MIT © [Titus Wormer](http://wooorm.com)
+[MIT](LICENSE) © [Titus Wormer](http://wooorm.com)

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

Number of lines in readme file

101

increased by9.78%

Worsened metrics

Total package byte prevSize

109491

decreased by-0.01%

Dev dependency count

6

increased by20%

No dependency changes