Build an index of all html documentation files

1 files changed, 34 insertions, 0 deletions

diff --git a/scripts/index-build.js b/scripts/index-build.js
new file mode 100644
index 000000000..7d60a1775
--- /dev/null
+++ b/scripts/index-build.js
@@ -0,0 +1,34 @@
+#!/usr/bin/env node
+var fs = require("fs")
+  , path = require("path")
+  , docdir = path.resolve(__dirname, "..", "doc")
+
+console.log(
+  "npm-index(1) -- Index of all npm documentation files\n" +
+  "====================================================\n\n")
+fs.readdir(docdir, function (er, docs) {
+  if (er) throw er
+  docs.filter(function (d) {
+    return d !== "index.md"
+         && d.charAt(0) !== "."
+         && d.match(/\.md$/)
+  }).forEach(function (d) {
+    var doc = path.resolve(docdir, d)
+      , s = fs.lstatSync(doc)
+      , content = fs.readFileSync(doc, "utf8").split("\n\n")
+      , syn
+      , desc
+
+    if (s.isSymbolicLink()) return
+
+    content.forEach(function (c, i) {
+      c = c.trim()
+      //console.log([c, i])
+      if (c === "## SYNOPSIS") syn = content[i + 1]
+      if (c === "## DESCRIPTION") syn = content[i + 1]
+    })
+    console.log(d.replace(/^(.*)\.md$/, "## npm-$1(1)") + "\n")
+    if (desc) console.log(desc + "\n")
+    else if (syn) console.log(syn + "\n")
+  })
+})