marked-highlight - npm Package Compare versions

Comparing version 2.0.1 to 2.0.2

package.json

 {
   "name": "marked-highlight",
-  "version": "2.0.1",
+  "version": "2.0.2",
   "description": "marked highlight",
@@ -28,2 +28,3 @@ "main": "./lib/index.cjs",
     "test:cover": "jest --coverage",
+    "test:types": "tsd -t src/index.d.ts -f types_test/index.test-d.ts",
     "lint": "eslint .",
@@ -43,27 +44,37 @@ "build": "rollup -c rollup.config.js"
   "peerDependencies": {
-    "marked": "^4 || ^5"
+    "marked": "^4 || ^5 || ^6"
   },
   "devDependencies": {
-    "@babel/core": "^7.21.8",
-    "@babel/preset-env": "^7.21.5",
+    "@babel/core": "^7.22.9",
+    "@babel/preset-env": "^7.22.9",
     "@semantic-release/changelog": "^6.0.3",
-    "@semantic-release/commit-analyzer": "^9.0.2",
+    "@semantic-release/commit-analyzer": "^10.0.1",
     "@semantic-release/git": "^10.0.1",
-    "@semantic-release/github": "^8.0.7",
-    "@semantic-release/npm": "^10.0.3",
-    "@semantic-release/release-notes-generator": "^11.0.1",
-    "@types/marked": "^5.0.0",
-    "babel-jest": "^29.5.0",
-    "eslint": "^8.41.0",
-    "eslint-config-standard": "^17.0.0",
-    "eslint-plugin-import": "^2.27.5",
-    "eslint-plugin-n": "^15.7.0",
+    "@semantic-release/github": "^9.0.4",
+    "@semantic-release/npm": "^10.0.4",
+    "@semantic-release/release-notes-generator": "^11.0.4",
+    "@types/marked": "^5.0.1",
+    "babel-jest": "^29.6.2",
+    "eslint": "^8.46.0",
+    "eslint-config-standard": "^17.1.0",
+    "eslint-plugin-import": "^2.28.0",
+    "eslint-plugin-n": "^16.0.1",
     "eslint-plugin-promise": "^6.1.1",
     "highlight.js": "^11.8.0",
-    "jest-cli": "^29.5.0",
-    "marked": "^5.0.2",
+    "jest-cli": "^29.6.2",
+    "marked": "^6.0.0",
     "pygmentize-bundled": "^2.3.0",
-    "rollup": "^3.23.0",
-    "semantic-release": "^21.0.2"
+    "rollup": "^3.27.2",
+    "semantic-release": "^21.0.7",
+    "tsd": "^0.28.1"
+  },
+  "tsd": {
+    "compilerOptions": {
+      "paths": {
+        "marked-highlight": [
+          "./src"
+        ]
+      }
+    }
   }
 }

README.md

@@ -10,3 +10,3 @@ # marked-highlight
 ```js
-import {marked} from "marked";
+import {Marked} from "marked";
 import {markedHighlight} from "marked-highlight";
@@ -18,10 +18,13 @@ import hljs from 'highlight.js';
 // <script src="https://cdn.jsdelivr.net/npm/marked-highlight/lib/index.umd.js"></script>
+// const {markedHighlight} = globalThis.markedHighlight;
+const marked = new Marked(
+  markedHighlight({
+    langPrefix: 'hljs language-',
+    highlight(code, lang) {
+      const language = hljs.getLanguage(lang) ? lang : 'plaintext';
+      return hljs.highlight(code, { language }).value;
+    }
+  })
+);
 
-marked.use(markedHighlight({
-  langPrefix: 'hljs language-',
-  highlight(code, lang) {
-    const language = hljs.getLanguage(lang) ? lang : 'plaintext';
-    return hljs.highlight(code, { language }).value;
-  }
-}));
 
@@ -41,21 +44,23 @@ marked.parse(`
 ```js
-import {marked} from "marked";
+import {Marked} from "marked";
 import {markedHighlight} from "marked-highlight";
 import pygmentize from 'pygmentize-bundled';
 
-marked.use(markedHighlight({
-  async: true,
-  highlight(code, lang) {
-    return new Promise((resolve, reject) => {
-      pygmentize({ lang, format: 'html' }, code, function (err, result) {
-        if (err) {
-          resolve(err);
-          return;
-        }
+const marked = new Marked(
+  markedHighlight({
+    async: true,
+    highlight(code, lang) {
+      return new Promise((resolve, reject) => {
+        pygmentize({ lang, format: 'html' }, code, function (err, result) {
+          if (err) {
+            resolve(err);
+            return;
+          }
 
-        resolve(result.toString());
+          resolve(result.toString());
+        });
       });
-    });
-  }
-}));
+    }
+  })
+)
 
@@ -62,0 +67,0 @@ marked.parse(`

src/index.d.ts

@@ -68,3 +68,3 @@ declare module 'marked-highlight' {
    */
-  export function markedHighlight(options: SynchronousOptions): import('marked').marked.MarkedExtension;
+  export function markedHighlight(options: SynchronousOptions): import('marked').MarkedExtension;
 
@@ -77,3 +77,3 @@ /**
    */
-  export function markedHighlight(options: AsynchronousOptions): import('marked').marked.MarkedExtension;
+  export function markedHighlight(options: AsynchronousOptions): import('marked').MarkedExtension;
 
@@ -88,3 +88,3 @@ /**
     highlightFunction: SyncHighlightFunction
-  ): import('marked').marked.MarkedExtension;
+  ): import('marked').MarkedExtension;
 }

No alert changes

Improved metrics

Total package byte prevSize

15671

increased by2.24%

Number of lines in readme file

85

increased by6.25%

Worsened metrics

Dev dependency count

22

increased by4.76%

No dependency changes