remark-emoji - npm Package Compare versions

Comparing version 1.0.0 to 1.1.0

index_test.js

@@ -21,2 +21,15 @@ const assert = require('assert');
 
+function processPad(contents) {
+    const compiler = remark().use(github).use(headings).use(slug).use(emoji, {padSpaceAfter: true});
+    return new Promise((resolve, reject) => {
+        compiler.process(contents, (err, result) => {
+            if (err) {
+                return reject(err);
+            }
+            resolve(result.contents);
+        });
+    });
+}
+
+
 describe('remark-emoji', () => {
@@ -59,2 +72,19 @@ it('replaces emojis in text', () => {
     });
+
+    it('can handle an emoji including 2 underscores', () => {
+        return process(':heavy_check_mark:').then(r => assert.equal(r, '✔️\n'));
+    });
+
+    it('adds an white space after emoji when padSpaceAfter is set to true', () => {
+        const cases = {
+            ':dog: is dog': '🐶  is dog\n',
+            'dog is :dog:': 'dog is 🐶 \n',
+            ':dog: is not :cat:': '🐶  is not 🐱 \n',
+            ':triumph:': '😤 \n'
+        };
+
+        return Promise.all(
+            Object.keys(cases).map(c => processPad(c).then(r => assert.equal(r, cases[c])))
+        );
+    });
 });

index.js

@@ -6,8 +6,20 @@ const visit = require('unist-util-visit');
 
-function plugin() {
+function plugin(_, settings) {
+    const pad = !!(settings || {}).padSpaceAfter;
+
+    function getEmoji(match) {
+        const got = emoji.get(match);
+        if (!pad || got === match) {
+            return got;
+        }
+
+        return got + ' ';
+    }
+
     function transformer(tree) {
         visit(tree, 'text', node => {
-            node.value = node.value.replace(RE_EMOJI, m => emoji.get(m));
+            node.value = node.value.replace(RE_EMOJI, getEmoji);
         });
     }
+
     return transformer;
@@ -14,0 +26,0 @@ }

package.json

 {
   "name": "remark-emoji",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Emoji transformer plugin for Remark",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -9,13 +9,25 @@ remark-emoji
 
+```
+remark().use(emoji [, options]);
+```
+
 ```javascript
 const remark = require('remark');
-const emoji = require('emoji');
+const emoji = require('remark-emoji');
 
-const doc = 'Emojis in this text will be relpaces: :dog: :+1:';
+const doc = 'Emojis in this text will be replaced: :dog: :+1:';
 console.log(remark().use(emoji).process(doc).contents);
-// => Emojis in this text will be relpaces: 🐶 👍
+// => Emojis in this text will be replaced: 🐶 👍
 ```
 
+## Options
+
+### `options.padSpaceAfter`
+
+Setting to `true` means that an extra whitespace is added after emoji.
+This is useful when browser handle emojis with half character length and following character is hidden.
+Default value is `false`.
+
 ## License
 
 Distributed under [the MIT License](LICENSE).

No alert changes

Improved metrics

Total package byte prevSize

7109

increased by26.49%

Lines of code

130

increased by34.02%

Number of lines in readme file

33

increased by57.14%

No dependency changes