marked-prismjs-linenumber 0.0.7 → 0.0.9

package/index.cjs

@@ -1,48 +1,38 @@
 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;
-
-    let highlightedCode;
-    if (grammar) {
-        highlightedCode = Prism.highlight(code, grammar, lang);
-    } else {
-        highlightedCode = code
-            .replace(/&/g, '&')
-            .replace(/</g, '&lt;')
-            .replace(/>/g, '&gt;');
+function linenumber(options = {}) {
+    if (Array.isArray(options.languages)) {
+        loadLanguages(options.languages);
     }
 
-    const lineCount = code.split('\n').length;
-    const rowsSpans = '<span></span>'.repeat(lineCount);
-    const rowsWrapper = `<span aria-hidden="true" class="line-numbers-rows">${rowsSpans}</span>`;
-    return `<pre class="line-numbers language-${lang}"><code class="language-${lang}">${highlightedCode}${rowsWrapper}</code></pre>`;
-}
+    return {
+        renderer: {
+            code({ text, lang }) {
+                const language = lang || 'plaintext';
+                const grammar = Prism.languages[language] || Prism.languages.plaintext;
+                const code = text.trimEnd();
 
-const renderer = {
-    /**
-     * @param {{ text: string; lang?: string }} args
-     * @returns {string}
-     */
-    code({ text, lang }) {
-        const trimmedCode = text.trimEnd();
-        return highlightWithLineNumbers(trimmedCode, lang || 'plaintext');
-    }
-};
+                let highlightedCode;
+                if (grammar) {
+                    highlightedCode = Prism.highlight(code, grammar, language);
+                } else {
+                    highlightedCode = code
+                        .replace(/&/g, '&amp;')
+                        .replace(/</g, '&lt;')
+                        .replace(/>/g, '&gt;');
+                }
 
-/**
- * @param {{ languages?: string[] }} [options]
- */
-function init(options = {}) {
-    if (Array.isArray(options.languages)) {
-        loadLanguages(options.languages);
-    }
+                const lineCount = code.split('\n').length;
+                const rowsSpans = '<span></span>'.repeat(lineCount);
+                const rowsWrapper = `<span aria-hidden="true" class="line-numbers-rows">${rowsSpans}</span>`;
+
+                return `<pre class="line-numbers language-${language}"><code class="language-${language}">${highlightedCode}</code>${rowsWrapper}</pre>`;
+            }
+        }
+    };
 }
 
-module.exports = { renderer, init };
+module.exports = linenumber;
+module.exports.default = linenumber;
+module.exports.linenumber = linenumber;

package/index.d.ts

@@ -7,15 +7,13 @@ export interface MarkedCodeArgs {
   lang?: string;
 }
 
-export const renderer: {
-  code(args: MarkedCodeArgs): string;
-};
-
-export function init(options?: PrismJsLineNumberOptions): void;
+export interface MarkedExtension {
+  renderer: {
+    code(args: MarkedCodeArgs): string;
+  };
+}
 
-declare const _default: {
-  renderer: typeof renderer;
-  init: typeof init;
-};
+declare function linenumber(options?: PrismJsLineNumberOptions): MarkedExtension;
 
-export default _default;
+export { linenumber };
+export default linenumber;

package/index.mjs

@@ -1,4 +1,4 @@
-import mod from './index.cjs';
-export const renderer = mod.renderer;
-export const init = mod.init;
-export default mod;
+import linenumber from './index.cjs';
+
+export default linenumber;
+export { linenumber };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "marked-prismjs-linenumber",
-  "version": "0.0.7",
+  "version": "0.0.9",
   "description": "Return HTML with prismjs line-number structure",
   "main": "./index.cjs",
   "module": "./index.mjs",

package/readme.md

@@ -1,6 +1,6 @@
 # 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.
+> A [marked](https://marked.js.org/) extension that highlights Markdown code blocks with [Prism.js](https://prismjs.com/) and renders line numbers
 
 [![npm version](https://img.shields.io/npm/v/marked-prismjs-linenumber.svg)](https://www.npmjs.com/package/marked-prismjs-linenumber)
 [![license](https://img.shields.io/npm/l/marked-prismjs-linenumber.svg)](./LICENSE)
@@ -11,13 +11,6 @@
 npm install marked-prismjs-linenumber
 ```
 
-Or with pnpm / yarn:
-
-```bash
-pnpm add marked-prismjs-linenumber
-yarn add marked-prismjs-linenumber
-```
-
 You also need `marked` and `prismjs`:
 
 ```bash
@@ -42,18 +35,19 @@ npm install marked prismjs marked-prismjs-linenumber
 
 ## Usage
 
-### 1. Register the renderer
+### 1. Register the extension
 
 ```js
 import { marked } from 'marked';
-import { renderer, init } from 'marked-prismjs-linenumber';
-
-// Optional: preload Prism grammars you need.
-// Anything not loaded falls back to escaped plain text.
-init({ languages: ['javascript', 'typescript', 'css', 'bash', 'json'] });
+import linenumber from 'marked-prismjs-linenumber';
 
-// Hook the renderer into marked.
-marked.use({ renderer });
+marked.use(
+  linenumber({
+    // Optional: preload Prism grammars you need.
+    // Anything not loaded falls back to escaped plain text.
+    languages: ['javascript', 'typescript', 'css', 'bash', 'json'],
+  })
+);
 
 const markdown = `
 # Example
@@ -67,53 +61,28 @@ console.log(greeting);
 console.log(marked.parse(markdown));
 ```
 
-### 2. Output
-
-The code block above is rendered as:
-
-```html
-<pre class="line-numbers language-js">
-  <code class="language-js">
-    <span class="token keyword">const</span> greeting <span class="token operator">=</span> ...
-    <span aria-hidden="true" class="line-numbers-rows">
-      <span></span><span></span>
-    </span>
-  </code>
-</pre>
-```
-
-[Effect display](https://yz0012.github.io/y_z00blog/Post/%E6%9D%82%E9%A1%B9/%E8%A1%8C%E5%8F%B7%E7%A4%BA%E4%BE%8B.html)
-
-Each `<span></span>` inside `.line-numbers-rows` becomes one line number via the Prism line-numbers CSS.
-
 ## API
 
-### `init(options?)`
+### `linenumber(options?)`
 
-Loads Prism language grammars before rendering. Call it once at startup.
+Creates a `marked` extension. Pass it directly to `marked.use(...)`.
 
 | Option | Type | Default | Description |
 | --- | --- | --- | --- |
 | `languages` | `string[]` | — | Language names or aliases to load via `prismjs/components/index.js`. |
 
 ```js
-init({ languages: ['javascript', 'python', 'go'] });
+import { marked } from 'marked';
+import linenumber from 'marked-prismjs-linenumber';
+
+marked.use(linenumber({ languages: ['javascript', 'python', 'go'] }));
 ```
 
 If a language is not loaded, or an unknown `lang` is used in a fenced code block, the renderer escapes the raw code and outputs it as plain text.
 
-### `renderer`
-
-A `marked` renderer object exposing a single `code({ text, lang })` method. Pass it to `marked.use({ renderer })`.
-
-```js
-import { marked } from 'marked';
-import { renderer } from 'marked-prismjs-linenumber';
-
-marked.use({ renderer });
-```
+The extension overrides the `code({ text, lang })` renderer:
 
 | Parameter | Type | Default | Description |
 | --- | --- | --- | --- |
-| `code` | `string` | — | The source code to highlight. |
+| `text` | `string` | — | The source code to highlight. |
 | `lang` | `string` | `'plaintext'` | Prism language name or alias. |