Output metadata into docpress.json

Author: rstacruz

lib/index.js

@@ -9,6 +9,8 @@ const indexify = require('./indexify')
 const fixHtml = require('./fix_html')
 const syntaxHighlight = require('./syntax_highlight')
 
+const assign = Object.assign
+
 module.exports = function (options) {
   var app = ware()
     .use(buildIndex)
@@ -21,8 +23,17 @@ module.exports = function (options) {
 }
 
 /**
- * Builds toc.json and index.json.
+ * Builds docpress.json (`files['docpress.json']`). It is as JSON file, which
+ * has the following metadata:
+ *
+ * - `index` — pages index.
+ * - `toc` — table of contents (as a tree).
+ * — `sources` — a mapping of source to destination filenames.
  *
+ * These datas can be obtained via `files['docpress.json'].index` (ie, as
+ * Metalsmith file metadata) or by parsing docpress.json.
+ *
+ * ### Table of contents
  * Each toc item has:
  *
  * - `sections` (key/value of sections)
@@ -32,12 +43,18 @@ module.exports = function (options) {
  * - `url` (URL, if applicable)
  * - `headings` (array of `{ title, depth, id }`)
  *
+ * ### Index
  * Each index item has:
  *
- * - `source`
- * - `title`
- * - `slug`
- * - `headings`
+ * - `source` — path to source
+ * - `title` — the page title according to TOC
+ * - `slug` — slug for the page
+ * - `headings` — an array of headings
+ *
+ * ### Files
+ * It will modify files with new metadata:
+ *
+ * - `newName` — the build output filename
  */
 
 function buildIndex (files, ms, done) {
@@ -64,9 +81,13 @@ function buildIndex (files, ms, done) {
 
   verifyIndex(indexes.index, files)
 
-  files['toc.json'] = { contents: JSON.stringify(toc, null, 2) + '\n' }
-  files['index.json'] = { contents: JSON.stringify(indexes.index, null, 2) + '\n' }
-  files['sources.json'] = { contents: JSON.stringify(indexes.sources, null, 2) + '\n' }
+  var data = {
+    toc: toc,
+    index: indexes.index,
+    sources: indexes.sources
+  }
+
+  files['docpress.json'] = assign({}, data, { contents: JSON.stringify(data, null, 2) + '\n' })
 
   done()
 }
@@ -86,8 +107,8 @@ function buildIndex (files, ms, done) {
  */
 
 function renderMarkdown (files, ms, done) {
-  var pages = JSON.parse(files['index.json'].contents)
-  var sources = JSON.parse(files['sources.json'].contents)
+  var pages = files['docpress.json'].index
+  var sources = files['docpress.json'].sources
 
   // render each page
   each(pages, (page, fname) => {

test/fixture_test.js

@@ -17,8 +17,7 @@ describe('fixture', function () {
 
   it('outputs the right files', function () {
     expect(fx.exists('_docpress/index.html')).toEqual(true)
-    expect(fx.exists('_docpress/index.json')).toEqual(true)
-    expect(fx.exists('_docpress/toc.json')).toEqual(true)
+    expect(fx.exists('_docpress/docpress.json')).toEqual(true)
     expect(fx.exists('_docpress/testing.html')).toEqual(true)
     expect(fx.exists('_docpress/cleanup.html')).toEqual(true)
   })
@@ -39,23 +38,42 @@ describe('fixture', function () {
     expect(fx.exists('_docpress/README.md')).toEqual(false)
   })
 
-  describe('toc.json', function () {
+  describe('docpress.json', function () {
     before(function () {
-      data = fx.read('_docpress/toc.json')
+      data = fx.read('_docpress/docpress.json')
       data = JSON.parse(data)
     })
 
+    it('has index', function () {
+      expect(data.index).toExist()
+    })
+
+    it('has toc', function () {
+      expect(data.toc).toExist()
+    })
+
+    it('has sources', function () {
+      expect(data.sources).toExist()
+    })
+  })
+
+  describe('docpress.json/toc', function () {
+    before(function () {
+      data = fx.read('_docpress/docpress.json')
+      data = JSON.parse(data).toc
+    })
+
     it('renders proper json', function () { })
 
     it('has headings', function () {
       expect(data.sections[0].headings.length).toBeGreaterThan(2)
     })
   })
 
-  describe('index.json', function () {
+  describe('docpress.json/index', function () {
     before(function () {
-      data = fx.read('_docpress/index.json')
-      data = JSON.parse(data)
+      data = fx.read('_docpress/docpress.json')
+      data = JSON.parse(data).index
     })
 
     it('renders proper json', function () { })

test/index/image_refs_test.js

@@ -34,7 +34,7 @@ describe('index/image refs:', function () {
   })
 
   it('adds to sources', function () {
-    expect(JSON.parse(this.files['sources.json'].contents)).toEqual({
+    expect(JSON.parse(this.files['docpress.json'].contents).sources).toEqual({
       'README.md': 'index.html',
       'docs/images/screenshot.png': 'images/screenshot.png'
     })

test/index/index_test.js

@@ -44,8 +44,8 @@ describe('index:', function () {
 
   describe('toc.json:', function () {
     beforeEach(function () {
-      this.tocFile = this.files['toc.json']
-      this.toc = JSON.parse(this.tocFile.contents)
+      this.tocFile = this.files['docpress.json']
+      this.toc = JSON.parse(this.tocFile.contents).toc
     })
 
     it('renders.json', function () {

test/index/unused_md_test.js

@@ -29,7 +29,7 @@ describe('index/unused md files:', function () {
 
   it('removes unprocessed .md files', function () {
     expect(Object.keys(this.files)).toEqual([
-      'toc.json', 'index.json', 'sources.json', 'index.html'
+      'docpress.json', 'index.html'
     ])
   })
 })