revolt-markdown - npm Package Compare versions

Comparing version 1.0.2 to 1.0.3

dist/main.d.ts

@@ -73,2 +73,3 @@ import { HtmlOptions } from './types/HtmlOptions';
         };
+        emoji: import("@khanacademy/simple-markdown").ParserRule & import("@khanacademy/simple-markdown").HtmlOutputRule;
         emoticon: import("@khanacademy/simple-markdown").ParserRule & import("@khanacademy/simple-markdown").HtmlOutputRule;
@@ -280,2 +281,3 @@ heading: {
         };
+        emoji: import("@khanacademy/simple-markdown").ParserRule & import("@khanacademy/simple-markdown").HtmlOutputRule;
         emoticon: import("@khanacademy/simple-markdown").ParserRule & import("@khanacademy/simple-markdown").HtmlOutputRule;
@@ -282,0 +284,0 @@ heading: {

dist/rules.d.ts

@@ -94,2 +94,3 @@ export declare const rulesRevoltOnlyHtml: {
     };
+    emoji: import("@khanacademy/simple-markdown").ParserRule & import("@khanacademy/simple-markdown").HtmlOutputRule;
     emoticon: import("@khanacademy/simple-markdown").ParserRule & import("@khanacademy/simple-markdown").HtmlOutputRule;
@@ -283,2 +284,3 @@ heading: {
     };
+    emoji: import("@khanacademy/simple-markdown").ParserRule & import("@khanacademy/simple-markdown").HtmlOutputRule;
     emoticon: import("@khanacademy/simple-markdown").ParserRule & import("@khanacademy/simple-markdown").HtmlOutputRule;
@@ -285,0 +287,0 @@ heading: {

dist/types/HtmlOptions.d.ts

@@ -6,4 +6,5 @@ import { RevoltCallbacks } from './RevoltCallbacks';
     revoltOnly?: boolean;
+    emojiToUnicode?: boolean;
     revoltCallback?: RevoltCallbacks;
     cssModuleNames?: Record<string, string>;
 };

package.json

 {
 	"name": "revolt-markdown",
-	"version": "1.0.2",
+	"version": "1.0.3",
 	"description": "A markdown parser for Revolt messages",
@@ -42,4 +42,5 @@ "keywords": [
 	"dependencies": {
+		"@khanacademy/simple-markdown": "^0.11.3",
 		"highlight.js": "^11.9.0",
-		"@khanacademy/simple-markdown": "^0.11.3"
+		"node-emoji": "^2.1.3"
 	},
@@ -46,0 +47,0 @@ "devDependencies": {

README.md

@@ -37,6 +37,7 @@ # revolt-markdown
 * `revoltOnly`: Boolean (default: false), if it should only parse the Revolt-specific stuff
-* `revoltCallback`: Object, callbacks used for discord parsing. Each (except `spoilerAttrib`) receive an object with different properties, and are expected to return an HTML escaped string
+* `emojiToUnicode`: Boolean (default: true), if the default emojis should be converted to unicode
+* `revoltCallback`: Object, callbacks used for discord parsing. Each (except `spoilerAttrib`) receive an object with different properties, and (except `emoji`) are expected to return an HTML escaped string
   * `user`: (`id`: String) User mentions "@someperson"
   * `channel`: (`id`: String) Channel mentions "#somechannel"
-  * `emoji`: (`id`: String) Emoji mentions ":someemoji:"
+  * `emoji`: (`id`: String) Emoji mentions ":someemoji:". Expects a list of attributes for the `img` tag
   * `timestamp`: (`timestamp`: Number, `style`: String|undefined) Relative timestamp reference "<t:sometimestamp:somestyle>"
@@ -43,0 +44,0 @@ * `spoilerAttrib`: object of HTML attributes for the spoiler span. Default is `{ class: 'd-spoiler' }`

No alert changes

Improved metrics

Total package byte prevSize

3273237

increased by20.07%

Number of package files

30

increased by3.45%

Lines of code

86393

increased by33.99%

Number of lines in readme file

68

increased by1.49%

Worsened metrics

Dependency count

3

increased by50%

Dependency changes

• + Addednode-emoji@^2.1.3

• + Added@sindresorhus/is@4.6.0(transitive)

• + Addedchar-regex@1.0.2(transitive)

• + Addedemojilib@2.4.0(transitive)

• + Addednode-emoji@2.2.0(transitive)

• + Addedskin-tone@2.0.0(transitive)

• + Addedunicode-emoji-modifier-base@1.0.0(transitive)