react-styleguidist/scripts/config.js

React components style guide generator

'use strict';

/* eslint-disable no-console */

const fs = require('fs');
const path = require('path');
const findup = require('findup');
const isString = require('lodash/isString');
const merge = require('lodash/merge');
const StyleguidistError = require('./utils/error');
const sanitizeConfig = require('./utils/sanitizeConfig');
const schema = require('./schemas/config');

const CONFIG_FILENAME = 'styleguide.config.js';

/**
 * Read, parse and validate config file or passed config.
 *
 * @param {object|string} [config] All config options or config file name or nothing.
 * @returns {object}
 */
function getConfig(config) {
	config = config || {};

	let configFilepath;
	if (isString(config)) {
		// Load config from a given file
		configFilepath = path.resolve(process.cwd(), config);
		if (!fs.existsSync(configFilepath)) {
			throw new StyleguidistError('Styleguidist config not found: ' + configFilepath + '.');
		}
		config = {};
	} else {
		// Try to read config options from a file
		configFilepath = findConfigFile();
	}

	if (configFilepath) {
		config = require(configFilepath);
	}

	const configDir = configFilepath ? path.dirname(configFilepath) : process.cwd();

	let sanitizedConfig;
	try {
		sanitizedConfig = sanitizeConfig(config, schema, configDir);
	} catch (exception) {
		if (exception instanceof StyleguidistError) {
			throw new StyleguidistError(
				'Something is wrong with your style guide config',
				exception.message
			);
		} else {
			throw exception;
		}
	}

	const mergedConfig = merge({}, sanitizedConfig, {
		configDir,
	});

	return mergedConfig;
}

/**
 * Try to find config file up the file tree.
 *
 * @return {string|boolean} Config absolute file path.
 */
function findConfigFile() {
	let configDir;
	try {
		configDir = findup.sync(process.cwd(), CONFIG_FILENAME);
	} catch (exception) {
		return false;
	}

	return path.join(configDir, CONFIG_FILENAME);
}

module.exports = getConfig;