@peaceroad/markdown-it-renderer-fence 0.3.1 → 0.4.1

package/README.md

@@ -71,6 +71,7 @@ $ pwd
 ## Add span elements to display line number.
 
 Add `start` or `data-pre-start` attribute by adding attributes used markdown-it-attrs.
+Line numbering is enabled only when `start` is a non-negative integer (`0`, `1`, `2`, ...).
 
 ~~~md
 ```js {start="1"}
@@ -89,9 +90,11 @@ md.render('Nyaan')
 
 CSS example: <https://codepen.io/peaceroad/pen/qBGpYGK>
 
+If `start` is empty or not a non-negative integer (for example `start=""`, `start="abc"`, `start="1.5"`), the attribute is kept as `data-pre-start` but line-number wrapping/counter style is not enabled.
+
 ## Add span elements to add background color to the row ranges.
 
-Add `em-lines` or `emphasize-lines` attribute by by adding attributes used markdown-it-attrs.
+Add `em-lines` or `emphasize-lines` attribute by adding attributes used markdown-it-attrs.
 Open-ended ranges are supported: `-5` (1..5), `3-` (3..last), `-` (all).
 
 ~~~md
@@ -133,6 +136,27 @@ const longLine = 'This line is long but wraps.'
 
 When `setPreWrapStyle` is set to false, only `data-pre-wrap="true"` is added and the inline style is omitted.
 
+## Mark comment lines in code blocks
+
+Add `comment-line` attribute to mark comment lines. Lines that start with the given marker (after leading whitespace) are wrapped with `<span class="pre-comment-line">`.
+
+~~~md
+```samp {comment-line="#"}
+# comment
+echo 1
+```
+~~~
+
+~~~html
+<pre><samp data-pre-comment-line="#"><span class="pre-comment-line"># comment</span>
+echo 1
+</samp></pre>
+~~~
+
+Note: this feature relies on line splitting and is disabled when `useHighlightPre` is true and `<pre><code>` is provided by the highlighter.
+If a highlighter changes logical line count (for example by injecting extra lines), comment-line marking is skipped to avoid wrong line mapping.
+CRLF/LF mixed newlines are supported for logical line-count checks.
+
 
 ## Options
 
@@ -142,8 +166,12 @@ The following options can be specified when initializing the plugin:
 - setHighlight: default true — enable calling highlight function (e.g., highlight.js).
 - setLineNumber: default true — wrap lines in spans for line numbers.
 - setEmphasizeLines: default true — enable emphasis based on emphasize-lines attribute.
-- setLineEndSpan: default 0 — character count threshold to append end-of-line span (0 to disable).
+- lineEndSpanThreshold: default 0 — character count threshold to append end-of-line span (0 to disable).
+- setLineEndSpan: alias for lineEndSpanThreshold.
 - lineEndSpanClass: default 'pre-lineend-spacer' — CSS class for end-of-line span.
 - setPreWrapStyle: default true — include inline pre-wrap styles on `<pre>` when wrap is enabled.
 - sampLang: default 'shell,console' — comma-separated list of languages (in addition to 'samp') that will be rendered using `<samp>`.
 - langPrefix: default md.options.langPrefix || 'language-' — prefix for language class on code blocks.
+- useHighlightPre: default false — if highlight returns `<pre><code>`, keep that wrapper and skip line-splitting features; attributes are still merged.
+
+When `useHighlightPre` is true and the highlight output contains `<pre><code>`, line-splitting features are disabled (setLineNumber, setEmphasizeLines, lineEndSpanThreshold, comment-line). In this mode `<samp>` conversion is not possible, so avoid `useHighlightPre` when you need samp output.

package/index.js

@@ -5,12 +5,15 @@ const interAttrsSpaceReg = / +/
 const tagReg = /<\/?([A-Za-z][A-Za-z0-9-]*)(?:\s+[^>]*?)?\/?\s*>/g
 const preLineTag = '<span class="pre-line">'
 const emphOpenTag = '<span class="pre-lines-emphasis">'
+const commentLineClass = 'pre-comment-line'
 const closeTag = '</span>'
 const closeTagLen = closeTag.length
 const preWrapStyle = 'white-space: pre-wrap; overflow-wrap: anywhere;'
 const preCodeWrapperReg = /^\s*<pre\b([^>]*)>\s*<code\b([^>]*)>([\s\S]*?)<\/code>\s*<\/pre>\s*$/i
 const htmlAttrReg = /([^\s=]+)(?:\s*=\s*(?:"([^"]*)"|'([^']*)'|([^\s"'=<>`]+)))?/g
 const voidTags = new Set(['area', 'base', 'br', 'col', 'embed', 'hr', 'img', 'input', 'link', 'meta', 'param', 'source', 'track', 'wbr'])
+const nonNegativeIntReg = /^\d+$/
+const lineBreakReg = /\r\n|\n|\r/
 
 const appendStyleValue = (style, addition) => {
   if (!addition) return style
@@ -68,6 +71,21 @@ const mergeAttrSets = (target, source) => {
   }
 }
 
+const parseStartNumber = (val) => {
+  if (val == null) return null
+  const text = String(val).trim()
+  if (!nonNegativeIntReg.test(text)) return null
+  const n = Number(text)
+  if (!Number.isSafeInteger(n)) return null
+  return n
+}
+
+const getLogicalLineCount = (text) => {
+  const lines = text.split(lineBreakReg)
+  if (lines.length === 0) return 0
+  return lines[lines.length - 1] === '' ? lines.length - 1 : lines.length
+}
+
 const getEmphasizeLines = (attrVal) => {
   const lines = []
   for (const range of attrVal.split(',')) {
@@ -95,10 +113,11 @@ const getEmphasizeLines = (attrVal) => {
   return lines
 }
 
-const splitFenceBlockToLines = (content, emphasizeLines, needLineNumber, needEmphasis, needEndSpan, threshold, lineEndSpanClass, br) => {
-  const lines = content.split(br)
+const splitFenceBlockToLines = (content, emphasizeLines, needLineNumber, needEmphasis, needEndSpan, threshold, lineEndSpanClass, br, commentLines, commentClass) => {
+  const lines = content.split(lineBreakReg)
   const len = lines.length
   const endSpanTag = needEndSpan ? `<span class="${lineEndSpanClass}"></span>` : ''
+  const needComment = !!(commentLines && commentClass)
   const maxLine = len - (lines[len - 1] === '' ? 1 : 0)
   let emIdx = 0
   let emStart
@@ -167,6 +186,13 @@ const splitFenceBlockToLines = (content, emphasizeLines, needLineNumber, needEmp
           lines[n+1] = `<${tagName}>` + (lines[n+1]||'')
         }
       }
+    }
+
+    if (needComment && commentLines[n]) {
+      line = `<span class="${commentClass}">` + line + closeTag
+    }
+
+    if (needLineNumber && n !== len - 1) {
       line = preLineTag + line + closeTag
     }
 
@@ -224,16 +250,14 @@ const orderTokenAttrs = (token, opt) => {
 const getFenceHtml = (tokens, idx, md, opt, slf) => {
   const token = tokens[idx]
   let content = token.content
-  const info = token.info.trim()
-  const match = info.match(infoReg)
+  const match = token.info.trim().match(infoReg)
   let lang = match ? match[1] : ''
 
   if (match && match[2]) {
     getInfoAttr(match[2]).forEach(([name, val]) => token.attrJoin(name, val))
   }
-  let langClass = ''
   if (lang  && lang !== 'samp') {
-    langClass = opt.langPrefix + lang
+    const langClass = opt.langPrefix + lang
     const existingClass = token.attrGet('class')
     token.attrSet('class', existingClass ? langClass + ' ' + existingClass : langClass)
   }
@@ -242,15 +266,18 @@ const getFenceHtml = (tokens, idx, md, opt, slf) => {
   let emphasizeLines = []
   let wrapEnabled = false
   let preWrapValue
+  let commentLineValue
 
   if (token.attrs) {
     const newAttrs = []
     let dataPreStartIndex = -1
     let dataPreEmphasisIndex = -1
     let styleIndex = -1
+    let dataPreCommentIndex = -1
     let startValue
     let emphasisValue
     let styleValue
+    let sawCommentLine = false
     let sawStartAttr = false
     let sawEmphasisAttr = false
     const appendOrder = []
@@ -274,14 +301,14 @@ const getFenceHtml = (tokens, idx, md, opt, slf) => {
           newAttrs.push(attr)
           break
         case 'data-pre-start':
-          startNumber = +val
+          startNumber = parseStartNumber(val) ?? -1
           startValue = val
           dataPreStartIndex = newAttrs.length
           newAttrs.push(attr)
           break
         case 'start':
         case 'pre-start':
-          startNumber = +val
+          startNumber = parseStartNumber(val) ?? -1
           startValue = val
           if (!sawStartAttr) {
             appendOrder.push('start')
@@ -292,15 +319,27 @@ const getFenceHtml = (tokens, idx, md, opt, slf) => {
           dataPreEmphasisIndex = newAttrs.length
           newAttrs.push(attr)
           break
+        case 'data-pre-comment-line':
+          dataPreCommentIndex = newAttrs.length
+          commentLineValue = val
+          newAttrs.push(attr)
+          break
         case 'em-lines':
         case 'emphasize-lines':
-          emphasizeLines = getEmphasizeLines(val)
+          if (opt.setEmphasizeLines) emphasizeLines = getEmphasizeLines(val)
           emphasisValue = val
           if (!sawEmphasisAttr) {
             appendOrder.push('emphasis')
             sawEmphasisAttr = true
           }
           break
+        case 'comment-line':
+          commentLineValue = val
+          if (!sawCommentLine) {
+            appendOrder.push('comment')
+            sawCommentLine = true
+          }
+          break
         case 'data-pre-wrap':
           preWrapValue = val
           if (val === '' || val === 'true') wrapEnabled = true
@@ -322,6 +361,9 @@ const getFenceHtml = (tokens, idx, md, opt, slf) => {
     if (emphasisValue !== undefined && dataPreEmphasisIndex >= 0) {
       newAttrs[dataPreEmphasisIndex][1] = emphasisValue
     }
+    if (commentLineValue !== undefined && dataPreCommentIndex >= 0) {
+      newAttrs[dataPreCommentIndex][1] = commentLineValue
+    }
     for (const kind of appendOrder) {
       if (kind === 'start') {
         if (dataPreStartIndex === -1 && startValue !== undefined) {
@@ -331,6 +373,10 @@ const getFenceHtml = (tokens, idx, md, opt, slf) => {
         if (dataPreEmphasisIndex === -1 && emphasisValue !== undefined) {
           newAttrs.push(['data-pre-emphasis', emphasisValue])
         }
+      } else if (kind === 'comment') {
+        if (dataPreCommentIndex === -1 && commentLineValue !== undefined) {
+          newAttrs.push(['data-pre-comment-line', commentLineValue])
+        }
       }
     }
     if (startNumber !== -1) {
@@ -345,6 +391,11 @@ const getFenceHtml = (tokens, idx, md, opt, slf) => {
     token.attrs = newAttrs
   }
 
+  const isSamp = opt._sampReg.test(lang)
+  let commentLines
+  let needComment = false
+  let sourceLogicalLineCount = -1
+
   if (opt.setHighlight && md.options.highlight) {
     if (lang && lang !== 'samp' ) {
       content = md.options.highlight(content, lang)
@@ -356,9 +407,12 @@ const getFenceHtml = (tokens, idx, md, opt, slf) => {
   }
 
   let preAttrsFromHighlight
-  if (content.indexOf('<pre') !== -1) {
+  let hasHighlightPre = false
+  const hasPreTag = (content.indexOf('<pre') !== -1 || content.indexOf('<PRE') !== -1)
+  if (hasPreTag) {
     const preMatch = content.match(preCodeWrapperReg)
     if (preMatch) {
+      hasHighlightPre = true
       preAttrsFromHighlight = parseHtmlAttrs(preMatch[1])
       const codeAttrsFromHighlight = parseHtmlAttrs(preMatch[2])
       content = preMatch[3]
@@ -368,6 +422,9 @@ const getFenceHtml = (tokens, idx, md, opt, slf) => {
       }
     }
   }
+  if (opt.useHighlightPre && hasPreTag && !hasHighlightPre) {
+    return content.endsWith('\n') ? content : content + '\n'
+  }
   orderTokenAttrs(token, opt)
 
   let preAttrs = preAttrsFromHighlight ? preAttrsFromHighlight.slice() : []
@@ -392,14 +449,32 @@ const getFenceHtml = (tokens, idx, md, opt, slf) => {
 
   const needLineNumber = opt.setLineNumber && startNumber >= 0
   const needEmphasis = opt.setEmphasizeLines && emphasizeLines.length > 0
-  const needEndSpan = opt.setLineEndSpan > 0
-  if (needLineNumber || needEmphasis || needEndSpan) {
+  const needEndSpan = opt.lineEndSpanThreshold > 0
+  const useHighlightPre = opt.useHighlightPre && hasHighlightPre
+  if (!useHighlightPre && commentLineValue) {
+    const rawLines = token.content.split(lineBreakReg)
+    sourceLogicalLineCount = getLogicalLineCount(token.content)
+    commentLines = new Array(rawLines.length)
+    for (let i = 0; i < rawLines.length; i++) {
+      const isComment = rawLines[i].trimStart().startsWith(commentLineValue)
+      commentLines[i] = isComment
+      if (isComment) needComment = true
+    }
+  }
+  if (!useHighlightPre && (needLineNumber || needEmphasis || needEndSpan || needComment)) {
     const nlIndex = content.indexOf('\n')
     const br = nlIndex > 0 && content[nlIndex - 1] === '\r' ? '\r\n' : '\n'
-    content = splitFenceBlockToLines(content, emphasizeLines, needLineNumber, needEmphasis, needEndSpan, opt.setLineEndSpan, opt.lineEndSpanClass, br)
+    if (needComment && sourceLogicalLineCount >= 0) {
+      const highlightedLogicalLineCount = getLogicalLineCount(content)
+      if (highlightedLogicalLineCount !== sourceLogicalLineCount) {
+        needComment = false
+        commentLines = undefined
+      }
+    }
+    content = splitFenceBlockToLines(content, emphasizeLines, needLineNumber, needEmphasis, needEndSpan, opt.lineEndSpanThreshold, opt.lineEndSpanClass, br, commentLines, commentLineClass)
   }
 
-  const tag = opt._sampReg.test(lang) ? 'samp' : 'code'
+  const tag = isSamp ? 'samp' : 'code'
   return `<pre${preAttrsText}><${tag}${slf.renderAttrs(token)}>${content}</${tag}></pre>\n`
 }
 
@@ -409,13 +484,19 @@ const mditRendererFence = (md, option) => {
     setHighlight: true,
     setLineNumber: true,
     setEmphasizeLines: true,
-    setLineEndSpan: 0,
+    lineEndSpanThreshold: 0,
     lineEndSpanClass: 'pre-lineend-spacer',
     setPreWrapStyle: true,
+    useHighlightPre: false,
     sampLang: 'shell,console',
     langPrefix: md.options.langPrefix || 'language-',
   }
-  if (option) Object.assign(opt, option)
+  if (option) {
+    Object.assign(opt, option)
+    if (option.lineEndSpanThreshold == null && option.setLineEndSpan != null) {
+      opt.lineEndSpanThreshold = option.setLineEndSpan
+    }
+  }
 
   opt._sampReg = new RegExp('^(?:samp|' + opt.sampLang.split(',').join('|') + ')$')
   opt._langReg = new RegExp(opt.langPrefix + '([A-Za-z0-9-]+)')

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@peaceroad/markdown-it-renderer-fence",
-  "version": "0.3.1",
+  "version": "0.4.1",
   "description": "In code blocks, the `<samp>` tag is used with the language keywords `samp`, `shell`, and `console`, and provides an option to display line numbers.",
   "main": "index.js",
   "files": [
@@ -10,13 +10,15 @@
   ],
   "type": "module",
   "scripts": {
-    "test": "node test/test.js"
+    "test": "node test/test.js",
+    "test:performance": "node test/performance/benchmark.js",
+    "test:performance:highlighter": "node test/performance/highlighter-benchmark.js"
   },
   "author": "peaceroad <peaceroad@gmail.com>",
   "repository": "https://github.com/peaceroad/p7d-markdown-it-renderer-fence",
   "license": "MIT",
   "devDependencies": {
-    "@peaceroad/markdown-it-figure-with-p-caption": "^0.15.1",
+    "@peaceroad/markdown-it-figure-with-p-caption": "^0.15.2",
     "highlight.js": "^11.11.1",
     "markdown-it": "^14.1.0",
     "markdown-it-attrs": "^4.3.1",