{ "file": "lib/decorate-config.js", "content": "
'use strict';\nconst path = require('path');\n\n/**\n * Handle adding default values to config and validating required properties\n * are present\n * @class decorateConfig\n * @constructor\n * @param {Object} config      Project configuration file\n * @param {Object} packageJSON Project package.json file\n * @param {Object} buildConfig Configs passed to build function call\n * @return {Object} Fully decorated and validated project configuration file\n */\nmodule.exports = function decorateConfig(config, packageJSON, buildConfig) {\n  // ========================================================\n  // Setup Default Configs\n  // ========================================================\n  buildConfig = buildConfig || {};\n  /**\n   * Fountianhead default configurations are targeted at Ember applications and\n   * include a sane default for every option with the goal of being able to\n   * install and use the addon with zero configuration for simple/standard Ember\n   * apps.\n   * TODO: Document defaults\n   * @property defaultConfigurations\n   * @type {Object}\n   */\n  let defaultConfigurations = {\n    name: '',\n    description: '',\n    entry: ['app'],\n    quiet: false,\n    whiteListTags: ['passed', 'closure', 'action'],\n    guides: [],\n    output: {\n      filename: 'fountainhead-data.json',\n      path: path.resolve('docs')\n    }\n  };\n\n  // If consuming application is an addon, change entry to `/addon` dir\n  // Addons should have the entry 'ember-addon' in their package keywords\n  if (packageJSON.keywords && packageJSON.keywords.indexOf('ember-addon') !== -1) {\n    defaultConfigurations.entry = ['addon'];\n  }\n\n\n  // ========================================================\n  // Merge Defaults with Consumer Defined Configs\n  // ========================================================\n\n  // Use .assign to set defaults for any missing configs\n  config = Object.assign(defaultConfigurations, config);\n\n  // YUIDoc expects an array of entries, Wrap single entry in an array\n  config.entry = config.entry instanceof Array ? config.entry : [config.entry];\n\n  // Validate config repository\n  if (!config.repository && packageJSON.repository) {\n    config.repository = typeof packageJSON.repository === 'string'\n      ? packageJSON.repository\n      : packageJSON.repository.url;\n  }\n\n  // Populate with package data where possible\n  config.name = config.name || packageJSON.name;\n  config.description = config.description || packageJSON.description;\n  config.version = config.version || packageJSON.version;\n\n  // hashRouting determines if query params or hash fragments are used for links,\n  // users can set this explicitly, but shouldn't have to. If the buildConfig has\n  // locationType hash, set hashRouting to true (unless user has explicitly\n  // configured)\n  if (config.hashRouting === undefined && buildConfig.locationType === 'hash') {\n    config.hashRouting = true;\n  }\n\n  return config;\n};\n
" }