feat: Added extractText config option

README.md

@@ -122,6 +122,7 @@ Pass a stringified JSON object (must be `JSON.parse()`-able) as an option for in
 | wrapperLabel | `undefined` | string | `aria-label` on element wrapping toc lists |
 | ul | `false` | boolean | lists are `ul` if true, `ol` if `false` |
 | flat | `false` | boolean | use flat list if `true`; use nested lists if false |
+| extractText | `undefined` | function | A function that can be used to extract the text from the heading (if custom processing is needed). It receives the cheerio header element as argument |
 
 ## Roadmap
 

src/BuildTOC.js

@@ -11,6 +11,7 @@ const defaults = {
   wrapperLabel: undefined,
   ul: false,
   flat: false,
+  extractText: undefined,
 }
 
 const BuildTOC = (text, opts) => {
@@ -21,7 +22,7 @@ const BuildTOC = (text, opts) => {
 
   const $ = cheerio.load(text)
 
-  const headings = NestHeadings(tags, $)
+  const headings = NestHeadings(tags, opts.extractText, $)
 
   if (headings.length === 0) {
     return undefined

src/NestHeadings.js

@@ -1,10 +1,10 @@
 const SimplifyResults = require('./SimplifyResults')
 
-const NestHeadings = (tags, $) => {
+const NestHeadings = (tags, extractText, $) => {
   const temp = {}
 
   tags.forEach(t => {
-    temp[t] = SimplifyResults(t, tags, $)
+    temp[t] = SimplifyResults(t, tags, extractText, $)
   })
 
   const headings = []

src/SimplifyResults.js

@@ -1,10 +1,14 @@
-const SimplifyResults = (tag, tags, $) => {
+const SimplifyResults = (tag, tags, extractText, $) => {
   const results = []
 
   $(`${tag}[id]`).each((i, el) => {
     const tag = el.name
     const id = $(el).attr('id')
-    const text = $(el).text().replace(' #', '')
+    let baseText = $(el).text()
+    if (typeof extractText === 'function') {
+      baseText = extractText($(el))
+    }
+    let text = baseText.replace(' #', '')
     const hierarchy = tags.indexOf(tag)
     const parent =
       hierarchy > 0 &&