md-processor 1.0.0 → 1.1.0

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,7 +62,7 @@ class Markdown {
       if (parsed) {
         this.append({
           header: parsed[2],
-          level: parsed[1]
+          level: parsed[1].length
         })
       }
 

package/lib/Processor.js

@@ -22,15 +22,26 @@ 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')
+
+      imports.set(text, { deep, header, importPath })
     }
 
-    for (const [text, { header, importPath }] of imports) {
+    for (const [text, { deep, 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).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.1.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()

package/test/Processor.test.js

@@ -35,5 +35,13 @@ describe('Processor', () => {
 
       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)
+    })
   })
 })

package/test/support/examples.js

@@ -1,7 +1,7 @@
 const multiBlock = (() => {
   const blocks = [{
     header: 'Header 1',
-    level: '#',
+    level: 1,
     lines: [
       '# Header 1',
       'First line of the body of header 1',
@@ -9,7 +9,7 @@ const multiBlock = (() => {
     ]
   }, {
     header: 'Header 1.1',
-    level: '##',
+    level: 2,
     lines: [
       '## Header 1.1',
       'First line of the body of header 1.1',
@@ -31,7 +31,7 @@ const multiImports = (() => {
     ...multiBlock.blocks,
     {
       header: 'Header 2',
-      level: '#',
+      level: 1,
       lines: [
         '# Header 2',
         'First line of the body of header 2',
@@ -39,7 +39,7 @@ const multiImports = (() => {
       ]
     }, {
       header: 'Header 2.1',
-      level: '##',
+      level: 2,
       lines: [
         '## Header 2.1',
         'First line of the body of header 2.1',
@@ -58,7 +58,10 @@ const multiImports = (() => {
   }
 })()
 
+const importDeep = multiImports
+
 export {
+  importDeep,
   multiBlock,
   multiImports
 }

package/test/support/import-deep.md

@@ -0,0 +1,7 @@
+@[import{Header 1,deep}](multiBlock.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