Merge pull request #45 from johansatge/ordered-list

Refactor nested ordered list + tests
johansatge · May 19, 2024 · 2045754 · 2045754
2 parents 3c91704 + cd827a4
commit 2045754
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 16 deletions.
diff --git a/README.md b/README.md
@@ -49,7 +49,7 @@ The following options are available:
 | Option | Default value | Description |
 | --- | --- | --- |
 | `title` | _None_ | Title to display before the table of contents (supports Markdown) |
-| `style` | `nestedList` | Table of contents style (can be `nestedList` or `inlineFirstLevel`) |
+| `style` | `nestedList` | Table of contents style (can be `nestedList`, `nestedOrderedList` or `inlineFirstLevel`) |
 | `minLevel` | `0` | Include headings from the specified level  (`0` for no limit) |
 | `maxLevel` | `0` | Include headings up to the specified level (`0` for no limit) |
 | `includeLinks` | `true` | Make headings clickable |

diff --git a/main.js b/main.js
@@ -23,7 +23,7 @@ const availableOptions = {
     type: 'value',
     default: 'nestedList',
     values: ['nestedList', 'nestedOrderedList', 'inlineFirstLevel'],
-    comment: 'TOC style (nestedList|inlineFirstLevel)',
+    comment: 'TOC style (nestedList|nestedOrderedList|inlineFirstLevel)',
   },
   minLevel: {
     type: 'number',
@@ -140,30 +140,23 @@ function getMarkdownFromHeadings(headings, options) {
 }
 
 function getMarkdownNestedListFromHeadings(headings, options) {
-  const lines = []
-  const minLevel = options.minLevel > 0
-    ? options.minLevel
-    : Math.min(...headings.map((heading) => heading.level))
-  headings.forEach((heading) => {
-    if (heading.level < minLevel) return
-    if (options.maxLevel > 0 && heading.level > options.maxLevel) return
-    lines.push(`${'\t'.repeat(heading.level - minLevel)}- ${getMarkdownHeading(heading, options)}`)
-  })
-  return lines.length > 0 ? lines.join('\n') : null
+  return getMarkdownListFromHeadings(headings, false, options)
 }
 
 function getMarkdownNestedOrderedListFromHeadings(headings, options) {
+  return getMarkdownListFromHeadings(headings, true, options)
+}
+
+function getMarkdownListFromHeadings(headings, isOrdered, options) {
+  const prefix = isOrdered ? '1.' : '-'
   const lines = []
-  const levelEntries = {}
   const minLevel = options.minLevel > 0
     ? options.minLevel
     : Math.min(...headings.map((heading) => heading.level))
   headings.forEach((heading) => {
     if (heading.level < minLevel) return
     if (options.maxLevel > 0 && heading.level > options.maxLevel) return
-    if (!levelEntries[heading.level]) levelEntries[heading.level] = 1
-    lines.push(`${'\t'.repeat(heading.level - minLevel)}${levelEntries[heading.level]}. ${getMarkdownHeading(heading, options)}`)
-    levelEntries[heading.level] += 1
+    lines.push(`${'\t'.repeat(heading.level - minLevel)}${prefix} ${getMarkdownHeading(heading, options)}`)
   })
   return lines.length > 0 ? lines.join('\n') : null
 }

diff --git a/test/headings.test.js b/test/headings.test.js
@@ -57,6 +57,21 @@ describe('Headings', () => {
     expect(md).toEqual(expectedMd)
   })
 
+  test('Returns indented ordered list with links', () => {
+    const options = parseOptionsFromSourceText('')
+    options.style = 'nestedOrderedList'
+    const md = getMarkdownFromHeadings(testStandardHeadings, options)
+    const expectedMd = sanitizeMd(`
+1. [[#Title 1 level 1|Title 1 level 1]]
+  1. [[#Title 1 level 2|Title 1 level 2]]
+    1. [[#Title 1 level 3|Title 1 level 3]]
+1. [[#Title 2 level 1|Title 2 level 1]]
+1. [[#Title 3 level 1|Title 3 level 1]]
+  1. [[#Title 3 level 2|Title 3 level 2]]
+`)
+    expect(md).toEqual(expectedMd)
+  })
+
   test('Returns indented list with min level', () => {
     const options = parseOptionsFromSourceText('')
     options.minLevel = 2