gitbook-plugin-advanced-emoji - npm Package Compare versions

Comparing version 0.0.6 to 0.1.0

index.js

 module.exports = {
     website: {
-        assets: "./node_modules/emojify.js/dist/images/basic/",
+        assets: "./assets",
         js: [ ],
         css: [
-            "plugin.css"
+            "emojify.css"
         ]
@@ -15,3 +15,3 @@ },
             var emojify = require("emojify.js");
-            emojify.setConfig({img_dir : '/gitbook/plugins/gitbook-plugin-advanced-emoji/'});
+            emojify.setConfig({img_dir : '/gitbook/plugins/gitbook-plugin-advanced-emoji/emojis/'});
             page.content = emojify.replace(page.content);
@@ -18,0 +18,0 @@ return page;

package.json

@@ -5,3 +5,3 @@ {
   "main": "index.js",
-  "version": "0.0.6",
+  "version": "0.1.0",
   "engines": {
@@ -30,3 +30,9 @@ "gitbook": ">=2.5.0"
     "emojify.js": "^1.1.0"
+  },
+  "scripts": {
+    "pre-publish": "node ./pre-publish.js"
+  },
+  "devDependencies": {
+    "fs-extra": "^0.26.2"
   }
 }

README.md

 # GitBook Plugin: Advanced Emoji
 
-Transforms emoji like `:white_check_mark:` into emoji images.
+Transforms emojis like `:white_check_mark:` into real :white_check_mark: emoji images using [emojify.js](https://github.com/hassankhan/emojify.js).
 
+## Installation
 
@@ -20,2 +21,3 @@ You can install this plugin via npm:
 
+Then run `gitbook install` followed by either `gitbook serve` or `gitbook build`
 
@@ -25,2 +27,11 @@
 
-Apache License Version 2.0,
+ * https://github.com/codeclou/gitbook-plugin-advanced-emoji is licensed under MIT License
+ * https://github.com/hassankhan/emojify.js is licensed under MIT License
+
+## Publishing to npmjs.com
+
+```
+npm install           # install dependencies
+npm run pre-publish   # copies emoji pngs and css to assets folder
+npm run publish       # publishes to npmjs.com
+```

New alerts

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Mixed license

License

(Experimental) Package contains multiple licenses.

Found 1 instance in 1 package

Improved metrics

Number of package files

7

increased by16.67%

Lines of code

30

increased by25%

Number of lines in readme file

35

increased by45.83%

Worsened metrics

Total package byte prevSize

3681

decreased by-71.77%

Dev dependency count

1

increased byInfinity%

Number of low license alerts

1

increased byInfinity%

Number of low supply chain risk alerts

1

increased byInfinity%

No dependency changes