react-styleguidist/loaders/utils/sortProps.js

React components style guide generator

const sortBy = require('lodash/sortBy');

/**
 * Sorts an array of properties by their 'required' property first and 'name'
 * property second.
 *
 * @param {array} props
 * @return {array} Sorted properties
 */
function sortProps(props) {
	const requiredPropNames = sortBy(props.filter(prop => prop.required), 'name');
	const optionalPropNames = sortBy(props.filter(prop => !prop.required), 'name');
	const sortedProps = requiredPropNames.concat(optionalPropNames);
	return sortedProps;
}

module.exports = sortProps;