md-processor 1.0.0 → 1.2.0

package/README.md

@@ -20,9 +20,12 @@ nxp md-processor input.md > output.md
 Sections of other markdown files can be imported like this:
 
 ```markdown
-@[import{section}](filename)
+@[import{section,deep,depth=x}](filename)
 ```
 
-- `section`: The full header of the section to import
+- `section`: The full header of the section to import.
+- `deep`: If given, the nested blocks will be imported.
+- `depth`: Change the level of the headers by adding `x`.
+  `x` can be positive or negative.
 - `filename`: The path to the markdown file to import.
   The path is relative to the input file.

package/lib/Block.js

@@ -1,16 +1,30 @@
 class Block {
-  constructor ({ header = null, level = 0 } = {}) {
+  constructor ({ header = null, level = 0, lines = [] } = {}) {
     this.header = header
     this.level = level
-    this.lines = []
+    this.lines = lines
   }
 
   append (line) {
     this.lines.push(line)
   }
 
+  changeLevel (depth) {
+    return new Block({
+      header: this.header,
+      level: this.level + depth,
+      lines: this.lines
+    })
+  }
+
   toString () {
-    return this.lines.join('\n')
+    let headerLine = ''
+
+    if (this.level > 0) {
+      headerLine = `${'#'.repeat(this.level)} ${this.header}\n`
+    }
+
+    return `${headerLine}${this.lines.join('\n')}`
   }
 }
 

package/lib/Markdown.js

@@ -26,6 +26,33 @@ class Markdown {
     return this.blocks.find(block => block.header === header)
   }
 
+  getAll (header) {
+    const root = this.get(header)
+
+    if (!root) {
+      return []
+    }
+
+    const matches = []
+    let index = this.blocks.indexOf(root)
+
+    for (;;) {
+      matches.push(this.blocks[index])
+
+      const next = this.blocks[++index]
+
+      if (!next) {
+        break
+      }
+
+      if (next.level <= root.level) {
+        break
+      }
+    }
+
+    return matches
+  }
+
   parse (content) {
     const lines = content.split('\n')
 
@@ -35,11 +62,11 @@ class Markdown {
       if (parsed) {
         this.append({
           header: parsed[2],
-          level: parsed[1]
+          level: parsed[1].length
         })
+      } else {
+        this.last.append(line)
       }
-
-      this.last.append(line)
     }
 
     return this

package/lib/Processor.js

@@ -22,15 +22,31 @@ class Processor {
   async processImports ({ content, path }) {
     const imports = new Map()
 
-    for (const [text, header, importPath] of [...content.matchAll(parseImportRegex)]) {
-      imports.set(text, { header, importPath })
+    for (const [text, args, importPath] of [...content.matchAll(parseImportRegex)]) {
+      const [header, ...others] = args.split(',')
+      const deep = others.includes('deep')
+      const depth = others
+        .filter(other => other.startsWith('depth='))
+        .map(raw => parseInt(raw.split('=')[1]))[0]
+
+      imports.set(text, { deep, depth, header, importPath })
     }
 
-    for (const [text, { header, importPath }] of imports) {
+    for (const [text, { deep, depth = 0, header, importPath }] of imports) {
       const resolved = resolve(dirname(path), importPath)
       const markdown = await Markdown.load(resolved)
 
-      content = content.replaceAll(text, markdown.get(header))
+      let imported
+
+      if (deep) {
+        imported = markdown.getAll(header)
+          .map(block => block.changeLevel(depth).toString())
+          .join('\n')
+      } else {
+        imported = markdown.get(header)
+      }
+
+      content = content.replaceAll(text, imported)
     }
 
     return content

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "md-processor",
-  "version": "1.0.0",
+  "version": "1.2.0",
   "description": "A preprocessor for markdown files",
   "type": "module",
   "main": "index.js",

package/test/Markdown.test.js

@@ -91,6 +91,42 @@ describe('Markdown', () => {
     })
   })
 
+  describe('.getAll', () => {
+    it('should be a method', () => {
+      const markdown = new Markdown()
+
+      strictEqual(typeof markdown.getAll, 'function')
+    })
+
+    it('should return all blocks linked to the matching header', () => {
+      const markdown = new Markdown()
+        .append({ header: 'abc' })
+        .append({ header: 'def', level: 1 })
+        .append({ header: 'def 1', level: 2 })
+        .append({ header: 'def 1.1', level: 3 })
+        .append({ header: 'def 2', level: 2 })
+        .append({ header: 'ghi' })
+
+      const result = markdown.getAll('def', { deep: true })
+
+      strictEqual(Array.isArray(result), true)
+      strictEqual(result.length, 4)
+      strictEqual(result[0].header, 'def')
+      strictEqual(result[1].header, 'def 1')
+      strictEqual(result[2].header, 'def 1.1')
+      strictEqual(result[3].header, 'def 2')
+    })
+
+    it('should return an empty Array no matching block was found', () => {
+      const markdown = new Markdown()
+
+      const result = markdown.getAll('def')
+
+      strictEqual(Array.isArray(result), true)
+      strictEqual(result.length, 0)
+    })
+  })
+
   describe('.parse', () => {
     it('should be a method', () => {
       const markdown = new Markdown()
@@ -119,7 +155,7 @@ describe('Markdown', () => {
     })
 
     it('should parse the given file', async () => {
-      const markdown = await Markdown.load('./test/support/multiBlock.md')
+      const markdown = await Markdown.load('./test/support/multi-block.md')
 
       strictEqual(markdown.blocks[0].header, examples.multiBlock.blocks[0].header)
       strictEqual(markdown.blocks[0].level, examples.multiBlock.blocks[0].level)

package/test/Processor.test.js

@@ -31,9 +31,33 @@ describe('Processor', () => {
     it('should process all imports', async () => {
       const processor = new Processor()
 
-      const result = await processor.process('./test/support/multiImports.md')
+      const result = await processor.process('./test/support/multi-imports.md')
 
       strictEqual(result, examples.multiImports.content)
     })
+
+    it('should process deep imports', async () => {
+      const processor = new Processor()
+
+      const result = await processor.process('./test/support/import-deep.md')
+
+      strictEqual(result, examples.importDeep.content)
+    })
+
+    it('should process deep with decreasing depth change', async () => {
+      const processor = new Processor()
+
+      const result = await processor.process('./test/support/import-deep-change-minus.md')
+
+      strictEqual(result, examples.importDeepChangeMinus.content)
+    })
+
+    it('should process deep with increasing depth change', async () => {
+      const processor = new Processor()
+
+      const result = await processor.process('./test/support/import-deep-change-plus.md')
+
+      strictEqual(result, examples.importDeepChangePlus.content)
+    })
   })
 })

package/test/support/examples.js

@@ -1,17 +1,27 @@
+function blocksToContent (blocks) {
+  return blocks.map(block => {
+    let headerLine = ''
+
+    if (block.level > 0) {
+      headerLine = `${'#'.repeat(block.level)} ${block.header}\n`
+    }
+
+    return `${headerLine}${block.lines.join('\n')}`
+  }).join('\n')
+}
+
 const multiBlock = (() => {
   const blocks = [{
     header: 'Header 1',
-    level: '#',
+    level: 1,
     lines: [
-      '# Header 1',
       'First line of the body of header 1',
       'Second line of the body of header 1'
     ]
   }, {
     header: 'Header 1.1',
-    level: '##',
+    level: 2,
     lines: [
-      '## Header 1.1',
       'First line of the body of header 1.1',
       'Second line of the body of header 1.1'
     ]
@@ -19,10 +29,7 @@ const multiBlock = (() => {
 
   return {
     blocks,
-    content: [
-      blocks[0].lines.join('\n'),
-      blocks[1].lines.join('\n')
-    ].join('\n')
+    content: blocksToContent(blocks)
   }
 })()
 
@@ -31,17 +38,15 @@ const multiImports = (() => {
     ...multiBlock.blocks,
     {
       header: 'Header 2',
-      level: '#',
+      level: 1,
       lines: [
-        '# Header 2',
         'First line of the body of header 2',
         'Second line of the body of header 2'
       ]
     }, {
       header: 'Header 2.1',
-      level: '##',
+      level: 2,
       lines: [
-        '## Header 2.1',
         'First line of the body of header 2.1',
         'Second line of the body of header 2.1'
       ]
@@ -49,16 +54,69 @@ const multiImports = (() => {
 
   return {
     blocks,
-    content: [
-      blocks[0].lines.join('\n'),
-      blocks[1].lines.join('\n'),
-      blocks[2].lines.join('\n'),
-      blocks[3].lines.join('\n')
-    ].join('\n')
+    content: blocksToContent(blocks)
+  }
+})()
+
+const importDeep = multiImports
+
+const importDeepChangeMinus = (() => {
+  const blocks = [
+    {
+      level: 0,
+      lines: [
+        'First line of the body of header 1',
+        'Second line of the body of header 1'
+      ]
+    }, {
+      header: 'Header 1.1',
+      level: 1,
+      lines: [
+        'First line of the body of header 1.1',
+        'Second line of the body of header 1.1'
+      ]
+    },
+    importDeep.blocks[2],
+    importDeep.blocks[3]
+  ]
+
+  return {
+    blocks,
+    content: blocksToContent(blocks)
+  }
+})()
+
+const importDeepChangePlus = (() => {
+  const blocks = [
+    {
+      header: 'Header 1',
+      level: 3,
+      lines: [
+        'First line of the body of header 1',
+        'Second line of the body of header 1'
+      ]
+    }, {
+      header: 'Header 1.1',
+      level: 4,
+      lines: [
+        'First line of the body of header 1.1',
+        'Second line of the body of header 1.1'
+      ]
+    },
+    importDeep.blocks[2],
+    importDeep.blocks[3]
+  ]
+
+  return {
+    blocks,
+    content: blocksToContent(blocks)
   }
 })()
 
 export {
+  importDeep,
+  importDeepChangeMinus,
+  importDeepChangePlus,
   multiBlock,
   multiImports
 }

package/test/support/{multiImports.md → import-deep-change-minus.md}

@@ -1,5 +1,4 @@
-@[import{Header 1}](multiBlock.md)
-@[import{Header 1.1}](multiBlock.md)
+@[import{Header 1,deep,depth=-1}](multi-block.md)
 # Header 2
 First line of the body of header 2
 Second line of the body of header 2

package/test/support/import-deep-change-plus.md

@@ -0,0 +1,7 @@
+@[import{Header 1,deep,depth=+2}](multi-block.md)
+# Header 2
+First line of the body of header 2
+Second line of the body of header 2
+## Header 2.1
+First line of the body of header 2.1
+Second line of the body of header 2.1

package/test/support/import-deep.md

@@ -0,0 +1,7 @@
+@[import{Header 1,deep}](multi-block.md)
+# Header 2
+First line of the body of header 2
+Second line of the body of header 2
+## Header 2.1
+First line of the body of header 2.1
+Second line of the body of header 2.1

package/test/support/multi-imports.md

@@ -0,0 +1,8 @@
+@[import{Header 1}](multi-block.md)
+@[import{Header 1.1}](multi-block.md)
+# Header 2
+First line of the body of header 2
+Second line of the body of header 2
+## Header 2.1
+First line of the body of header 2.1
+Second line of the body of header 2.1