@peaceroad/markdown-it-renderer-fence 0.6.0 → 0.6.1

package/README.md

@@ -115,7 +115,7 @@ Note:
 
 - `samp` rendering for `samp`, `shell`, `console` languages.
 - line number wrapping via `start` (`line-number-start` long form) / `data-pre-start`.
-- line number skip/reset controls via `line-number-skip` / `line-number-reset`.
+- line number skip/set controls via `line-number-skip` / `line-number-set`.
 - emphasized lines via `em-lines` / `emphasize-lines`.
 - optional line-end spacer via `lineEndSpanThreshold`.
 - optional pre-wrap support via `wrap` / `pre-wrap`.
@@ -157,7 +157,7 @@ console.log(a)
 Advanced line number control:
 
 ~~~md
-```txt {start="25" line-number-skip="5" line-number-reset="6:136"}
+```txt {start="25" line-number-skip="5" line-number-set="6:136"}
 line1
 line2
 line3
@@ -168,7 +168,7 @@ line6
 ~~~
 
 ```html
-<pre><code class="language-txt" data-pre-start="25" data-pre-line-number-skip="5" data-pre-line-number-reset="6:136" style="counter-set:pre-line-number 25;">
+<pre><code class="language-txt" data-pre-start="25" data-pre-line-number-skip="5" data-pre-line-number-set="6:136" style="counter-set:pre-line-number 25;">
 <span class="pre-line">line1</span>
 <span class="pre-line">line2</span>
 <span class="pre-line">line3</span>
@@ -235,32 +235,48 @@ echo 1
 - In that passthrough path, line-splitting features are intentionally disabled:
   - line numbers
   - `line-number-skip`
-  - `line-number-reset`
+  - `line-number-set`
   - `em-lines`
   - line-end spacer
   - `comment-mark`
   - `samp` conversion
 
-Official line-number CSS contract:
+Reference line-number CSS contract:
 
-```css
-.pre-line {
-  counter-increment: pre-line-number;
-}
+Minimum counter contract:
 
-.pre-line::before {
+```css
+pre :is(code, samp)[data-pre-start] .pre-line::before {
   content: counter(pre-line-number);
 }
 
-.pre-line.pre-line-no-number {
-  counter-increment: none;
+pre :is(code, samp)[data-pre-start] .pre-line::after {
+  content: "";
+  counter-increment: pre-line-number;
 }
 
-.pre-line.pre-line-no-number::before {
+pre :is(code, samp)[data-pre-start] .pre-line.pre-line-no-number::before {
   content: "";
 }
+
+pre :is(code, samp)[data-pre-start] .pre-line.pre-line-no-number::after {
+  counter-increment: none;
+}
 ```
 
+Recommended display CSS:
+
+- See [`example/line-number.css`](./example/line-number.css) for the full reference stylesheet.
+- See [`example/line-number-sample.html`](./example/line-number-sample.html) for Markdown / Preview / HTML side-by-side examples.
+
+Note:
+
+- renderer-fence emits `counter-set` as the displayed line number value itself
+- the reference CSS increments the counter in `span.pre-line::after`, so `start="1"` maps directly to `counter-set:pre-line-number 1;`
+- `line-number-set="6:136"` similarly emits `counter-set:pre-line-number 136;` on that line wrapper
+- the minimum contract above is the required part; `example/line-number.css` adds gutter width, divider line, and whitespace handling
+- if a consumer uses a different counter strategy, its CSS must be aligned with this HTML contract
+
 ### Markup Options
 
 - `attrsOrder` (default: `['class', 'id', 'data-*', 'style']`): output attribute order (`data-*` wildcard supported).
@@ -287,13 +303,15 @@ Line-number attr syntax note:
 
 - `line-number-start` is the long form of `start`; rendered output still uses `data-pre-start`.
 - `line-number-skip` supports single values (`2`), ranges (`4-6`), and open-ended forms (`3-`).
-- `line-number-reset` uses `line:number` pairs (for example `6:136,14:220`).
-- `line-number-skip` / `line-number-reset` are applied only when source and highlighted logical line counts match; otherwise renderer falls back to plain sequential numbering.
+- `line-number-set` uses `line:number` pairs (for example `6:136,14:220`).
+- `line-number-skip` and `line-number-set` must not target the same source line. If they overlap, the skipped line stays blank and the conflicting `line-number-set` entry is ignored.
+- `line-number-skip` / `line-number-set` are applied only when source and highlighted logical line counts match; otherwise renderer falls back to plain sequential numbering.
 
 Migration note (`0.5.0`):
 
 - `comment-line` / `data-pre-comment-line` / `pre-comment-line` were removed
 - use `comment-mark` / `data-pre-comment-mark` / `pre-line-comment`
+- `line-number-reset` was removed; use `line-number-set`
 
 ## Custom Highlight API Mode (Experimental / Advanced)
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@peaceroad/markdown-it-renderer-fence",
-  "version": "0.6.0",
+  "version": "0.6.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",
   "exports": {

package/src/fence/render-api-renderer.js

@@ -45,7 +45,7 @@ const buildApiPreAttrs = (preWrapValue, wrapEnabled, opt) => {
   return preAttrs
 }
 
-const renderFenceApiOrPlain = (token, lang, md, opt, slf, env, startNumber, emphasizeLines, lineNumberSkipValue, lineNumberResetValue, wrapEnabled, preWrapValue, commentMarkValue, includePayload, timings) => {
+const renderFenceApiOrPlain = (token, lang, md, opt, slf, env, startNumber, emphasizeLines, lineNumberSkipValue, lineNumberSetValue, wrapEnabled, preWrapValue, commentMarkValue, includePayload, timings) => {
   const isSamp = opt._sampReg.test(lang)
   const tag = isSamp ? 'samp' : 'code'
   let content = md.utils.escapeHtml(token.content)
@@ -53,9 +53,9 @@ const renderFenceApiOrPlain = (token, lang, md, opt, slf, env, startNumber, emph
   const needLineNumber = lineStrategy === 'hybrid' && opt.setLineNumber && startNumber >= 0
   const needEndSpan = lineStrategy === 'hybrid' && opt.lineEndSpanThreshold > 0
   let lineNumberPlan = null
-  if (needLineNumber && (lineNumberSkipValue !== undefined || lineNumberResetValue !== undefined)) {
+  if (needLineNumber && (lineNumberSkipValue !== undefined || lineNumberSetValue !== undefined)) {
     const logicalLineCount = getLogicalLineCount(token.content)
-    lineNumberPlan = resolveAdvancedLineNumberPlan(lineNumberSkipValue, lineNumberResetValue, logicalLineCount, logicalLineCount)
+    lineNumberPlan = resolveAdvancedLineNumberPlan(lineNumberSkipValue, lineNumberSetValue, logicalLineCount, logicalLineCount)
   }
   if (needLineNumber || needEndSpan) {
     const splitStartedAt = timings ? getNowMs() : 0
@@ -101,7 +101,7 @@ const getFenceHtml = (context, md, opt, slf, env) => {
   const startNumber = context.startNumber
   const emphasizeLines = context.emphasizeLines
   const lineNumberSkipValue = context.lineNumberSkipValue
-  const lineNumberResetValue = context.lineNumberResetValue
+  const lineNumberSetValue = context.lineNumberSetValue
   const wrapEnabled = context.wrapEnabled
   const preWrapValue = context.preWrapValue
   const commentMarkValue = context.commentMarkValue
@@ -112,11 +112,11 @@ const getFenceHtml = (context, md, opt, slf, env) => {
     fallbackUsed: false,
     lineFeatureStrategy: opt.customHighlight.lineFeatureStrategy,
     disabledFeatures: opt.customHighlight.lineFeatureStrategy === 'disable'
-      ? ['setLineNumber', 'line-number-skip', 'line-number-reset', 'lineEndSpanThreshold']
+      ? ['setLineNumber', 'line-number-skip', 'line-number-set', 'lineEndSpanThreshold']
       : [],
   }
   try {
-    const html = renderFenceApiOrPlain(token, lang, md, opt, slf, env, startNumber, emphasizeLines, lineNumberSkipValue, lineNumberResetValue, wrapEnabled, preWrapValue, commentMarkValue, true, timings)
+    const html = renderFenceApiOrPlain(token, lang, md, opt, slf, env, startNumber, emphasizeLines, lineNumberSkipValue, lineNumberSetValue, wrapEnabled, preWrapValue, commentMarkValue, true, timings)
     if (timingEnabled) apiDecisionBase.timings = finalizeFenceTimings(timings, fenceStartedAt)
     emitFenceDecision(opt, apiDecisionBase)
     return html
@@ -130,7 +130,7 @@ const getFenceHtml = (context, md, opt, slf, env) => {
         reason: 'provider-error',
         lineFeatureStrategy: opt.customHighlight.lineFeatureStrategy,
       }
-      const html = renderFenceApiOrPlain(token, lang, md, opt, slf, env, startNumber, emphasizeLines, lineNumberSkipValue, lineNumberResetValue, wrapEnabled, preWrapValue, commentMarkValue, false, timings)
+      const html = renderFenceApiOrPlain(token, lang, md, opt, slf, env, startNumber, emphasizeLines, lineNumberSkipValue, lineNumberSetValue, wrapEnabled, preWrapValue, commentMarkValue, false, timings)
       if (timingEnabled) fallbackDecision.timings = finalizeFenceTimings(timings, fenceStartedAt)
       emitFenceDecision(opt, fallbackDecision)
       return html

package/src/fence/render-markup.js

@@ -29,7 +29,7 @@ const renderFenceMarkup = (context, md, opt, slf) => {
   const startNumber = context.startNumber
   const emphasizeLines = context.emphasizeLines
   const lineNumberSkipValue = context.lineNumberSkipValue
-  const lineNumberResetValue = context.lineNumberResetValue
+  const lineNumberSetValue = context.lineNumberSetValue
   const wrapEnabled = context.wrapEnabled
   const preWrapValue = context.preWrapValue
   const commentMarkValue = context.commentMarkValue
@@ -118,9 +118,9 @@ const renderFenceMarkup = (context, md, opt, slf) => {
     normalizedEmphasis = normalizeEmphasisRanges(emphasizeLines, highlightedLogicalLineCount)
   }
   let lineNumberPlan = null
-  if (needLineNumber && (lineNumberSkipValue !== undefined || lineNumberResetValue !== undefined)) {
+  if (needLineNumber && (lineNumberSkipValue !== undefined || lineNumberSetValue !== undefined)) {
     ensureLogicalLineCounts()
-    lineNumberPlan = resolveAdvancedLineNumberPlan(lineNumberSkipValue, lineNumberResetValue, sourceLogicalLineCount, highlightedLogicalLineCount)
+    lineNumberPlan = resolveAdvancedLineNumberPlan(lineNumberSkipValue, lineNumberSetValue, sourceLogicalLineCount, highlightedLogicalLineCount)
   }
   const needEmphasis = normalizedEmphasis.length > 0
   const needEndSpan = opt.lineEndSpanThreshold > 0
@@ -165,7 +165,7 @@ const renderFenceMarkup = (context, md, opt, slf) => {
     renderer: 'markup',
     useHighlightPre,
     hasHighlightPre,
-    disabledFeatures: useHighlightPre ? ['setLineNumber', 'line-number-skip', 'line-number-reset', 'setEmphasizeLines', 'lineEndSpanThreshold', 'comment-mark', 'samp'] : [],
+    disabledFeatures: useHighlightPre ? ['setLineNumber', 'line-number-skip', 'line-number-set', 'setEmphasizeLines', 'lineEndSpanThreshold', 'comment-mark', 'samp'] : [],
   }
   if (timingEnabled) decision.timings = finalizeFenceTimings(timings, fenceStartedAt)
   emitFenceDecision(opt, decision)

package/src/fence/render-shared.js

@@ -190,7 +190,7 @@ const normalizeEmphasisRanges = (emphasizeLines, maxLine) => {
   return normalized
 }
 
-const getLineNumberResetEntries = (attrVal) => {
+const getLineNumberSetEntries = (attrVal) => {
   const str = String(attrVal ?? '')
   if (!str) return []
   const result = []
@@ -200,9 +200,9 @@ const getLineNumberResetEntries = (attrVal) => {
     const colon = part.indexOf(':')
     if (colon === -1) continue
     const lineNumber = parsePositiveLineIndex(part.slice(0, colon).trim())
-    const resetNumber = parseStartNumber(part.slice(colon + 1).trim())
-    if (lineNumber == null || resetNumber == null) continue
-    result.push([lineNumber, resetNumber])
+    const setNumber = parseStartNumber(part.slice(colon + 1).trim())
+    if (lineNumber == null || setNumber == null) continue
+    result.push([lineNumber, setNumber])
   }
   return result
 }
@@ -218,52 +218,51 @@ const createSparseLineFlagMap = (ranges, maxLine) => {
   return flags
 }
 
-const createSparseLineResetMap = (entries, maxLine) => {
+const createSparseLineSetMap = (entries, maxLine, hidden) => {
   if (!entries || !entries.length || maxLine <= 0) return null
-  const resets = []
+  const sets = []
   let hasValue = false
   for (let i = 0; i < entries.length; i++) {
     const line = entries[i][0]
     const value = entries[i][1]
     if (!Number.isSafeInteger(line) || line <= 0 || line > maxLine) continue
-    resets[line - 1] = value
+    if (hidden && hidden[line - 1]) continue
+    sets[line - 1] = value
     hasValue = true
   }
-  return hasValue ? resets : null
+  return hasValue ? sets : null
 }
 
-const buildAdvancedLineNumberPlan = (skipRanges, resetEntries, sourceLineCount, renderedLineCount) => {
+const buildAdvancedLineNumberPlan = (skipRanges, setEntries, lineCount) => {
   const hasSkip = !!(skipRanges && skipRanges.length)
-  const hasReset = !!(resetEntries && resetEntries.length)
-  if (!hasSkip && !hasReset) return null
-  if (!Number.isSafeInteger(sourceLineCount) || sourceLineCount <= 0) return null
-  if (sourceLineCount !== renderedLineCount) return null
-  const hidden = hasSkip ? createSparseLineFlagMap(skipRanges, sourceLineCount) : null
-  const resets = hasReset ? createSparseLineResetMap(resetEntries, sourceLineCount) : null
-  if (!hidden && !resets) return null
-  return { hidden, resets }
+  const hasSet = !!(setEntries && setEntries.length)
+  if (!hasSkip && !hasSet) return null
+  const hidden = hasSkip ? createSparseLineFlagMap(skipRanges, lineCount) : null
+  const sets = hasSet ? createSparseLineSetMap(setEntries, lineCount, hidden) : null
+  if (!hidden && !sets) return null
+  return { hidden, sets }
 }
 
-const resolveAdvancedLineNumberPlan = (lineNumberSkipValue, lineNumberResetValue, sourceLineCount, renderedLineCount) => {
+const resolveAdvancedLineNumberPlan = (lineNumberSkipValue, lineNumberSetValue, sourceLineCount, renderedLineCount) => {
   const hasSkipValue = lineNumberSkipValue !== undefined
-  const hasResetValue = lineNumberResetValue !== undefined
-  if (!hasSkipValue && !hasResetValue) return null
+  const hasSetValue = lineNumberSetValue !== undefined
+  if (!hasSkipValue && !hasSetValue) return null
   if (!Number.isSafeInteger(sourceLineCount) || sourceLineCount <= 0) return null
   if (sourceLineCount !== renderedLineCount) return null
   const skipRanges = hasSkipValue ? getLineNumberSkipRanges(lineNumberSkipValue) : null
-  const resetEntries = hasResetValue ? getLineNumberResetEntries(lineNumberResetValue) : null
-  return buildAdvancedLineNumberPlan(skipRanges, resetEntries, sourceLineCount, renderedLineCount)
+  const setEntries = hasSetValue ? getLineNumberSetEntries(lineNumberSetValue) : null
+  return buildAdvancedLineNumberPlan(skipRanges, setEntries, sourceLineCount)
 }
 
 const getPreLineOpenTag = (lineNumberPlan, lineIndex) => {
   if (!lineNumberPlan) return preLineTag
   const hidden = !!(lineNumberPlan.hidden && lineNumberPlan.hidden[lineIndex])
-  const resetNumber = lineNumberPlan.resets ? lineNumberPlan.resets[lineIndex] : undefined
-  if (!hidden && resetNumber == null) return preLineTag
+  const setNumber = lineNumberPlan.sets ? lineNumberPlan.sets[lineIndex] : undefined
+  if (!hidden && setNumber == null) return preLineTag
   let tag = '<span class="pre-line'
   if (hidden) tag += ' ' + preLineNoNumberClass
   tag += '"'
-  if (resetNumber != null) tag += ` style="counter-set:pre-line-number ${resetNumber};"`
+  if (setNumber != null) tag += ` style="counter-set:pre-line-number ${setNumber};"`
   return tag + '>'
 }
 
@@ -399,7 +398,7 @@ const prepareFenceRenderContext = (tokens, idx, opt) => {
   let startNumber = -1
   let emphasizeLines = []
   let lineNumberSkipValue
-  let lineNumberResetValue
+  let lineNumberSetValue
   let wrapEnabled = false
   let preWrapValue
   let commentMarkValue
@@ -412,7 +411,7 @@ const prepareFenceRenderContext = (tokens, idx, opt) => {
     let styleIndex = -1
     let dataPreCommentIndex = -1
     let dataPreLineNumberSkipIndex = -1
-    let dataPreLineNumberResetIndex = -1
+    let dataPreLineNumberSetIndex = -1
     let startValue
     let emphasisValue
     let styleValue
@@ -420,7 +419,7 @@ const prepareFenceRenderContext = (tokens, idx, opt) => {
     let sawStartAttr = false
     let sawEmphasisAttr = false
     let sawLineNumberSkipAttr = false
-    let sawLineNumberResetAttr = false
+    let sawLineNumberSetAttr = false
     const appendOrder = []
 
     for (const attr of token.attrs) {
@@ -469,11 +468,13 @@ const prepareFenceRenderContext = (tokens, idx, opt) => {
           lineNumberSkipValue = val
           newAttrs.push(attr)
           break
-        case 'data-pre-line-number-reset':
-          dataPreLineNumberResetIndex = newAttrs.length
-          lineNumberResetValue = val
+        case 'data-pre-line-number-set':
+          dataPreLineNumberSetIndex = newAttrs.length
+          lineNumberSetValue = val
           newAttrs.push(attr)
           break
+        case 'data-pre-line-number-reset':
+          break
         case 'em-lines':
         case 'emphasize-lines':
           if (opt.setEmphasizeLines) emphasizeLines = getEmphasizeLines(val)
@@ -498,13 +499,16 @@ const prepareFenceRenderContext = (tokens, idx, opt) => {
             sawLineNumberSkipAttr = true
           }
           break
+        case 'line-number-set':
+        case 'pre-line-number-set':
+          lineNumberSetValue = val
+          if (!sawLineNumberSetAttr) {
+            appendOrder.push('line-number-set')
+            sawLineNumberSetAttr = true
+          }
+          break
         case 'line-number-reset':
         case 'pre-line-number-reset':
-          lineNumberResetValue = val
-          if (!sawLineNumberResetAttr) {
-            appendOrder.push('line-number-reset')
-            sawLineNumberResetAttr = true
-          }
           break
         case 'data-pre-wrap':
           preWrapValue = val
@@ -523,7 +527,7 @@ const prepareFenceRenderContext = (tokens, idx, opt) => {
     if (emphasisValue !== undefined && dataPreEmphasisIndex >= 0) newAttrs[dataPreEmphasisIndex][1] = emphasisValue
     if (commentMarkValue !== undefined && dataPreCommentIndex >= 0) newAttrs[dataPreCommentIndex][1] = commentMarkValue
     if (lineNumberSkipValue !== undefined && dataPreLineNumberSkipIndex >= 0) newAttrs[dataPreLineNumberSkipIndex][1] = lineNumberSkipValue
-    if (lineNumberResetValue !== undefined && dataPreLineNumberResetIndex >= 0) newAttrs[dataPreLineNumberResetIndex][1] = lineNumberResetValue
+    if (lineNumberSetValue !== undefined && dataPreLineNumberSetIndex >= 0) newAttrs[dataPreLineNumberSetIndex][1] = lineNumberSetValue
 
     for (const kind of appendOrder) {
       if (kind === 'start' && dataPreStartIndex === -1 && startValue !== undefined) {
@@ -534,8 +538,8 @@ const prepareFenceRenderContext = (tokens, idx, opt) => {
         newAttrs.push(['data-pre-comment-mark', commentMarkValue])
       } else if (kind === 'line-number-skip' && dataPreLineNumberSkipIndex === -1 && lineNumberSkipValue !== undefined) {
         newAttrs.push(['data-pre-line-number-skip', lineNumberSkipValue])
-      } else if (kind === 'line-number-reset' && dataPreLineNumberResetIndex === -1 && lineNumberResetValue !== undefined) {
-        newAttrs.push(['data-pre-line-number-reset', lineNumberResetValue])
+      } else if (kind === 'line-number-set' && dataPreLineNumberSetIndex === -1 && lineNumberSetValue !== undefined) {
+        newAttrs.push(['data-pre-line-number-set', lineNumberSetValue])
       }
     }
 
@@ -560,7 +564,7 @@ const prepareFenceRenderContext = (tokens, idx, opt) => {
     startNumber,
     emphasizeLines,
     lineNumberSkipValue,
-    lineNumberResetValue,
+    lineNumberSetValue,
     wrapEnabled,
     preWrapValue,
     commentMarkValue,