Implemented markdown-to-pdf cli parsing

Author: hacker112

README.md

@@ -20,7 +20,7 @@ A collection of small handy tools for improving and converting markdown.
 
 Add Github compatible table of content to markdown (Replacing "<!-- toc -->" in source file)
 
-This tools uses [markdown-toc](https://github.com/jonschlinkert/markdown-toc#tocinsert) internally.
+This tools uses [markdown-toc](https://github.com/jonschlinkert/markdown-toc) internally.
 
 ## CLI
 
@@ -44,3 +44,9 @@ This tools uses [markdown-toc](https://github.com/jonschlinkert/markdown-toc#toc
         --maxdepth=<depth>           Use headings whose depth is at most maxdepth (default: 6)
         --version                    Display the application version
 ```
+
+# markdown-to-pdf
+
+Convert markdown to PDF (and also HTML) with optional table of content.
+
+Inspired by [MDPDF](https://www.npmjs.com/package/mdpdf) and [markdown-pdf](https://www.npmjs.com/package/markdown-pdf). With the improvement that you can generate a table of content (ToC) using [markdown-toc](https://github.com/jonschlinkert/markdown-toc), and the ToC document links works correctly in the PDF even if non-latin-letter like åäö are used.

bin/markdown-to-pdf.js

@@ -0,0 +1,162 @@
+#!/usr/bin/env node
+
+const toc = require('markdown-toc')
+const fs = require('fs')
+const meow = require('meow')
+
+//
+// CLI setup
+//
+const cli = meow(
+  `
+    Usage:
+        $ markdown-to-pdf <source> [<destination>] [<options>]
+
+    <source> must be a markdown file, with the extension '.md'.
+    <destination> must be a PDF file, with the extension '.pdf'
+                  if ommitted it will be named <source>.pdf
+
+
+    Examples:
+            $ markdown-to-pdf README.md
+            $ markdown-to-pdf in.md out.pdf --toc
+            $ markdown-to-pdf in.md out.pdf --toc --save-html out.html
+
+    Options:
+        --border=<size>         Border (top, left, bottom, right; default: 20mm)
+        --border-top=<size>     Top border (default: 20mm)
+        --border-left=<size>    Left border (default: 20mm)
+        --border-bottom=<size>  Bottom border (default: 20mm)
+        --border-right=<size>   Right border (default: 20mm)
+        --format=<format>       PDF size format: A0-A6, Legal, Ledger, Letter, Tabloid (Default: A4)
+
+        --toc                   Add table of content where a "toc" html comment is.
+        --maxdepth=<depth>      TOC: Use headings whose depth is at most maxdepth (default: 6)
+
+        --keep-html=<file>      Keep intermediate HTML to file. if <file> is empty it follows the
+
+        --help                  Display this menu
+        --version               Display the application version
+    `,
+  {
+    description:
+      'Convert markdown to PDF (and also HTML) with optional table of content.',
+    flags: {
+      toc: {
+        type: 'boolean',
+        default: false,
+      },
+      maxdepth: {
+        type: 'number',
+        default: 6,
+      },
+      border: {
+        type: 'string',
+        default: '20mm',
+      },
+      keepHtml: {
+        type: 'string',
+      },
+      format: {
+        type: 'string',
+        default: 'A4',
+      },
+    },
+  }
+)
+
+function isMarkdown(file) {
+  return /.+\.md$/.test(file)
+}
+function isPdf(file) {
+  return /.+\.pdf$/.test(file)
+}
+function isHtml(file) {
+  return /.+\.html$/.test(file)
+}
+
+function showErrorAndHelp(error) {
+  console.error('\nError\n-----\n' + error + '\n')
+  console.error('\nHelp\n----')
+  cli.showHelp()
+}
+
+const marginCheckRegex = /^[0-9]{1,10}(in|px|cm|mm)$/
+
+function testBorderMargin(name, value) {
+  if (!marginCheckRegex.test(value)) {
+    showErrorAndHelp(
+      `${name} must be number followed by on of the following units px, in, cm, mm.`
+    )
+  }
+}
+
+const source = cli.input[0]
+
+if (!isMarkdown(source)) {
+  showErrorAndHelp('<source> not set or not a markdown file (.md)')
+}
+if (!fs.existsSync(source)) {
+  showErrorAndHelp('<source> file does not exist')
+}
+const destination = cli.input[1] || source.replace(/\.md$/, '.pdf')
+
+if (!isPdf(destination)) {
+  showErrorAndHelp('<destination> must be a PDF file (.pdf)')
+}
+
+const maxdepth = cli.flags.maxdepth
+
+if (maxdepth < 1 || maxdepth > 6) {
+  showErrorAndHelp('<maxdepth> must be between 1 and 6.')
+}
+
+const border = cli.flags.border
+
+testBorderMargin('border', border)
+
+const margin = {
+  top: cli.flags.borderTop || border,
+  left: cli.flags.borderLeft || border,
+  right: cli.flags.borderRight || border,
+  bottom: cli.flags.borderBottom || border,
+}
+
+for (const key in margin) {
+  testBorderMargin('border-' + key, margin[key])
+}
+
+const format = cli.flags.format
+
+if (!/^(A[0-6]|Legal|Ledger|Letter|Tabloid)$/.test(format)) {
+  showErrorAndHelp(
+    '<format> must be on of the following A0-A6, Legal, Ledger, Letter, Tabloid'
+  )
+}
+
+const addToc = cli.flags.toc
+
+const keepHtml = cli.flags.keepHtml !== undefined
+
+const htmlFile = cli.flags.keepHtml || destination.replace(/\.md$/, '.html')
+
+if (!isHtml(htmlFile)) {
+  showErrorAndHelp('html file must be end with .html')
+}
+
+const cliOptions = {
+  source,
+  destination,
+  maxdepth,
+  margin,
+  format,
+  addToc,
+  keepHtml,
+  htmlFile,
+}
+
+console.log(cliOptions)
+
+//
+// TODO: do stuff
+//

package.json

@@ -26,6 +26,7 @@
     "prettier": "1.18.2"
   },
   "bin": {
+    "markdown-to-pdf": "bin/markdown-to-pdf.js",
     "markdown-github-toc": "bin/markdown-github-toc.js"
   }
 }