@peaceroad/markdown-it-renderer-fence 0.1.0 → 0.1.2

package/README.md

@@ -22,7 +22,7 @@ const md = mdit({
                   return highlightjs.highlight(str, { language: lang }).value
                } catch (__) {}
              }
-             return ''
+             return str
            }).use(mditAttrs).use(mditRendererFence)
 
 
@@ -68,12 +68,12 @@ $ pwd
 ~~~
 
 
-## Add span elements to display line number, and style attribute.
+## Add span elements to display line number.
 
 Add `start` or `data-pre-start` attribute by adding attributes used markdown-it-attrs.
 
 ~~~md
-```js {.style start="1"}
+```js {start="1"}
 import mdit from 'markdonw-it'
 const md = mdit()
 md.render('Nyaan')
@@ -81,10 +81,36 @@ md.render('Nyaan')
 ~~~
 
 ~~~html
-<pre><code class="language-js style" data-pre-start="1" style="counter-set:pre-line-number 1;"><span class="pre-line"><span class="hljs-keyword">import</span> mdit <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;markdonw-it&#x27;</span></span>
+<pre><code class="language-js" data-pre-start="1" style="counter-set:pre-line-number 1;"><span class="pre-line"><span class="hljs-keyword">import</span> mdit <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;markdonw-it&#x27;</span></span>
 <span class="pre-line"><span class="hljs-keyword">const</span> md = <span class="hljs-title function_">mdit</span>()</span>
 <span class="pre-line">md.<span class="hljs-title function_">render</span>(<span class="hljs-string">&#x27;Nyaan&#x27;</span>)</span>
 </code></pre>
 ~~~
 
 CSS example: <https://codepen.io/peaceroad/pen/qBGpYGK>
+
+## 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.
+
+~~~md
+``` {em-lines="2,4-5"}
+1
+2
+3
+4
+5
+6
+```
+~~~
+
+~~~html
+[HTML]
+<pre><code>1
+<span class="pre-lines-emphasis">2
+</span>3
+<span class="pre-lines-emphasis">4
+5
+</span>6
+</code></pre>
+~~~

package/index.js

@@ -1,108 +1,166 @@
-const fenceStartTag = (token, tagName, opt) => {
-  let idAttr = [], classAttr = [], dataAttrs = [], styleAttr = [], otherAttrs = []
-  let hasClass = false
-  if (token.attrs) {
-    //console.log('start: ' +token.attrs)
-    for (let attr of token.attrs) {
-      if (attr[0] === 'id') {
-        idAttr.push(attr)
-      } else if (attr[0] === 'class') {
-        hasClass = true
-        classAttr.push([attr[0], opt.langPrefix + token.info + ' ' + attr[1]])
-      } else if (attr[0].startsWith('data-')) {
-        dataAttrs.push(attr)
-      } else if (attr[0] === 'style') {
-        styleAttr.push(attr)
-      } else {
-        otherAttrs.push(attr)
-      }
-    }
-  }
-  if (!hasClass) classAttr.push(['class', opt.langPrefix + token.info])
-  let orderedAttrs = [...idAttr, ...classAttr, ...dataAttrs, ...styleAttr, ...otherAttrs]
+//import highlightjs from 'highlight.js'
+
+const fenceStartTag = (tagName, sAttr) => {
+  let orderedAttrs = [...sAttr.id, ...sAttr.clas, ...sAttr.data, ...sAttr.style, ...sAttr.other]
   //console.log(orderedAttrs)
   let tag = '<' + tagName
   for (let attr of orderedAttrs) {
-    tag += ' ' + attr[0] + '="' + attr[1] + '"'
+    if (attr[0]) tag += ' ' + attr[0] + '="' + attr[1] + '"'
   }
   return tag + '>'
-};
+}
 
-const splitFenceBlockToLines = (token, content) => {
-  const br = content.match(/\r?\n/)
-  const lines = content.split(/r?\n/)
-  let hasCodeLineStart = false
-  let styleIndex = -1
-  let dataIndex = -1
-  let setNumber = -1
-  if (token.attrs) {
-    token.attrs.forEach((attr, i) => {
-      if (attr[i][0] === 'style') styleIndex = i
-      hasCodeLineStart = (/^(?:(?:data-)?pre-)?start$/.test(attr[0]))
-      if (hasCodeLineStart) dataIndex = i
-    })
-  }
-  if (!hasCodeLineStart && setNumber === -1) return content
-  token.attrs[dataIndex][0] = 'data-pre-start'
-  setNumber = token.attrs[dataIndex][1]
+const parseEmphasizeLines = (attrValue) => {
+  const lines = []
+  let s, e
+  attrValue.split(',').forEach(range => {
+    if (range.includes('-')) {
+      [s, e] = range.split('-').map(n => parseInt(n.trim(), 10));
+      lines.push([s, e]);
+    } else {
+      s = parseInt(range.trim(), 10)
+      lines.push([s, s])
+    }
+  });
+  return lines;
+}
 
-  if (styleIndex === -1) {
-    token.attrs.push(['style', 'counter-set:pre-line-number ' + setNumber + ';'])
-  } else {
-    token.attrs[styleIndex][1] = token.attrs[styleIndex][1].replace(/;?$/, '; counter-set:pre-line-number ' + setNumber + ';')
-  }
+const splitFenceBlockToLines = (content, emphasizeLines, opt, hasPreLineStart) => {
+  const br = content.match(/\r?\n/)
+  const lines = content.split(/\r?\n/)
   lines.map((line, n) => {
-    const lastElementTag = line.match(/<(\w+)( +[^>]*?)>[^>]*?(<\/\1>)?[^>]*?$/)
-    if (lastElementTag && !lastElementTag[3]) {
-      line += '</span>'
-      if (n < lines.length - 2) {
-        lines[n + 1] = `<${lastElementTag[1]}${lastElementTag[2]}>` + lines[n + 1]
+    if (opt.setLineNumber && hasPreLineStart) {
+      const lastElementTag = line.match(/<(\w+)( +[^>]*?)>[^>]*?(<\/\1>)?[^>]*?$/)
+      if (lastElementTag && !lastElementTag[3]) {
+        line += '</span>'
+        if (n < lines.length - 2) {
+          lines[n + 1] = `<${lastElementTag[1]}${lastElementTag[2]}>` + lines[n + 1]
+        }
+      }
+      if (n < lines.length - 1) {
+        lines[n] = '<span class="pre-line">' + line + '</span>'
       }
     }
-    if (n < lines.length - 1) {
-      lines[n] = '<span class="pre-line">' + line + '</span>'
+
+    if (opt.setEmphasizeLines && emphasizeLines.length > 0) {
+      if (emphasizeLines[0][0] === n + 1) {
+        lines[n] = `<span class="pre-lines-emphasis">${lines[n]}`
+      }
+      if (emphasizeLines[0][1] === n) {
+        lines[n] = '</span>' + lines[n]
+        emphasizeLines.shift()
+      }
     }
+
   })
   return lines.join(br)
 }
 
+const setInfoAttr = (infoAttr) => {
+  let arr = []
+  let attrSets = infoAttr.trim().split(/ +/)
+  for (let attrSet of attrSets) {
+    const str = attrSet.match(/^(?:([.#])(.+)|(.+?)(?:=("')?(.*?)\1?)?)$/)
+    if (str) {
+      //console.log(str)
+      if (str[1] === '.') str[1] = 'class'
+      if (str[1] === '#') str[1] = 'id'
+      if (str[3]) {
+        str[1] = str[3]
+        str[2] = str[5] ? str[5].replace(/^['"]/, '').replace(/['"]$/, '') : ''
+      }
+      arr.push([str[1], str[2]])
+    }
+  }
+  return arr
+}
+
 const getFenceHtml = (tokens, idx, env, slf, md, options) => {
   const opt = {
     setHighlight: true,
     setLineNumber: true,
+    setEmphasizeLines: true,
     langPrefix: 'language-',
     highlight: null,
   }
   if (options) Object.assign(opt, options)
 
   const token = tokens[idx]
-  //console.log(token)
   let content = token.content
-  if (md.options.highlight) {
-    if (token.info !== 'samp' && opt.setHighlight) {
-      content = md.options.highlight(token.content, token.info)
+  const infoAttr = token.info.trim().match(/{(.*)}$/)
+  if(infoAttr) {
+    token.attrs = token.attrs ? [...token.attrs, ...setInfoAttr(infoAttr[1])] : setInfoAttr(infoAttr[1])
+  }
+
+  let lang = token.info.trim().replace(/ *({.*)?$/, '')
+  const langClass = lang && token.info !== 'samp' ? opt.langPrefix + lang : ''
+  let sAttr = {id: [], clas: [], data: [], style: [], other: []}
+  let hasPreLineStart = false
+  let preLineStart = -1
+  let emphasizeLines = []
+  if (token.attrs) {
+    //console.log('start: ' +token.attrs)
+    for (let attr of token.attrs) {
+      if (attr[0] === 'id') {
+        sAttr.id.push(attr)
+      } else if (attr[0] === 'class') {
+        const sAttrClass = langClass ? langClass + ' ' + attr[1] : attr[1]
+        const hasLang = attr[1].match(new RegExp('(?:^| )' + opt.langPrefix + '(.*)(?: |$)'))
+        if (hasLang) lang = hasLang[1]
+        sAttr.clas.push([attr[0], sAttrClass])
+      } else if (attr[0].startsWith('data-') || /^(?:pre-)?start$/.test(attr[0])) {
+        if (/^(?:(?:data-)?pre-)?start$/.test(attr[0])) {
+          hasPreLineStart = true
+          preLineStart = attr[1]
+          attr[0] = 'data-pre-start'
+        }
+        sAttr.data.push(attr)
+      } else if (/^em(?:phasize)?-lines$/.test(attr[0])) {
+        emphasizeLines = parseEmphasizeLines(attr[1])
+      } else if (attr[0] === 'style') {
+        sAttr.style.push(attr)
+      } else {
+        sAttr.other.push(attr)
+      }
+    }
+  }
+  if (sAttr.clas.length === 0 && langClass !== '') sAttr.clas.push(['class', langClass])
+  if (hasPreLineStart && preLineStart !== -1) {
+    if (sAttr.style.length === 0) {
+      sAttr.style.push(['style', 'counter-set:pre-line-number ' + preLineStart + ';'])
+    } else {
+      sAttr.style[0][1] = sAttr.style[0][1].replace(/;?$/, '; counter-set:pre-line-number ' + preLineStart + ';')
+    }
+  }
+  //console.log(JSON.stringify(sAttr))
+  if (opt.setHighlight && md.options.highlight) {
+    if (lang && lang !== 'samp' ) {
+      content = md.options.highlight(content, lang)
+      /*
+      try {
+        content = highlightjs.highlight(token.content, {language: lang}).value
+      } catch (__) {}
+      */
     } else {
       content = md.utils.escapeHtml(token.content)
     }
   } else {
     content = md.utils.escapeHtml(token.content)
   }
-  if (opt.setLineNumber) {
-    content = splitFenceBlockToLines(token, content)
+  if (opt.setLineNumber || opt.setEmphasizeLines) {
+    content = splitFenceBlockToLines(content, emphasizeLines, opt, hasPreLineStart)
   }
 
   let fenceHtml = '<pre>'
-  if (token.info === 'samp') {
-    fenceHtml += '<samp>'
-  } else if (token.info === 'shell' || token.info === 'console') {
-    fenceHtml += fenceStartTag(token, 'samp', opt);
+  let isSamp = /^(?:samp|shell|console)$/.test(lang)
+  if (isSamp) {
+    fenceHtml += fenceStartTag('samp', sAttr)
   } else {
-    fenceHtml += fenceStartTag(token, 'code', opt);
+    fenceHtml += fenceStartTag('code', sAttr)
   }
+
   fenceHtml += content
-  if (token.info === 'samp') {
-    fenceHtml += '</samp>'
-  } else if (token.info === 'shell' || token.info === 'console') {
+  if (isSamp) {
     fenceHtml += '</samp>'
   } else {
     fenceHtml += '</code>'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@peaceroad/markdown-it-renderer-fence",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "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",
   "type": "module",
@@ -11,9 +11,9 @@
   "repository": "https://github.com/peaceroad/p7d-markdown-it-renderer-fence",
   "license": "MIT",
   "devDependencies": {
-    "@peaceroad/markdown-it-figure-with-p-caption": "^0.6.1",
-    "highlight.js": "^11.9.0",
+    "@peaceroad/markdown-it-figure-with-p-caption": "^0.10.1",
     "markdown-it": "^14.1.0",
-    "markdown-it-attrs": "^4.1.6"
+    "markdown-it-attrs": "^4.2.0",
+    "highlight.js": "^11.10.0"
   }
 }

package/test/example-lines-emphasis.txt

@@ -0,0 +1,98 @@
+[Markdown]
+``` {em-lines="3-5"}
+1
+2
+3
+4
+5
+6
+```
+[HTML]
+<pre><code>1
+2
+<span class="pre-lines-emphasis">3
+4
+5
+</span>6
+</code></pre>
+
+
+[Markdown]
+``` {em-lines="1"}
+1
+2
+3
+4
+5
+6
+```
+[HTML]
+<pre><code><span class="pre-lines-emphasis">1
+</span>2
+3
+4
+5
+6
+</code></pre>
+
+
+[Markdown]
+``` {em-lines="1-3,5-6"}
+1
+2
+3
+4
+5
+6
+```
+[HTML]
+<pre><code><span class="pre-lines-emphasis">1
+2
+3
+</span>4
+<span class="pre-lines-emphasis">5
+6
+</span></code></pre>
+
+
+[Markdown]
+``` {em-lines="3-5" start="1"}
+1
+2
+3
+4
+5
+6
+```
+[HTML]
+<pre><code data-pre-start="1" style="counter-set:pre-line-number 1;"><span class="pre-line">1</span>
+<span class="pre-line">2</span>
+<span class="pre-lines-emphasis"><span class="pre-line">3</span>
+<span class="pre-line">4</span>
+<span class="pre-line">5</span>
+</span><span class="pre-line">6</span>
+</code></pre>
+
+
+[Markdown]
+``` {em-lines="2,4-5"}
+1
+2
+3
+4
+5
+6
+```
+[HTML]
+<pre><code>1
+<span class="pre-lines-emphasis">2
+</span>3
+<span class="pre-lines-emphasis">4
+5
+</span>6
+</code></pre>
+
+
+
+
+

package/test/examples-highlightjs.txt

@@ -105,3 +105,71 @@ $ pwd
 /home/User
 </samp></pre>
 
+[Markdown]
+``` {}
+console.log('A test.')
+```
+[HTML]
+<pre><code>console.log('A test.')
+</code></pre>
+
+[Markdown]
+```js 
+console.log('A test.')
+```
+[HTML]
+<pre><code class="language-js"><span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">&#x27;A test.&#x27;</span>)
+</code></pre>
+
+[Markdown]
+```js {}
+console.log('A test.')
+```
+[HTML]
+<pre><code class="language-js"><span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">&#x27;A test.&#x27;</span>)
+</code></pre>
+
+[Markdown]
+```js {} 
+console.log('A test.')
+```
+[HTML]
+<pre><code class="language-js"><span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">&#x27;A test.&#x27;</span>)
+</code></pre>
+
+
+[Markdown]
+~~~ {}
+console.log('A test.')
+~~~
+[HTML]
+<pre><code>console.log('A test.')
+</code></pre>
+
+
+[Markdown]
+~~~js {}
+console.log('A test.')
+~~~
+[HTML]
+<pre><code class="language-js"><span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">&#x27;A test.&#x27;</span>)
+</code></pre>
+
+
+[Markdown]
+```{.language-js}
+console.log('A test.')
+```
+[HTML]
+<pre><code class="language-js"><span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">&#x27;A test.&#x27;</span>)
+</code></pre>
+
+[Markdown]
+```conf
+[Service]
+Environment="OLLAMA_HOST=0.0.0.0"
+```
+[HTML]
+<pre><code class="language-conf">[Service]
+Environment="OLLAMA_HOST=0.0.0.0"
+</code></pre>

package/test/examples.txt

@@ -41,3 +41,90 @@ $ pwd
 /home/User
 </samp></pre>
 
+
+[Markdown]
+``` 
+console.log('A test.')
+```
+[HTML]
+<pre><code>console.log('A test.')
+</code></pre>
+
+
+[Markdown]
+``` {}
+console.log('A test.')
+```
+[HTML]
+<pre><code>console.log('A test.')
+</code></pre>
+
+[Markdown]
+```js {}
+console.log('A test.')
+```
+[HTML]
+<pre><code class="language-js">console.log('A test.')
+</code></pre>
+
+
+[Markdown]
+```js {} 
+console.log('A test.')
+```
+[HTML]
+<pre><code class="language-js">console.log('A test.')
+</code></pre>
+
+[Markdown]
+```js {.style #id}
+console.log('A test.')
+```
+[HTML]
+<pre><code id="id" class="language-js style">console.log('A test.')
+</code></pre>
+
+[Markdown]
+```js {.style} 
+console.log('A test.')
+```
+[HTML]
+<pre><code class="language-js style">console.log('A test.')
+</code></pre>
+
+
+[Markdown]
+~~~ {}
+console.log('A test.')
+~~~
+[HTML]
+<pre><code>console.log('A test.')
+</code></pre>
+
+
+[Markdown]
+~~~js {}
+console.log('A test.')
+~~~
+[HTML]
+<pre><code class="language-js">console.log('A test.')
+</code></pre>
+
+
+[Markdown]
+```{.language-js}
+console.log('A test.')
+```
+[HTML]
+<pre><code class="language-js">console.log('A test.')
+</code></pre>
+
+
+[Markdown]
+``` js {start="3" aria-label="LABEL"} 
+console.log('A test.')
+```
+[HTML]
+<pre><code class="language-js" data-pre-start="3" style="counter-set:pre-line-number 3;" aria-label="LABEL"><span class="pre-line">console.log('A test.')</span>
+</code></pre>
+

package/test/test.js

@@ -5,13 +5,13 @@ import mdit from 'markdown-it'
 
 import mditFigureWithPCaption from '@peaceroad/markdown-it-figure-with-p-caption'
 import mditRendererFence from '../index.js'
-import attrs from 'markdown-it-attrs'
+import mditAttrs from 'markdown-it-attrs'
 import highlightjs from 'highlight.js'
 
 
 let opt = {}
 
-const md = mdit({ html: true }).use(mditRendererFence).use(attrs)
+const md = mdit({ html: true }).use(mditRendererFence).use(mditAttrs)
 const mdHighlightJs = mdit({
   html: true,
   langPrefix: 'language-',
@@ -22,10 +22,10 @@ const mdHighlightJs = mdit({
         return highlightjs.highlight(str, { language: lang }).value
       } catch (__) {}
     }
-    return ''
+    return str
   }
-}).use(mditRendererFence, opt).use(attrs)
-
+}).use(mditRendererFence, opt).use(mditAttrs)
+const mdLinesEmphasis = mdit({ html: true }).use(mditRendererFence).use(mditAttrs)
 
 let __dirname = path.dirname(new URL(import.meta.url).pathname)
 const isWindows = (process.platform === 'win32')
@@ -36,6 +36,7 @@ if (isWindows) {
 const testData = {
   noOption: __dirname + path.sep +  'examples.txt',
   highlightjs: __dirname + path.sep +  'examples-highlightjs.txt',
+  linesEmphasis: __dirname + path.sep +  'example-lines-emphasis.txt',
 }
 
 const getTestData = (pat) => {
@@ -87,7 +88,7 @@ const runTest = (process, pat, pass, testId) => {
 
   while(n <= end) {
     if (!ms[n]
-//      || n != 3
+    //|| n != 2
     ) {
       n++
       continue
@@ -114,5 +115,6 @@ const runTest = (process, pat, pass, testId) => {
 let pass = true
 pass = runTest(md, testData.noOption, pass)
 pass = runTest(mdHighlightJs, testData.highlightjs, pass)
+pass = runTest(mdLinesEmphasis, testData.linesEmphasis, pass)
 
 if (pass) console.log('Passed all test.')