marked-prismjs-linenumber 0.0.5 → 0.0.7

package/index.cjs

@@ -1,6 +1,11 @@
 const Prism = require('prismjs');
 const loadLanguages = require('prismjs/components/');
 
+/**
+ * @param {string} code
+ * @param {string} [lang]
+ * @returns {string}
+ */
 function highlightWithLineNumbers(code, lang = 'plaintext') {
     const grammar = Prism.languages[lang] || Prism.languages.plaintext;
 
@@ -21,19 +26,23 @@ function highlightWithLineNumbers(code, lang = 'plaintext') {
 }
 
 const renderer = {
+    /**
+     * @param {{ text: string; lang?: string }} args
+     * @returns {string}
+     */
     code({ text, lang }) {
         const trimmedCode = text.trimEnd();
         return highlightWithLineNumbers(trimmedCode, lang || 'plaintext');
     }
 };
 
+/**
+ * @param {{ languages?: string[] }} [options]
+ */
 function init(options = {}) {
     if (Array.isArray(options.languages)) {
         loadLanguages(options.languages);
     }
 }
 
-module.exports = {
-    renderer,
-    init
-};
+module.exports = { renderer, init };

package/index.d.ts

@@ -0,0 +1,21 @@
+export interface PrismJsLineNumberOptions {
+  languages?: string[];
+}
+
+export interface MarkedCodeArgs {
+  text: string;
+  lang?: string;
+}
+
+export const renderer: {
+  code(args: MarkedCodeArgs): string;
+};
+
+export function init(options?: PrismJsLineNumberOptions): void;
+
+declare const _default: {
+  renderer: typeof renderer;
+  init: typeof init;
+};
+
+export default _default;

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "marked-prismjs-linenumber",
-  "version": "0.0.5",
+  "version": "0.0.7",
   "description": "Return HTML with prismjs line-number structure",
-  "type": "module",
   "main": "./index.cjs",
   "module": "./index.mjs",
+  "types": "./index.d.ts",
   "exports": {
     ".": {
+      "types": "./index.d.ts",
       "import": "./index.mjs",
       "require": "./index.cjs",
       "default": "./index.mjs"
@@ -14,13 +15,22 @@
   },
   "files": [
     "index.mjs",
-    "index.cjs"
+    "index.cjs",
+    "index.d.ts"
   ],
   "repository": {
     "type": "git",
     "url": "https://github.com/Yz0012/y_z00blog/tree/main/marked-extensions/marked-prismjs-linenumber"
   },
-  "keywords": ["marked", "prismjs", "linenumber"],
+  "peerDependencies": {
+    "marked": ">=4",
+    "prismjs": "^1.29.0"
+  },
+  "keywords": [
+    "marked",
+    "prismjs",
+    "linenumber"
+  ],
   "author": "Y_z00",
   "license": "MIT"
 }

package/readme.md

@@ -1,4 +1,4 @@
-# marked-prism-linenumber
+# marked-prismjs-linenumber
 
 > A [marked](https://marked.js.org/) renderer that highlights Markdown code blocks with [Prism.js](https://prismjs.com/) and renders line numbers — just like the `line-numbers` plugin, but produced straight from the Markdown parser.
 
@@ -8,20 +8,20 @@
 ## Installation
 
 ```bash
-npm install marked-prism-linenumber
+npm install marked-prismjs-linenumber
 ```
 
 Or with pnpm / yarn:
 
 ```bash
-pnpm add marked-prism-linenumber
-yarn add marked-prism-linenumber
+pnpm add marked-prismjs-linenumber
+yarn add marked-prismjs-linenumber
 ```
 
 You also need `marked` and `prismjs`:
 
 ```bash
-npm install marked prismjs marked-prism-linenumber
+npm install marked prismjs marked-prismjs-linenumber
 ```
 
 ## Required styles
@@ -46,7 +46,7 @@ npm install marked prismjs marked-prism-linenumber
 
 ```js
 import { marked } from 'marked';
-import { renderer, init } from 'marked-prism-linenumber';
+import { renderer, init } from 'marked-prismjs-linenumber';
 
 // Optional: preload Prism grammars you need.
 // Anything not loaded falls back to escaped plain text.
@@ -108,7 +108,7 @@ A `marked` renderer object exposing a single `code({ text, lang })` method. Pass
 
 ```js
 import { marked } from 'marked';
-import { renderer } from 'marked-prism-linenumber';
+import { renderer } from 'marked-prismjs-linenumber';
 
 marked.use({ renderer });
 ```