link-fixing.js

#!/usr/bin/env node

var fs = require('fs')
var test = require('tape')

var fixInternalLinks = require('../lib/doc-links.js')

var urlRegex = /\[.+\]\(.+\)/g

var dir = 'spec/fixtures/test-set-docs/tutorial'
var emptyDir = 'spec/fixtures/test-set-docs/empty-dir'
var originalFile = 'spec/fixtures/doc-with-internal-links.md'
var originalContent = fs.readFileSync(originalFile).toString()
var finalFile = 'spec/fixtures/test-set-docs/tutorial/quick-start.md'

var expectedLinks = [
  '[ipc](http://electron.atom.io/docs/v0.27.0/api/ipc-renderer)',
  '[remote](http://electron.atom.io/docs/v0.27.0/api/remote)',
  '[Application distribution](http://electron.atom.io/docs/v0.27.0/tutorial/application-distribution)',
  '[here](https://github.com/atom/electron/releases)'
  ]

test('Fetch and write documentation with latest flag', function (t) {
  t.plan(4)

  fixInternalLinks(dir, 'v0.27.0', function callback (error) {
    if (error) return t.fail(error)
    compareLinks()
  })

  function compareLinks () {
    var finalContent = fs.readFileSync(finalFile).toString()
    var finalLinks = finalContent.match(urlRegex)

    if (finalLinks) {
      finalLinks.forEach(function (finalLink, i) {
        t.equal(finalLink, expectedLinks[i], 'Link ' + finalLink + ' matches ' + expectedLinks[i])
      })
    }
    cleanup()
  }

  function cleanup () {
    fs.writeFile(finalFile, originalContent, function (error) {
      if (error) return t.fail(error)
    })
  }
})

test('Parse empty directory', function (t) {
  fixInternalLinks(emptyDir, 'v0.27.0', function callback (error) {
    t.ok(error, 'got error')
    t.equal(error.message, 'Found no relative links in files.', 'Got correct error message.')
    t.end()
  })
})