sassdoc-extras/src/description.js

SassDoc's Toolbelt

'use strict'

var fs = require('fs')
var path = require('path')
var s = require('util').format

/**
 * Resolve and load a `descriptionPath` key from config.
 */
module.exports = function description (ctx) {
  if (!ctx.descriptionPath) {
    return
  }

  ctx.description = tryLoadFile(ctx)
}

function tryLoadFile (ctx) {
  var desc = ctx.descriptionPath
  var filePath = path.resolve(ctx.dir || process.cwd(), desc)

  try {
    return fs.readFileSync(filePath, { encoding: 'utf8' })
  } catch (e) {
    if (e.code === 'ENOENT') {
      ctx.emit(
        'warning',
        new Error(s('Description file not found: `%s` given.', desc))
      )
    } else {
      ctx.emit('warning', e)
    }
  }

  return false
}