wip, compile step

Author: heapwolf

README.md

@@ -45,6 +45,14 @@ Each param is associaated with the last function or method.
 #### comment `text...`
 Each comment is associated with the last keyword.
 
+# CLI
+Hyper-docs cli will output an AST. It will also accept an AST as input
+and compile to either html (`--html`) or markdown (`--md`) pending on the
+specified flag.
+
+```bash
+hyper-docs /path/to/projects | ./bin/docs --html
+```
 
 # PARSER
 Outputs an AST. See [this][1] example.

bin/docs

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+require('..')

compile.js

@@ -0,0 +1,71 @@
+const marked = require('marked')
+const hl = require('highlight.js')
+
+const templateOperators = members => {
+  const operators = members.filter(m => m.type === 'operator')
+
+  let table =  `|Operator|Description|\n`
+      table += `|:-------|:----------|\n`
+
+  table += operators.map(operator => {
+    return `|${operator.name}|${operator.comment}|`
+  }).join('\n')
+
+  return table
+}
+
+const templateClass = (key, type) => `
+### \`${key}\`
+${type.comment}
+
+${templateOperators(type.members)}
+`
+
+const templateFunction = (key, type) => `
+### \`${key}\`
+${type.comment}
+`
+
+const template = ast => `
+# [${ast.namespace}](${ast.repo})
+
+## TYPES
+${
+  Object.keys(ast.types).map(key => {
+    const type = ast.types[key]
+
+    return type.members
+      ? templateClass(key, type)
+      : templateFunction(key, type)
+  }).join('\n')
+}
+`
+
+const createHTML = s => {
+  marked.setOptions({
+    renderer: new marked.Renderer(),
+    highlight: code => hl.highlightAuto(code).value
+  })
+
+  return marked(s)
+}
+
+const createMD = ast => {
+  if (!ast.namespace) {
+    return ''
+  } else {
+    ast.namespace = ast.namespace.join('::')
+  }
+
+  return template(ast)
+}
+
+module.exports = (buffers, type) => {
+  buffers.forEach(ast => {
+    const output = type === 'html'
+      ? createHTML(createMD(ast))
+      : createMD(ast)
+
+    process.stdout.write(output)
+  })
+}

index.js

@@ -1,7 +1,9 @@
 const fs = require('fs')
+const os = require('os')
 const path = require('path')
 
 const parse = require('./parse')
+const compile = require('./compile')
 
 //
 // Find all header files except in ./deps or hidden dirs
@@ -16,9 +18,13 @@ const read = d => {
     const p = paths[i]
     const base = path.basename(p)
 
-    if (base[0] === '.' || (base === 'deps')) {
-      continue
-    }
+    const dontParse = (
+      (base[0] === '.') ||
+      (base === 'deps') ||
+      (base === 'hyper-docs')
+    )
+
+    if (dontParse) continue
 
     const stat = fs.statSync(p)
 
@@ -52,13 +58,31 @@ const parseUrl = s => {
   let url = s.split('//')[1]
   if (!url) url = s.split('@')[1]
 
-  return url.replace(':', '/').replace('.git', '')
+  return 'https://' + url.replace(':', '/').replace('.git', '')
 }
 
 //
 // Read all files from a path and parse their headers for docs
 //
 function main (argv) {
+  if (argv[0] === '--md' || argv[0] === '--html') {
+    let buffers = fs
+      .readFileSync(0, 'utf8')
+      .split(os.EOL)
+      .filter(Boolean)
+
+    try {
+      buffers = buffers.map(JSON.parse)
+    } catch (err) {
+      console.error(err.message)
+      process.exit(1)
+    }
+
+    const type = argv[0].slice(2)
+    compile(buffers, type)
+    return
+  }
+
   const files = read(argv[0])
 
   for (const file of files) {
@@ -73,7 +97,7 @@ function main (argv) {
     const output = parse(s)
 
     output.repo = parseUrl(pkg.repository.url)
-    console.log(JSON.stringify(output, 2, 2))
+    process.stdout.write(JSON.stringify(output) + '\n')
   }
 }
 

package-lock.json

@@ -18,6 +18,7 @@
   },
   "homepage": "https://github.com/datcxx/hyper-docs#readme",
   "dependencies": {
+    "highlight.js": "^9.15.6",
     "marked": "^0.6.2"
   }
 }

package.json

@@ -1,6 +1,3 @@
-//
-// Parse each line 
-//
 module.exports = source => {
   const DOC_RE = /\/\/\/(.*)[\n|\r]/g
 
@@ -25,15 +22,11 @@ module.exports = source => {
     functions: [],
   }
 
-  let lastClass = null
+  let lastType = null
   let lastMethod = null
   let hasConstructor = false
   let last = null
 
-  //
-  // Parses all lines of the file, the rule for docs is
-  // last-one-in-wins like css.
-  //
   const parseLine = line => {
     const words = line.split(' ')
     const keyword = words.shift()
@@ -53,18 +46,27 @@ module.exports = source => {
         break
       }
 
+      case 'function': {
+        lastType = words[0].match(/\w+/)[0]
+        last = lastMethod = output.types[lastType] = {}
+        break
+      }
+
       case 'struct':
       case 'class': {
-        lastClass = words.shift()
-        last = output.types[lastClass] = []
+        lastType = words.shift()
+        last = output.types[lastType] = { members: [] }
         break
       }
 
+      case 'property':
       case 'operator': {
         last = {
-          operator: words.join(' ')
+          type: keyword,
+          name: words.join(' ')
         }
-        output.types[lastClass].push(last)
+
+        output.types[lastType].members.push(last)
         break
       }
 
@@ -93,15 +95,6 @@ module.exports = source => {
         break
       }
 
-      case 'property': {
-        last = {
-          property: words.join(' ')
-        }
-
-        output.types[lastClass].push(last)
-        break
-      }
-
       case 'overload':
       case 'constructor':
       case 'method': {
@@ -134,7 +127,7 @@ module.exports = source => {
           hasConstructor = true
         }
 
-        output.types[lastClass].push(lastMethod)
+        output.types[lastType].members.push(lastMethod)
 
         break
       }