Update tocify code

Author: rstacruz

bin/bookdown

@@ -1,79 +1,4 @@
 #!/usr/bin/env node
-const Metalsmith = require('metalsmith')
-const each = require('lodash/collection/each')
-const marked = require('marked')
-
+var bookdown = require('../lib')
 var app = bookdown(process.cwd())
-app.build((err) => {
-  if (err) throw err
-})
-
-function bookdown (cwd) {
-  return Metalsmith(cwd)
-    .source('.')
-    .destination('_bookdown')
-    .ignore('**/*.!(md)') // ignore non-md files
-    .ignore('.*') // ignore dot directories
-    .ignore('node_modules')
-    .ignore('_bookdown') // ignore output
-    .ignore('_book')
-    .use(bookdownParse)
-}
-
-function bookdownParse (files, ms, done) {
-  var sources = Object.keys(files)
-  console.log(sources)
-
-  // 1: find or infer the TOC.
-  //    - strip out docs/ prefix
-  //    - turn the first page in the toc to `index.html`
-  //    - turn README to index
-  //    - flatten it as `pages`
-  var toc = {
-    sections: {
-      'index.html': {
-        source: 'README.md'
-      },
-      'docs.html': {
-        source: 'docs/docs.md',
-        sections: {
-          'rails.html': {
-            source: 'docs/rails.md'
-          }
-        }
-      },
-    }
-  }
-
-  files['toc.json'] = {
-    contents: JSON.stringify(toc) + '\n'
-  }
-
-  // 2: flatten TOC to pages.
-  var pages = {
-    'index.html': { source: 'README.md' },
-    'rails.html': { source: 'docs/rails.md' }
-  }
-
-  files['pages.json'] = {
-    contents: JSON.stringify(pages) + '\n'
-  }
-
-
-  // 3: render each page
-  each(pages, (opts, fname) => {
-    const file = files[opts.source]
-    file.markdown = file.contents
-    file.contents = marked(file.contents.toString(), { gfm: true, tables: true })
-    files[fname] = file
-  })
-
-  // 4: add assets
-
-  // delete sources
-  sources.forEach((fname) => {
-    delete files[fname]
-  })
-
-  done()
-}
+app.build((err) => { if (err) throw err })

lib/index.js

@@ -0,0 +1,76 @@
+'use strict'
+
+const Metalsmith = require('metalsmith')
+const each = require('lodash/collection/each')
+const marked = require('marked')
+
+const tocify = require('./tocify')
+
+function bookdown (cwd) {
+  return Metalsmith(cwd)
+    .source('.')
+    .destination('_bookdown')
+    .ignore('**/*.!(md)') // ignore non-md files
+    .ignore('.*') // ignore dot directories
+    .ignore('node_modules')
+    .ignore('_bookdown') // ignore output
+    .ignore('_book')
+    .use(tocifyMd)
+    .use(bookdownParse)
+}
+
+function tocifyMd (files, ms, done) {
+  if (!files['docs/README.md']) {
+    var err = new Error('No table of contents found')
+    return done(err)
+  }
+
+  var toc = tocify(files['docs/README.md'].contents.toString())
+
+  // 1: find or infer the TOC.
+  //    - strip out docs/ prefix
+  //    - turn the first page in the toc to `index.html`
+  //    - turn README to index
+  //    - flatten it as `pages`
+  files['toc.json'] = {
+    contents: JSON.stringify(toc, null, 2) + '\n'
+  }
+
+  done()
+}
+
+function bookdownParse (files, ms, done) {
+  var sources = Object.keys(files)
+  console.log(sources)
+
+  // 2: flatten TOC to pages.
+  var pages = {
+    'index.html': { source: 'README.md' },
+    'rails.html': { source: 'docs/rails.md' }
+  }
+
+  files['pages.json'] = {
+    contents: JSON.stringify(pages) + '\n'
+  }
+
+  // 3: render each page
+  each(pages, (opts, fname) => {
+    const file = files[opts.source]
+    file.markdown = file.contents
+    file.contents = marked(file.contents.toString(), { gfm: true, tables: true })
+    files[fname] = file
+  })
+
+  // 4: add assets
+
+  // delete sources
+  sources.forEach((fname) => {
+    if (fname !== 'toc.json') {
+      delete files[fname]
+    }
+  })
+
+  done()
+}
+
+module.exports = bookdown

lib/tocify.js

@@ -1,5 +1,6 @@
+'use strict'
+
 var marked = require('marked')
-var slugify = require('slugify')
 
 module.exports = function tocify (md) {
   var tokens = marked.lexer(md)
@@ -12,18 +13,30 @@ module.exports = function tocify (md) {
   tokens.forEach((token) => {
     switch (token.type) {
       case 'list_start':
-        scope = current.sections = {}
+        scope = current.sections = []
         crumbs.push(scope)
         break
 
       case 'text':
         const m = token.text.match(/^\[([^\]]*)\]\((.*)\)$/)
         const title = m ? m[1] : token.text
         const source = m ? m[2] : null
-        const key = slugify(title).toLowerCase()
+        let url
+
+        if (source && source.substr(0, 1) !== '/') {
+          throw new Error('source not valid: ' + url)
+        }
+
+        if (source) {
+          url = source.replace(/\.md$/, '.html')
+          url = url.replace(/README\.html$/, 'index.html')
+          // url = url.replace(/\/docs\//, '/')
+        }
 
-        current = scope[key] = { title: title }
+        current = { title }
         if (source) current.source = source
+        if (url) current.url = url
+        scope.push(current)
         break
 
       case 'list_end':

package.json

@@ -19,6 +19,8 @@
   },
   "devDependencies": {
     "expect": "1.11.1",
-    "mocha": "2.3.3"
+    "mocha": "2.3.3",
+    "mocha-standard": "1.0.0",
+    "standard": "5.3.1"
   }
 }

test/standard_test.js

@@ -0,0 +1,20 @@
+var standard = require('mocha-standard')
+
+describe('coding style', function () {
+  this.timeout(5000)
+
+  it('lib conforms to standard', standard.files([
+    '*.js',
+    'lib/**/*.js'
+  ]))
+
+  it('tests conform to standard', standard.files([
+    'test/**/*.js'
+  ], {
+    global: [
+      'describe', 'it', 'xdescribe', 'xit',
+      'before', 'beforeEach', 'after', 'afterEach',
+      'expect'
+    ]
+  }))
+})

test/tocify_test.js

@@ -1,40 +1,35 @@
 const tocify = require('../lib/tocify')
 
 describe('tocify', function () {
-  var toc = [
-    '# toc',
-    '',
-    '* [readme](/README.md)',
-  ].join('\n')
-
   var output
 
   it('works', function () {
     output = tocify([
-      '* [Readme](/README.md)',
+      '* [Readme](/README.md)'
     ].join('\n'))
 
     expect(output).toEqual({
-      sections: {
-        readme: {
+      sections: [
+        {
           title: 'Readme',
+          url: '/index.html',
           source: '/README.md'
         }
-      }
+      ]
     })
   })
 
   it('handles non-links', function () {
     output = tocify([
-      '* Readme',
+      '* Readme'
     ].join('\n'))
 
     expect(output).toEqual({
-      sections: {
-        readme: {
+      sections: [
+        {
           title: 'Readme'
         }
-      }
+      ]
     })
   })
 
@@ -47,26 +42,28 @@ describe('tocify', function () {
     ].join('\n'))
 
     expect(output).toEqual({
-      sections: {
-        readme: {
+      sections: [
+        {
           title: 'Readme',
-          source: '/README.md',
+          url: '/index.html',
+          source: '/README.md'
         },
-        'getting-started': {
+        {
           title: 'Getting Started',
-          sections: {
-            'install': {
+          sections: [
+            {
               title: 'Install',
-              source: '/docs/install.md',
+              url: '/docs/install.html',
+              source: '/docs/install.md'
             },
-            'usage': {
+            {
               title: 'Usage',
-              source: '/docs/usage.md',
+              url: '/docs/usage.html',
+              source: '/docs/usage.md'
             }
-          }
+          ]
         }
-      }
+      ]
     })
   })
-
 })

test/todo_test.js

@@ -1,6 +1,8 @@
 describe('to do', function () {
-  it('parsing toc')
+  it('parsing toc', done)
+  it('validating toc')
   it('flattening toc to pages')
   it('rendering pages')
 })
 
+function done () {}