{ "file": "lib/index.js", "content": "
'use strict';\nconst path = require('path');\nconst Y = require('yuidocjs');\n\nconst decorateConfig = require('./decorate-config');\nconst createDirs = require('./create-dirs');\nconst generateFountainheadData = require('./generate-fountainhead-data');\n\n/**\n * Fountainhead documentation data generation lib entry. Configuration is set\n * through `fountainhead.js` file. (TODO: Add default configs to decorate-config)\n * class and link.\n *\n * The entry handles:\n * 1. Safe require of `package.json` && `fountainhead.js` files for configs\n * 2. Decoration && validation of project configs\n * 3. Generation of raw YUIDoc JSON through YUIDoc module directly\n * 4. Decoration of raw data in `generate-fountainhead-data` module.\n *\n * The primary module is the `generate-fountainhead-data` which handles all of\n * the decoration and file creation required for Fountainhead.\n * @class Index\n * @constructor\n * @uses decorateConfig\n * @uses createDirs\n * @uses generateFountainheadData\n * @param {object} config Fountainhead configuration\n * @param {string} config.env Execution environment\n */\nmodule.exports = config => {\n  const env = config.env || 'development';\n  // ========================================================\n  // Pre Docs Generation Validation\n  // ========================================================\n  /**\n   * Optional configs pulled from `fountainhead.js`\n   * @property fountainheadConfig\n   * @type {Object}\n   */\n  /**\n   * Package JSON for project. Used to populate project description if not\n   * defined in `fountainhead.js` config.\n   * @property packageJSON\n   * @type {Object}\n   */\n\n  let fountainheadConfig, packageJSON;\n\n  // You never know.\n  try {\n    fountainheadConfig = require(path.resolve('fountainhead.js'));\n    // Configuration can export an object or a function, function expects env parameter\n    if (typeof fountainheadConfig === 'function') {\n      fountainheadConfig = fountainheadConfig(env);\n    }\n\n    // Validate config export was either a function or object\n    if (typeof fountainheadConfig !== 'object') {\n      console.warn('Warning: Fountainhead configuration must export an object or function.');\n      fountainheadConfig = {};\n    }\n  } catch(ex) {\n    fountainheadConfig = {};\n  }\n  try {\n    packageJSON = require(path.resolve('package.json'));\n  } catch(ex) {\n    packageJSON = {};\n  }\n\n  // Validate config output\n  fountainheadConfig = decorateConfig(fountainheadConfig, packageJSON, config);\n\n  // ========================================================\n  // Exec Docs Generation\n  // ========================================================\n\n  /**\n   * Raw YUIDoc JSON data generated using constructor exported by `yuidocjs`.\n   * Call new with options from config to pass configs to YUIDoc and call `run`\n   * to generate JSON\n   * @property yuidocJSON\n   * @type {Object}\n   */\n  const yuidocJSON = (new Y.YUIDoc({\n    paths: fountainheadConfig.entry,\n    outdir: fountainheadConfig.output.path,\n    quiet: true // Always suppress YUIDoc logging so we can handle error logging\n  })).run();\n\n  /*\n   * When YUIDoc executes it will ensure that an empty direcotry is created at\n   * the output destination. Before we can generate the Fountainhead data, we\n   * need to create the directories the data will be saved in.\n   */\n  createDirs(fountainheadConfig.output);\n\n  /*\n   * Generate fountainhead json data using project configuration and yuidoc\n   * generated raw data\n   */\n  return generateFountainheadData(fountainheadConfig, yuidocJSON);\n};\n
" }