@peaceroad/markdown-it-numbering-ul-regarded-as-ol 0.1.1 → 0.1.2

package/README.md

@@ -12,7 +12,17 @@ Input Markdown:
 
 Output HTML:
 
+```html
+<ol type="i" class="ol-lower-roman">
+<li>a</li>
+<li>b</li>
+<li>c</li>
+</ol>
 ```
+
+Using Option `omitTypeNumber: false` output HTML:
+
+```html
 <ol type="i" class="ol-lower-roman">
 <li><span class="li-num">i<span class="li-num-joint">.</span></span> a</li>
 <li><span class="li-num">ii<span class="li-num-joint">.</span></span> b</li>

package/index.js

@@ -6,8 +6,10 @@ module.exports = function numbering_ul_regarded_as_ol_plugin(md, option) {
     //noChangeBulletOneOrderedList: true,
     unsetListRole: true,
     describeListNumber: true,
+    omitTypeNumber: true,
     desdribelistNumterTitle: false,
     listNumberTitleLang: 'en',
+
   };
   if (option !== undefined) {
     for (let o in option) {
@@ -362,7 +364,6 @@ module.exports = function numbering_ul_regarded_as_ol_plugin(md, option) {
 
         //Set list num span element.
         if (opt.describeListNumber) {
-          
           const listNumBeforeToken = new state.Token('text', '', 0);
           const listNumOpenToken = new state.Token('span_open', 'span', 1);
           listNumOpenToken.attrSet('class', 'li-num');
@@ -383,23 +384,36 @@ module.exports = function numbering_ul_regarded_as_ol_plugin(md, option) {
           listNumJointContToken.content = list.flows[lfn].symbols[sn].joint.replace(/ *$/, '');
           const listNumJointCloseToken = new state.Token('span_close', 'span', -1);
 
-          //console.log(state.tokens[cn+2]);
-          if (list.flows[lfn].symbols[sn].typesNum !== 0 || list.flows[lfn].symbols[sn].prefix || list.flows[lfn].symbols[sn].suffix) {
-            //console.log(state.tokens[cn+2]);
 
-            state.tokens[cn+2].content = state.tokens[cn+2].content.replace(list.flows[lfn].symbols[sn].contAll, ' ');
-            state.tokens[cn+2].children[0].content = state.tokens[cn+2].children[0].content.replace(list.flows[lfn].symbols[sn].contAll, ' ');
+          let otn = 0;
+          let isOlTypes = false;
+          while (otn < olTypes.length) {
+            isOlTypes = types[list.flows[lfn].symbols[sn].typesNum].name === olTypes[otn][1] && !list.flows[lfn].symbols[sn].prefix && !list.flows[lfn].symbols[sn].suffix;
+            if (isOlTypes) break;
+            otn++;
+          }
+          if (opt.omitTypeNumber && isOlTypes) {
+            state.tokens[cn+2].content = state.tokens[cn+2].content.replace(list.flows[lfn].symbols[sn].contAll, '');
+            state.tokens[cn+2].children[0].content = state.tokens[cn+2].children[0].content.replace(list.flows[lfn].symbols[sn].contAll, '');
+          } else {
+
+            //console.log(state.tokens[cn+2]);
+            if (list.flows[lfn].symbols[sn].typesNum !== 0 || list.flows[lfn].symbols[sn].prefix || list.flows[lfn].symbols[sn].suffix) {
+            //console.log(state.tokens[cn+2]);
 
+              state.tokens[cn+2].content = state.tokens[cn+2].content.replace(list.flows[lfn].symbols[sn].contAll, ' ');
+              state.tokens[cn+2].children[0].content = state.tokens[cn+2].children[0].content.replace(list.flows[lfn].symbols[sn].contAll, ' ');
 
-            //console.log(list.flows[lfn].symbols[sn])
-            if (/\. */.test(list.flows[lfn].symbols[sn].joint)) {
-              if (/\)/.test(list.flows[lfn].symbols[sn].suffix)) {
-                state.tokens[cn+2].children.splice(0, 0, listNumOpenToken, listNumContToken, listNumCloseToken);
+              //console.log(list.flows[lfn].symbols[sn])
+              if (/\. */.test(list.flows[lfn].symbols[sn].joint)) {
+                if (/\)/.test(list.flows[lfn].symbols[sn].suffix)) {
+                  state.tokens[cn+2].children.splice(0, 0, listNumOpenToken, listNumContToken, listNumCloseToken);
+                } else {
+                state.tokens[cn+2].children.splice(0, 0, listNumOpenToken, listNumContToken, listNumJointOpenToken, listNumJointContToken,listNumJointCloseToken, listNumCloseToken);
+               }
               } else {
-              state.tokens[cn+2].children.splice(0, 0, listNumOpenToken, listNumContToken, listNumJointOpenToken, listNumJointContToken,listNumJointCloseToken, listNumCloseToken);
+                state.tokens[cn+2].children.splice(0, 0, listNumOpenToken, listNumContToken, listNumCloseToken);
               }
-            } else {
-              state.tokens[cn+2].children.splice(0, 0, listNumOpenToken, listNumContToken, listNumCloseToken);
             }
           }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@peaceroad/markdown-it-numbering-ul-regarded-as-ol",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "This markdown-it plugin regard ul element with numbering lists as ol element.",
   "main": "index.js",
   "scripts": {

package/test/examples-spantitle-omit-typeNumber.txt

@@ -0,0 +1,201 @@
+[Markdown]
+1. a
+2. b
+3. c
+[HTML]
+<ol class="ol-decimal">
+<li>a</li>
+<li>b</li>
+<li>c</li>
+</ol>
+
+[Markdown]
+3. a
+4. b
+5. c
+[HTML]
+<ol start="3" class="ol-decimal">
+<li>a</li>
+<li>b</li>
+<li>c</li>
+</ol>
+
+[Markdown]
+1. a
+3. b
+4. c
+[HTML]
+<ol class="ol-decimal">
+<li>a</li>
+<li value="3">b</li>
+<li>c</li>
+</ol>
+
+
+[Markdown]
+- i. a
+- ii. b
+- iii. c
+[HTML]
+<ol type="i" class="ol-lower-roman">
+<li>a</li>
+<li>b</li>
+<li>c</li>
+</ol>
+
+[Markdown]
+- a
+- b
+- c
+[HTML]
+<ul>
+<li>a</li>
+<li>b</li>
+<li>c</li>
+</ul>
+
+[Markdown]
+- ❶ a
+- ❷ b
+- ❸ c
+[HTML]
+<ol class="ol-filled-circled-decimal">
+<li><span class="li-num">❶</span> a</li>
+<li><span class="li-num">❷</span> b</li>
+<li><span class="li-num">❸</span> c</li>
+</ol>
+
+[Markdown]
+2. a
+3. b
+4. c
+[HTML]
+<ol start="2" class="ol-decimal">
+<li>a</li>
+<li>b</li>
+<li>c</li>
+</ol>
+
+[Markdown]
+- ② a
+- ③ b
+- ④ c
+[HTML]
+<ol start="2" class="ol-circled-decimal">
+<li><span class="li-num">②</span> a</li>
+<li><span class="li-num">③</span> b</li>
+<li><span class="li-num">④</span> c</li>
+</ol>
+
+[Markdown]
+- (2). a
+- (3). b
+- (4). c
+[HTML]
+<ol start="2" class="ol-decimal-with-round-round">
+<li><span class="li-num">(2)</span> a</li>
+<li><span class="li-num">(3)</span> b</li>
+<li><span class="li-num">(4)</span> c</li>
+</ol>
+
+[Markdown]
+- 2). a
+- 3). b
+- 4). c
+[HTML]
+<ol start="2" class="ol-decimal-with-none-round">
+<li><span class="li-num">2)</span> a</li>
+<li><span class="li-num">3)</span> b</li>
+<li><span class="li-num">4)</span> c</li>
+</ol>
+
+
+[Markdown]
+1. 項目1
+2. 項目2
+    - i. 項目2-i
+    - ii. 項目2-ii
+    - iii. 項目2-iii
+3. 項目3
+[HTML]
+<ol class="ol-decimal">
+<li>項目1</li>
+<li>項目2
+<ol type="i" class="ol-lower-roman">
+<li>項目2-i</li>
+<li>項目2-ii</li>
+<li>項目2-iii</li>
+</ol>
+</li>
+<li>項目3</li>
+</ol>
+
+[Markdown]
+- i. 項目i
+- ii. 項目ii
+    1. 項目ii-1
+    2. 項目ii-2
+    3. 項目ii-3
+- iii. 項目iii
+[HTML]
+<ol type="i" class="ol-lower-roman">
+<li>項目i</li>
+<li>項目ii
+<ol class="ol-decimal">
+<li>項目ii-1</li>
+<li>項目ii-2</li>
+<li>項目ii-3</li>
+</ol>
+</li>
+<li>項目iii</li>
+</ol>
+
+[Markdown]
+- ❸ 項目❸
+- ❹ 項目❹
+    - ② 項目❹-②
+    - ③ 項目❹-③
+    - ④ 項目❹-④
+- ❺ 項目❺
+[HTML]
+<ol start="3" class="ol-filled-circled-decimal">
+<li><span class="li-num">❸</span> 項目❸</li>
+<li><span class="li-num">❹</span> 項目❹
+<ol start="2" class="ol-circled-decimal">
+<li><span class="li-num">②</span> 項目❹-②</li>
+<li><span class="li-num">③</span> 項目❹-③</li>
+<li><span class="li-num">④</span> 項目❹-④</li>
+</ol>
+</li>
+<li><span class="li-num">❺</span> 項目❺</li>
+</ol>
+
+[Markdown]
+1. 項目1
+2. 項目2
+    - i. 項目2-i
+    - ii. 項目2-ii
+        - a. 項目2-ii-a
+        - b. 項目2-ii-b
+        - c. 項目2-ii-c
+    - iii. 項目2-iii
+3. 項目3
+[HTML]
+<ol class="ol-decimal">
+<li>項目1</li>
+<li>項目2
+<ol type="i" class="ol-lower-roman">
+<li>項目2-i</li>
+<li>項目2-ii
+<ol type="a" class="ol-lower-latin">
+<li>項目2-ii-a</li>
+<li>項目2-ii-b</li>
+<li>項目2-ii-c</li>
+</ol>
+</li>
+<li>項目2-iii</li>
+</ol>
+</li>
+<li>項目3</li>
+</ol>
+

package/test/test.js

@@ -10,9 +10,12 @@ md.use(mdNumUl, {
 
 const md2 = require('markdown-it')();
 md2.use(mdNumUl, {
-  listNumberTitleLang: 'ja',
+  omitTypeNumber: false,
 });
 
+const md3 = require('markdown-it')();
+md3.use(mdNumUl);
+
 let example = __dirname + '/examples.txt';
 let mdPath = __dirname + '/examples.md';
 
@@ -81,4 +84,23 @@ while(n < ms.length) {
   n++;
 }
 
+example = __dirname + '/examples-spantitle-omit-typeNumber.txt';
+ms = [];
+setMs(example, ms);
+
+n = 1;
+while(n < ms.length) {
+  //if (n >= 5) { n++; continue };
+  console.log('Test: ' + n + ' >>>');
+  //console.log(ms[n].markdown);
 
+  const m = ms[n].markdown;
+  const h = md3.render(m);
+  try {
+    assert.strictEqual(h, ms[n].html);
+  } catch(e) {
+    console.log('incorrect: ');
+    console.log('H: ' + h +'C: ' + ms[n].html);
+  };
+  n++;
+}

package/____Markdown].txt

@@ -1,24 +0,0 @@
-[Markdown]
-- 1. a
-- 2. b
-- 3. c
-[HTML]
-<ol class="ol-decimal">
-<li>a</li>
-<li>b</li>
-<li>c</li>
-</ol>
-
-
-[Markdown]
-- 1. a
-    - 10. bb
-- 3. c
-[HTML]
-<ol class="ol-decimal">
-<li>a
-<ol start="10" class="ol-decimal">
-<li>bb</li>
-</ol></li>
-<li>c</li>
-</ol>

package/____Untitled-1.txt

@@ -1,214 +0,0 @@
-function check (state, list, boons, bi) {
-    let bStart = boons[bi][0];
-    let bEnd = boons[bi][1];
-    console.log('check:: list.flows.length: ' + list.flows.length + ' , bStart: ' + bStart + ', type: ' + list.flows[bStart].type);
-    let bpos = list.flows[bStart].pos;
-    list.flows[bStart].type = 'numbering_' + list.flows[bStart].type;
-    list.flows[bStart].psTypes = list.flows[bStart+2].psTypes;
-    let startValue = -1;
-    let liCount = 0;
-    let sbn = []; // shifted bStarts number;
-    let i = bStart + 1;
-    let dlfn = 0; // deleted list.flow number
-    let dstn = 0; // deleteed state.tokens number
-    let isCheckedBullet = true;
-    let hasPrevBullet = false;
- 
-    while (i < list.flows.length) {
-      console.log('---------------------------------');
-      console.log('i: ' + i + ', dstn: ' + dstn + ', dlfn: ' + dlfn + ', pos: ' + list.flows[i].pos + ', type: ' + list.flows[i].type + ', level(i): ' + list.flows[i].level + ', level(bStart): ' + list.flows[bStart].level);
-
-      list.flows[i].pos -= dstn;
-      let lfpos = list.flows[i].pos;
-
-
-      let j = i;
-      while (j < boons.length) {
-        if (boons[j].start < i) {
-          sbn[j].start = dlfn;
-        }
-        if (boons[j].end < i) {
-          sbn[j].end = dlfn;
-        }
-        j++;
-      }
-
-      let bEndNow = bEnd - dlfn;
-
-      console.log('now bEndNow: ' + bEndNow);
-
-      if (list.flows[i].type === 'bullet_list_close' && list.flows[i].level === list.flows[bpos].level && isCheckedBullet) {
-        list.flows[i].type = 'numbering_' + list.flows[i].type;
-        // Delete </ol></li> of last list.
-        //console.log('Delete0: ' + state.tokens[lfpos - 2].type + ', ' + state.tokens[lfpos - 1].type);
-        console.log('Delete0: ' + state.tokens[lfpos - 2].type);
-        console.log(state.tokens[lfpos - 1].type);
-        state.tokens.splice(lfpos - 2, 2);
-        list.flows.splice(i - 1, 1);
-        dlfn += 1;
-        dstn += 2;
-        lfpos -= 2;
-        i--;
-        list.flows[i].pos -= 2;
-        state.tokens[lfpos].tag = 'ol';
-        console.log('lfpos: ' + lfpos + ', list.flows[i].type: ' + list.flows[i].type);
-        isCheckedBullet = false;
-        console.log(list.flows);
-        console.log('(i: ' + i + ', list.flows.length: ' + list.flows.length + ')');
-
-        i++;
-        continue;
-      }
-
-      if(list.flows[i].type === 'bullet_list_open' && list.flows[i].level === list.flows[bStart].level + 1 && list.flows[i].isBulletOneOrdered) {
-        liCount++;
-        hasPrevBullet = true;
-        console.log('bullet open process:: type: ' + list.flows[i].type + ', pos: ' + lfpos + ', dlfn: ' + dlfn + ', dstn: ' + dstn);
-        console.log('Delete1: ' + list.flows[i-1].type + ', pos: ' + lfpos + ', dstn: ' + dstn + ', dlfn: ' + dlfn );
-        list.flows.splice(i - 1, 1);
-        continue;
-      }
-
-      if (list.flows[i].type === 'list_item_open' && isCheckedBullet) {
-        console.log('hasPrevBullet: ' + hasPrevBullet);
-        console.log('list.flows[i].level: ' + list.flows[i].level + ', list.flows[bpos].level: ' + list.flows[bpos].level);
-        if (list.flows[i].level === list.flows[bStart].level) {
-          liCount++;
-
-          console.log('Delete1: list:flows[i].type: ' + list.flows[i].type + ', list.flows[i+1].type: ' + list.flows[i+1].type);
-          console.log('Delete2: state.tokens[lfpos].type: ' + state.tokens[lfpos].type + ', state.tokens[lfpos + 1].type: ' + state.tokens[lfpos + 1].type);
-          state.tokens.splice(lfpos, 2);
-          list.flows.splice(i, 2);
-          dstn += 2;
-          dlfn += 2;
-
-          if (liCount > 1) {
-            //lfpos -= dstn;
-            if (!hasPrevBullet) {
-              console.log('Delete3: state.tokens[lfpos - 2].type: ' + state.tokens[lfpos - 2].type + ', state.tokens[lfpos - 1].type: ' + state.tokens[lfpos - 1].type);
-              console.log('Delete4: ' + list.flows[i-1].type);
-  
-              state.tokens.splice(lfpos - 2, 2);
-              list.flows.splice(i-1, 1);
-              console.log('list.flows[i-1].pos: ' + list.flows[i-1].pos + ', list.flows[i-1].type: ' + list.flows[i-1].type);
-              dstn += 2;
-              dlfn += 1;
-              i--;
-            }
-          }
-
-          if (hasPrevBullet) {
-            hasPrevBullet = false;
-          }
-          continue;
-
-        }
-        /// list.level;
-        if (list.flows[i].level === list.flows[bStart].level + 1) {
-          console.log('list process:: type: ' + list.flows[i].type);
-
-          list.flows[i].level -= 1;
-          console.log('Change list.flows[i].level: ' + list.flows[i].level);
-
-          //console.log('Moved: lfpos: ' + lfpos + ', state.tokens[lfpos].type: ' + state.tokens[lfpos].type);
-          
-          i++;
-          continue;
-
-        }
-      }
-      console.log('normal process:: type: ' + list.flows[i].type);
-      //console.log('B: state.tokens[lfpos].type: ' + state.tokens[lfpos].type);
-      if (i <= bEndNow) {
-       // list.flows[i].level -= 1;
-      }
-      console.log('Moved: lfpos: ' + lfpos +', state.tokens[lfpos].type: ' + state.tokens[lfpos].type);
-      i++;
-    }
-
-    console.log('list.flows.length: ' + list.flows.length + ', state.tokens.length: ' + state.tokens.length);
-    //console.log(list.flows);
-
-    let k = bi + 1;
-    while (k < boons.length) {
-      if (sbn[k] !== undefined) {
-        boons[k].start -= sbn[k];
-        boons[k].end -= sbn[k];
-      }
-      k++;
-    }
-    return boons;
-  }
-
-
-    let bi = 0;
-    let boons = [];
-    while (bi < boonsStarts.length) {
-      let j = boonsStarts[bi] + 1;
-      while (j < list.flows.length) {
-        if(list.flows[j].type === 'bullet_list_close' && list.flows[j].level === list.flows[boonsStarts[bi]].level) {
-          list.flows[j].isBulletOneOrderedClose = true;
-          boons.push([boonsStarts[bi], j]);
-          break;
-        }
-        j++;
-      }
-      bi++;
-    }
-    console.log('list.flows.length: ' + list.flows.length + ', boons: ' + boons);
-
-    bi = 0;
-    while (bi < boons.length) {
-      console.log('boon: ' + boons[bi] + ' =======================================');
-      console.log(list.flows);
-      boons = check(state, list, boons, bi);
-      console.log('changed boons: ' + boons);
-      bi++;
-    }
-    console.log('--------------');
-    console.log(list.flows);
-    console.log('--------------');
-    //console.log(state.tokens);
-    console.log('--------------');
-    return;
-  }
-
-function modifyBulletOneOrderedList (state, n, list) {
-    let lfn = 0;
-    let boonsStarts = [];
-    while (lfn < list.flows.length) {
-      if (lfn + 3 > list.flows.length) {break;}
-      if (!/numbering_ordered_list_open/.test(list.flows[lfn].type)) {
-        lfn++; continue;
-      }
-      //Set bullet one ordederd flag.
-      let isOneOrdered = false;
-      if (/numbering_ordered_list_close/.test(list.flows[lfn+2].type)) {
-        isOneOrdered = true;
-      }
-      let isParentBullet = false;
-      let k = lfn;
-      while (k > -1) {
-        if (list.flows[k].type === 'bullet_list_open' && list.flows[k].level === list.flows[lfn].level - 1) {
-          isParentBullet = true;
-          break;
-        }
-        k--;
-      }
-      console.log('lfn: ' + lfn + ', k: ' + k + ', isOneOrdered: ' + isOneOrdered + ', isParentBullet: ' + isParentBullet);
-      if (!isParentBullet) {lfn++; continue;} 
-
-      if (isOneOrdered) {
-        list.flows[k].isBulletOneOrdered = true;
-        if (!boonsStarts.includes(k)) {
-          boonsStarts.push(k);
-        }
-      } else {
-        list.flows[k].isBulletOneOrdered = false;
-        let bk = boonsStarts.indexOf(k);
-        if (bk) {
-          boonsStarts.splice(bk, 1);
-        }
-      }
-      lfn++;
-    }