md-processor 1.0.0

package/.github/workflows/test.yaml

@@ -0,0 +1,21 @@
+name: Test
+on:
+  - pull_request
+  - push
+jobs:
+  test:
+    runs-on: ubuntu-20.04
+    strategy:
+      matrix:
+        node:
+          - '16'
+          - '18'
+          - '20'
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node }}
+      - run: npm install
+      - run: npm test
+      - uses: codecov/codecov-action@v3

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Thomas Bergwinkl
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,28 @@
+# md-processor
+
+[![build status](https://img.shields.io/github/actions/workflow/status/bergos/md-processor/test.yaml?branch=master)](https://github.com/bergos/md-processor/actions/workflows/test.yaml)
+[![npm version](https://img.shields.io/npm/v/md-processor.svg)](https://www.npmjs.com/package/md-processor)
+
+A preprocessor for markdown files.
+
+## Usage
+
+You can run `md-processor` with `npx` like shown below: 
+
+```bash
+nxp md-processor input.md > output.md
+```
+
+## Features
+
+### Imports
+
+Sections of other markdown files can be imported like this:
+
+```markdown
+@[import{section}](filename)
+```
+
+- `section`: The full header of the section to import
+- `filename`: The path to the markdown file to import.
+  The path is relative to the input file.

package/bin/md-processor.js

@@ -0,0 +1,17 @@
+#!/usr/bin/env node
+
+import { Command } from 'commander'
+import Processor from '../lib/Processor.js'
+
+const program = new Command()
+
+program
+  .argument('<input>', 'markdown to process')
+  .action(async input => {
+    const processor = new Processor()
+    const result = await processor.process(input)
+
+    process.stdout.write(result)
+  })
+
+program.parse(process.argv)

package/index.js

@@ -0,0 +1,9 @@
+import Processor from './lib/Processor.js'
+
+async function main () {
+  const processor = new Processor()
+
+  console.log(await processor.process('../../rdf-ext/rdf-ext.org/template/index.md'))
+}
+
+main()

package/lib/Block.js

@@ -0,0 +1,17 @@
+class Block {
+  constructor ({ header = null, level = 0 } = {}) {
+    this.header = header
+    this.level = level
+    this.lines = []
+  }
+
+  append (line) {
+    this.lines.push(line)
+  }
+
+  toString () {
+    return this.lines.join('\n')
+  }
+}
+
+export default Block

package/lib/Markdown.js

@@ -0,0 +1,55 @@
+import { readFile } from 'node:fs/promises'
+import Block from './Block.js'
+
+const parseHeaderRegex = /(#+) (.*)/
+
+class Markdown {
+  constructor () {
+    this.blocks = []
+  }
+
+  get isEmpty () {
+    return this.blocks.length === 0
+  }
+
+  get last () {
+    return this.blocks[this.blocks.length - 1]
+  }
+
+  append ({ header, level } = {}) {
+    this.blocks.push(new Block({ header, level }))
+
+    return this
+  }
+
+  get (header) {
+    return this.blocks.find(block => block.header === header)
+  }
+
+  parse (content) {
+    const lines = content.split('\n')
+
+    for (const line of lines) {
+      const parsed = line.match(parseHeaderRegex)
+
+      if (parsed) {
+        this.append({
+          header: parsed[2],
+          level: parsed[1]
+        })
+      }
+
+      this.last.append(line)
+    }
+
+    return this
+  }
+
+  static async load (path) {
+    const content = (await readFile(path)).toString()
+
+    return new Markdown().parse(content)
+  }
+}
+
+export default Markdown

package/lib/Processor.js

@@ -0,0 +1,40 @@
+import { readFile } from 'node:fs/promises'
+import { dirname, resolve } from 'node:path'
+import Markdown from './Markdown.js'
+
+const parseImportRegex = /@\[import{([^}]*)}]\(([^)]*)\)/g
+
+class Processor {
+  constructor ({ path } = {}) {
+    this.path = path || process.cwd()
+  }
+
+  async process (path) {
+    path = resolve(this.path, path)
+
+    let content = (await readFile(path)).toString()
+
+    content = await this.processImports({ content, path })
+
+    return content
+  }
+
+  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, { header, importPath }] of imports) {
+      const resolved = resolve(dirname(path), importPath)
+      const markdown = await Markdown.load(resolved)
+
+      content = content.replaceAll(text, markdown.get(header))
+    }
+
+    return content
+  }
+}
+
+export default Processor

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "md-processor",
+  "version": "1.0.0",
+  "description": "A preprocessor for markdown files",
+  "type": "module",
+  "main": "index.js",
+  "bin": {
+    "md-processor": "bin/md-processor.js"
+  },
+  "scripts": {
+    "test": "stricter-standard && c8 --reporter=lcov --reporter=text-summary mocha"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/bergos/md-processor.git"
+  },
+  "keywords": [],
+  "author": "Thomas Bergwinkl <bergi@axolotlfarm.org> (https://www.bergnet.org/people/bergi/card#me)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/bergos/md-processor/issues"
+  },
+  "homepage": "https://github.com/bergos/md-processor",
+  "dependencies": {
+    "commander": "^10.0.1"
+  },
+  "devDependencies": {
+    "c8": "^7.14.0",
+    "mocha": "^10.2.0",
+    "stricter-standard": "^0.2.0"
+  }
+}

package/test/Block.test.js

@@ -0,0 +1,60 @@
+import { strictEqual } from 'node:assert'
+import { describe, it } from 'mocha'
+import Block from '../lib/Block.js'
+
+describe('Block', () => {
+  it('should be a constructor', () => {
+    strictEqual(typeof Block, 'function')
+  })
+
+  it('should assign the given header argument', () => {
+    const header = {}
+    const block = new Block({ header })
+
+    strictEqual(block.header, header)
+  })
+
+  it('should assign the given level argument', () => {
+    const level = {}
+    const block = new Block({ level })
+
+    strictEqual(block.level, level)
+  })
+
+  it('should have an empty array property named lines', () => {
+    const block = new Block()
+
+    strictEqual(Array.isArray(block.lines), true)
+    strictEqual(block.lines.length, 0)
+  })
+
+  describe('.append', () => {
+    it('should be a method', () => {
+      const block = new Block()
+
+      strictEqual(typeof block.append, 'function')
+    })
+
+    it('should append the given line', () => {
+      const line = 'test'
+      const block = new Block()
+
+      block.append(line)
+
+      strictEqual(block.lines.length, 1)
+      strictEqual(block.lines[0], line)
+    })
+  })
+
+  describe('.toString', () => {
+    it('should return all lines joined by a line break', () => {
+      const lines = ['abc', 'def']
+      const block = new Block()
+
+      block.append(lines[0])
+      block.append(lines[1])
+
+      strictEqual(block.toString(), lines.join('\n'))
+    })
+  })
+})

package/test/Markdown.test.js

@@ -0,0 +1,133 @@
+import { deepStrictEqual, strictEqual } from 'node:assert'
+import { describe, it } from 'mocha'
+import Markdown from '../lib/Markdown.js'
+import * as examples from './support/examples.js'
+
+describe('Markdown', () => {
+  it('should be a constructor', () => {
+    strictEqual(typeof Markdown, 'function')
+  })
+
+  it('should have an empty array property named blocks', () => {
+    const markdown = new Markdown()
+
+    strictEqual(Array.isArray(markdown.blocks), true)
+    strictEqual(markdown.blocks.length, 0)
+  })
+
+  describe('.isEmpty', () => {
+    it('should be a boolean property', () => {
+      const markdown = new Markdown()
+
+      strictEqual(typeof markdown.isEmpty, 'boolean')
+    })
+  })
+
+  describe('.last', () => {
+    it('should be a property pointing to the last block', () => {
+      const markdown = new Markdown().append({}).append({})
+
+      strictEqual(markdown.last, markdown.blocks[1])
+    })
+
+    it('should be undefined if the object is empty', () => {
+      const markdown = new Markdown()
+
+      strictEqual(typeof markdown.last, 'undefined')
+    })
+  })
+
+  describe('.append', () => {
+    it('should be a method', () => {
+      const markdown = new Markdown()
+
+      strictEqual(typeof markdown.append, 'function')
+    })
+
+    it('should append a new block with the given header and level', () => {
+      const header = 'test'
+      const level = '###'
+      const markdown = new Markdown()
+
+      markdown.append({ header, level })
+
+      strictEqual(markdown.blocks.length, 1)
+      strictEqual(markdown.blocks[0].header, header)
+      strictEqual(markdown.blocks[0].level, level)
+    })
+
+    it('should return this', () => {
+      const markdown = new Markdown()
+
+      const result = markdown.append({})
+
+      strictEqual(result, markdown)
+    })
+  })
+
+  describe('.get', () => {
+    it('should be a method', () => {
+      const markdown = new Markdown()
+
+      strictEqual(typeof markdown.get, 'function')
+    })
+
+    it('should return the block with the matching header', () => {
+      const markdown = new Markdown()
+        .append({ header: 'abc' })
+        .append({ header: 'def' })
+
+      const result = markdown.get('def')
+
+      strictEqual(result.header, 'def')
+    })
+
+    it('should return undefined if no matching block was found', () => {
+      const markdown = new Markdown()
+
+      const result = markdown.get('def')
+
+      strictEqual(typeof result, 'undefined')
+    })
+  })
+
+  describe('.parse', () => {
+    it('should be a method', () => {
+      const markdown = new Markdown()
+
+      strictEqual(typeof markdown.parse, 'function')
+    })
+
+    it('should parse the given content', () => {
+      const markdown = new Markdown()
+
+      markdown.parse(examples.multiBlock.content)
+
+      strictEqual(markdown.blocks[0].header, examples.multiBlock.blocks[0].header)
+      strictEqual(markdown.blocks[0].level, examples.multiBlock.blocks[0].level)
+      deepStrictEqual(markdown.blocks[0].lines, examples.multiBlock.blocks[0].lines)
+
+      strictEqual(markdown.blocks[1].header, examples.multiBlock.blocks[1].header)
+      strictEqual(markdown.blocks[1].level, examples.multiBlock.blocks[1].level)
+      deepStrictEqual(markdown.blocks[1].lines, examples.multiBlock.blocks[1].lines)
+    })
+  })
+
+  describe('static .load', () => {
+    it('should be a static method', () => {
+      strictEqual(typeof Markdown.load, 'function')
+    })
+
+    it('should parse the given file', async () => {
+      const markdown = await Markdown.load('./test/support/multiBlock.md')
+
+      strictEqual(markdown.blocks[0].header, examples.multiBlock.blocks[0].header)
+      strictEqual(markdown.blocks[0].level, examples.multiBlock.blocks[0].level)
+      deepStrictEqual(markdown.blocks[0].lines, examples.multiBlock.blocks[0].lines)
+
+      strictEqual(markdown.blocks[1].header, examples.multiBlock.blocks[1].header)
+      strictEqual(markdown.blocks[1].level, examples.multiBlock.blocks[1].level)
+      deepStrictEqual(markdown.blocks[1].lines, examples.multiBlock.blocks[1].lines)
+    })
+  })
+})

package/test/Processor.test.js

@@ -0,0 +1,39 @@
+import { strictEqual } from 'node:assert'
+import { describe, it } from 'mocha'
+import Processor from '../lib/Processor.js'
+import * as examples from './support/examples.js'
+
+describe('Processor', () => {
+  it('should be a constructor', () => {
+    strictEqual(typeof Processor, 'function')
+  })
+
+  it('should assign the given path argument', () => {
+    const path = {}
+    const processor = new Processor({ path })
+
+    strictEqual(processor.path, path)
+  })
+
+  it('should assign process.cwd() to the path property if no argument is given', () => {
+    const processor = new Processor()
+
+    strictEqual(processor.path, process.cwd())
+  })
+
+  describe('.process', () => {
+    it('should be a method', () => {
+      const processor = new Processor()
+
+      strictEqual(typeof processor.process, 'function')
+    })
+
+    it('should process all imports', async () => {
+      const processor = new Processor()
+
+      const result = await processor.process('./test/support/multiImports.md')
+
+      strictEqual(result, examples.multiImports.content)
+    })
+  })
+})

package/test/support/examples.js

@@ -0,0 +1,64 @@
+const multiBlock = (() => {
+  const blocks = [{
+    header: 'Header 1',
+    level: '#',
+    lines: [
+      '# Header 1',
+      'First line of the body of header 1',
+      'Second line of the body of header 1'
+    ]
+  }, {
+    header: 'Header 1.1',
+    level: '##',
+    lines: [
+      '## Header 1.1',
+      'First line of the body of header 1.1',
+      'Second line of the body of header 1.1'
+    ]
+  }]
+
+  return {
+    blocks,
+    content: [
+      blocks[0].lines.join('\n'),
+      blocks[1].lines.join('\n')
+    ].join('\n')
+  }
+})()
+
+const multiImports = (() => {
+  const blocks = [
+    ...multiBlock.blocks,
+    {
+      header: 'Header 2',
+      level: '#',
+      lines: [
+        '# Header 2',
+        'First line of the body of header 2',
+        'Second line of the body of header 2'
+      ]
+    }, {
+      header: 'Header 2.1',
+      level: '##',
+      lines: [
+        '## Header 2.1',
+        'First line of the body of header 2.1',
+        'Second line of the body of header 2.1'
+      ]
+    }]
+
+  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')
+  }
+})()
+
+export {
+  multiBlock,
+  multiImports
+}

package/test/support/multiBlock.md

@@ -0,0 +1,6 @@
+# Header 1
+First line of the body of header 1
+Second line of the body of header 1
+## Header 1.1
+First line of the body of header 1.1
+Second line of the body of header 1.1

package/test/support/multiImports.md

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