@peaceroad/markdown-it-numbering-ul-regarded-as-ol 0.2.3 → 0.4.0

package/README.md

@@ -2,7 +2,7 @@
 
 Markdown's default ordered list markers are limited. This plugin extends Markdown's unordered lists so they can use many kinds of ordered markers.
 
-Also, this plugin option provides a description-list conversion. Unordered list items whose first line is wrapped in `**` and followed by two spaces are converted into `<dl>` elements.
+Also, this plugin option provides a description-list conversion. Unordered list items whose first line is wrapped in `**` and followed by a description separator (two spaces, `\\`, or a blank line) are converted into `<dl>` elements.
 
 ## Ordered lists conversion behavior
 
@@ -71,6 +71,11 @@ After the marker separator, an ASCII space is normally expected. For `fullwidth`
 
 - Marker type detection is deterministic: gather all markers at a nesting level, match them against the canonical definitions, keep the type that explains the most items while preserving numeric continuity, and use the order in `listTypes.json` only as a final tiebreaker.
 - Flattening: A pattern like `- 1.` is represented by the default `ul > li > ol` nesting structure in markdown-it, but this plugin simplifies it to a single `ol` by default to match the representation of other markers.
+- With `markdown-it-attrs`, attr blocks follow that plugin's nearest-block behavior. This plugin does not reassign list attrs after flattening.
+
+### Source map behavior
+
+The flattener uses `token.map` (markdown-it source line numbers) to preserve loose list output for `- 1.` style lists. markdown-it normally assigns `map` to block tokens, but it can be missing if tokens are constructed manually, cloned without `map`, or stripped by upstream plugins to save memory. In that case, the plugin falls back to markdown-it's `paragraph.hidden` flags and `- 1.` lists with blank lines may render as tight lists (no `<p>` wrappers). Avoid stripping `map` data or set `unremoveUlNest: true` if exact loose rendering is required.
 
 Note: For custom marker lists (those rendered with `role="list"`) the plugin assumes you will hide the native marker via CSS (for example `ol[role="list"] { list-style: none; }`). The `hasListStyleNone` option can be enabled to add `style="list-style: none;"` directly to generated `<ol>` elements.
 
@@ -85,22 +90,32 @@ You can customize the conversion using options.
 - `hasListStyleNone` (boolean) — When the plugin emits `role="list"`, also add `style="list-style: none;"` to the `<ol>`.
 - `omitMarkerMetadata` (boolean) — If `true`, omit the `data-marker-prefix` / `data-marker-suffix` attributes.
 - `addMarkerStyleToClass` (boolean) — When `true`, append suffix-style information to the generated class name (e.g. `ol-decimal-with-round-round`). When `false` (default) the class stays as `ol-decimal`.
+- `enableLiteralNumberingFix` (boolean) — Enable literal nested list recovery (for example, nested lists starting with 2 or greater). This is opt-in; it only applies inside list items, evaluates indentation relative to the parent list marker (marker width + 0–3 spaces), and does not convert code blocks (indent >= marker width + 4).
+  - Compatibility note: switching the default from `false` to `true` changes rendered HTML by design. On the current test corpus (`394` markdown cases), `18` cases change.
+  - Changed files in that comparison: `examples-default-14-repeated-numbers.txt` (`7`), `examples-option-literal-numbering-attrs.txt` (`1`), `examples-option-literal-numbering-fix-disabled.txt` (`2`), `examples-option-literal-numbering-fix.txt` (`3`), `examples-option-literal-numbering-indent.txt` (`4`).
+  - Recommendation: keep the default as `false` for patch/minor releases; if changing the default to `true`, treat it as a breaking change and release a major version.
 
 ## Description lists conversion behavior
 
-When the `descriptionList` option is enabled the plugin converts specially formatted bullet lists into HTML description lists (`<dl>`).
+When `descriptionList` or `descriptionListWithDiv` is enabled, the plugin converts specially formatted bullet lists into HTML description lists (`<dl>`).
 
 - Each list item must start with a `**Term**` line.
-  - If the Term line is not separated from the description by a blank line, then the Term line must end with two ASCII spaces (a Markdown line-break) or a backslash `\` to indicate the description follows.
+  - The `**Term**` line must be the first direct block inside that list item (term-like text inside nested sub-lists does not trigger conversion).
+  - If the description continues on the next line without a blank line, the Term line must end with two ASCII spaces (a Markdown line-break) or a backslash `\`. Inline `{.attrs}` immediately after the term are allowed.
+  - If the Term line is followed by a blank line, the description can start in the next paragraph or list (line-break control characters are optional).
+  - Same-line descriptions such as `- **Term** Description` are not converted.
+  - Same-line backslash forms such as `- **Term**\ Description` are also not converted (the hard break marker must be followed by an actual newline).
+  - Term-line attrs can be written in multiple adjacent blocks (`**Term** {.a} {#id} {data-x=1}`) and are merged onto `<dt>`.
+  - Attr-like braces are kept as description text only when your plugin chain does not parse them as attributes. With `markdown-it-attrs`, forms like `{foo}` may be treated as boolean attributes.
 
 In the conversion the `**Term**` line becomes a `<dt>` and the subsequent lines become the corresponding `<dd>`.
 
-Note: Currently the content inside `<dd>` elements is always wrapped in `<p>` elements.
+Note: Text descriptions are wrapped in `<p>` elements; additional paragraphs and lists keep markdown-it's block structure.
 
 ### Description list options
 
 - `descriptionList` (boolean) — Enable conversion of `**Term**` list patterns into `<dl>` description lists.
-- `descriptionListWithDiv` (boolean) — Wrap `<dt>/<dd>` pairs in a `<div>` when enabled.
+- `descriptionListWithDiv` (boolean) — Wrap `<dt>/<dd>` pairs in a `<div>` when enabled. This option also enables description-list conversion even when `descriptionList` is `false`.
 - `descriptionListDivClass` (string) — Class applied to the wrapper `<div>` when `descriptionListWithDiv` is enabled (empty string disables the class).
 
 ## Examples: Ordered Lists

package/index.js

@@ -5,7 +5,6 @@ import { convertLists } from './src/phase2-convert.js'
 import { addAttributes } from './src/phase3-attributes.js'
 import { processHtmlBlocks } from './src/phase4-html-blocks.js'
 import { generateSpans } from './src/phase5-spans.js'
-import { moveNestedListAttributes } from './src/phase6-attrs-migration.js'
 import { normalizeLiteralOrderedLists } from './src/preprocess-literal-lists.js'
 
 const mditNumberingUl = (md, option) => {
@@ -21,13 +20,30 @@ const mditNumberingUl = (md, option) => {
     omitMarkerMetadata: false,    // true=omit data-marker-prefix/suffix attributes
     useCounterStyle: false,       // true=users will use @counter-style; suppress marker spans and role attr
     addMarkerStyleToClass: false, // true=append -with-* marker style suffix to class names
+    enableLiteralNumberingFix: false, // true=normalize nested lists that don't start at 1 (opt-in)
     
     // Override with user options
     ...option
   }
-  
-  // Check if markdown-it-attrs is loaded (detect once at plugin initialization)
-  const hasAttrsPlugin = md.core.ruler.__rules__.some(rule => rule.name === 'curly_attributes')
+
+  const addRuleAfter = (ruler, afterName, ruleName, fn) => {
+    try {
+      ruler.after(afterName, ruleName, fn)
+    } catch {
+      ruler.push(ruleName, fn)
+    }
+  }
+
+  const dlProcessor = (state) => {
+    if (!state.env) {
+      state.env = {}
+    }
+    if (!opt.descriptionList && !opt.descriptionListWithDiv) {
+      return true
+    }
+    processDescriptionList(state.tokens, opt)
+    return true
+  }
 
   const listProcessor = (state) => {
     // Initialize state.env
@@ -36,14 +52,9 @@ const mditNumberingUl = (md, option) => {
     }
 
     const tokens = state.tokens
-    
-    // ===== PHASE 0: Description List =====
-    // Convert **Term**: pattern from paragraph to bullet_list, then to dl/dt/dd
-    // Must run before Phase 1 (parsed as bullet_list)
-    processDescriptionList(tokens, opt)
 
     // Normalize literal nested ordered lists (markdown-it only creates nested lists when they start at 1)
-    normalizeLiteralOrderedLists(tokens)
+    normalizeLiteralOrderedLists(tokens, opt)
     
     // ===== PHASE 1: List Structure Analysis =====
     // Analyze marker detection and structure without token conversion
@@ -56,36 +67,32 @@ const mditNumberingUl = (md, option) => {
     
     // ===== PHASE 3: Add Attributes =====
     // Add type, class, data-* attributes to converted lists
-    // Use original listInfos as tokens may have been removed in Phase2
-    // (Uses markerInfo stored in tokens)
-    addAttributes(tokens, listInfos, opt)
+    // Use markerInfo stored on list tokens (safe after Phase2 mutations)
+    addAttributes(tokens, opt)
     
     // ===== PHASE 4: HTML Block Processing =====
     // Remove indents from HTML blocks in lists and normalize line breaks
-    processHtmlBlocks(state)
+    let hasNestedHtmlBlock = false
+    for (let i = 0; i < tokens.length; i++) {
+      const token = tokens[i]
+      if (token.type === 'html_block' && token.level > 0) {
+        hasNestedHtmlBlock = true
+        break
+      }
+    }
+    if (hasNestedHtmlBlock) {
+      processHtmlBlocks(state)
+    }
     
     // ===== PHASE 5: Span Generation =====
     // Generate marker spans in alwaysMarkerSpan mode
-    generateSpans(tokens, listInfos, opt)
+    generateSpans(tokens, opt)
     
     return true
   }
 
-  md.core.ruler.before('inline', 'numbering_ul_phases', listProcessor)
-  
-  if (!opt.unremoveUlNest) {
-    // Move nested list attributes only when flattening is enabled
-    const nestedListAttrProcessor = (state) => {
-      moveNestedListAttributes(state.tokens)
-      return true
-    }
-    
-    if (hasAttrsPlugin) {
-      md.core.ruler.after('curly_attributes', 'numbering_ul_nested_attrs', nestedListAttrProcessor)
-    } else {
-      md.core.ruler.push('numbering_ul_nested_attrs', nestedListAttrProcessor)
-    }
-  }
+  md.core.ruler.before('inline', 'numbering_dl_parser', dlProcessor)
+  md.core.ruler.after('numbering_dl_parser', 'numbering_ul_phases', listProcessor)
   
   // Description list: Move paragraph attributes to dl and add custom renderers
   if (opt.descriptionList || opt.descriptionListWithDiv) {
@@ -95,30 +102,7 @@ const mditNumberingUl = (md, option) => {
       return true
     }
     
-    if (hasAttrsPlugin) {
-      md.core.ruler.after('curly_attributes', 'numbering_dl_attrs', dlAttrProcessor)
-    } else {
-      md.core.ruler.push('numbering_dl_attrs', dlAttrProcessor)
-    }
-    
-    // Add custom renderers for description list tokens
-    // Helper function to render attributes
-    const renderAttrs = (token) => {
-      if (!token.attrs || token.attrs.length === 0) return ''
-      return ' ' + token.attrs.map(([key, value]) => `${key}="${value}"`).join(' ')
-    }
-    
-    md.renderer.rules.dl_open = (tokens, idx) => `<dl${renderAttrs(tokens[idx])}>\n`
-    md.renderer.rules.dl_close = () => '</dl>\n'
-    md.renderer.rules.dt_open = (tokens, idx) => `<dt${renderAttrs(tokens[idx])}>`
-    md.renderer.rules.dt_close = () => '</dt>\n'
-    md.renderer.rules.dd_open = (tokens, idx) => `<dd${renderAttrs(tokens[idx])}>\n`
-    md.renderer.rules.dd_close = () => '</dd>\n'
-    
-    if (opt.descriptionListWithDiv) {
-      md.renderer.rules.div_open = (tokens, idx) => `<div${renderAttrs(tokens[idx])}>\n`
-      md.renderer.rules.div_close = () => '</div>\n'
-    }
+    addRuleAfter(md.core.ruler, 'curly_attributes', 'numbering_dl_attrs', dlAttrProcessor)
   }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@peaceroad/markdown-it-numbering-ul-regarded-as-ol",
-  "version": "0.2.3",
+  "version": "0.4.0",
   "description": "This markdown-it plugin regard ul element with numbering lists as ol element.",
   "main": "index.js",
   "type": "module",
@@ -27,7 +27,7 @@
   },
   "homepage": "https://github.com/peaceroad/p7d-markdown-it-numbering-ul-regarded-as-ol#readme",
   "devDependencies": {
-    "@peaceroad/markdown-it-strong-ja": "^0.5.5",
+    "@peaceroad/markdown-it-strong-ja": "^0.7.2",
     "markdown-it": "^14.1.0",
     "markdown-it-attrs": "^4.3.1",
     "markdown-it-deflist": "^3.0.0"