Fix image references

Author: rstacruz

lib/index.js

@@ -41,7 +41,8 @@ module.exports = function (options) {
  */
 
 function buildIndex (files, ms, done) {
-  var docs = ms.metadata().docs || 'docs'
+  const docs = ms.metadata().docs || 'docs'
+  const docsExpr = new RegExp('^' + docs + '/')
 
   if (!files[`${docs}/README.md`]) {
     var err = new Error(`Table of contents not found ('${docs}/README.md')`)
@@ -51,6 +52,16 @@ function buildIndex (files, ms, done) {
   var toc = tocify(files[`${docs}/README.md`].contents.toString(), files, { docs })
   var indexes = indexify(toc, { docs })
 
+  // hax: add sources for images too
+  Object.keys(files).forEach((fname) => {
+    const file = files[fname]
+    const newName = fname.replace(docsExpr, '')
+    if (newName !== fname && !fname.match(/\.md$/)) {
+      file.newName = newName
+      indexes.sources[fname] = newName
+    }
+  })
+
   verifyIndex(indexes.index, files)
 
   files['toc.json'] = { contents: JSON.stringify(toc, null, 2) + '\n' }
@@ -106,9 +117,6 @@ function renderMarkdown (files, ms, done) {
  */
 
 function cleanFiles (files, ms, done) {
-  const docs = ms.metadata().docs || 'docs'
-  const docsExpr = new RegExp('^' + docs + '/')
-
   // rename any old files
   each(files, (file, fname) => {
     // leave those that was processed
@@ -121,9 +129,9 @@ function cleanFiles (files, ms, done) {
     }
 
     // rename docs/images/pic.png => images/pic.png
-    const newName = fname.replace(docsExpr, '')
-    if (newName !== fname) {
-      files[newName] = files[fname]
+    // (`newName` is left by an earlier step)
+    if (file.newName) {
+      files[file.newName] = files[fname]
       delete files[fname]
     }
   })

test/index/fix_refs_test.js

@@ -11,12 +11,9 @@ describe('index/fix refs:', function () {
 
     this.files = {
       'docs/README.md': {
-        contents: [
-          '# toc',
-          '',
-          '* [Readme](/README.md)',
-          '* [Getting started](/docs/getting-started.md)'
-        ].join('\n') + '\n'
+        contents:
+          '* [Readme](/README.md)\n' +
+          '* [Getting started](/docs/getting-started.md)\n'
       },
       'README.md': {
         contents: '[getting started](docs/getting-started.md)'

test/index/image_refs_test.js

@@ -29,7 +29,18 @@ describe('index/image refs:', function () {
 
   it('works', function () {
     expect(this.files['index.html'].contents).toEqual(
-      '<p><img src="docs/images/screenshot.png" alt=""></p>\n'
+      '<p><img src="images/screenshot.png" alt=""></p>\n'
     )
   })
+
+  it('adds to sources', function () {
+    expect(JSON.parse(this.files['sources.json'].contents)).toEqual({
+      'README.md': 'index.html',
+      'docs/images/screenshot.png': 'images/screenshot.png'
+    })
+  })
+
+  it('preserves the image', function () {
+    expect(this.files['images/screenshot.png']).toExist()
+  })
 })

test/index/unused_md_test.js

@@ -0,0 +1,35 @@
+const compile = require('../../index')()
+
+describe('index/unused md files:', function () {
+  beforeEach(function (done) {
+    // Mock metalsmith object
+    var ms = {
+      metadata () {
+        return { docs: 'docs' }
+      }
+    }
+
+    this.files = {
+      'docs/README.md': {
+        contents: '* [Readme](/README.md)'
+      },
+      'README.md': {
+        contents: '[getting started](docs/getting-started.md)'
+      },
+      'docs/getting-started.md': {
+        contents: 'hi'
+      }
+    }
+
+    compile(this.files, ms, (err) => {
+      if (err) throw err
+      done()
+    })
+  })
+
+  it('removes unprocessed .md files', function () {
+    expect(Object.keys(this.files)).toEqual([
+      'toc.json', 'index.json', 'sources.json', 'index.html'
+    ])
+  })
+})