patternplate-server/source/library/utilities/get-environments.js

Programmatically serve atomic patterns via a REST API

import {basename, resolve} from 'path';
import {debuglog} from 'util';
import exists from 'path-exists';
import {merge} from 'lodash';

import getReadFile from '../filesystem/read-file';
import readTree from '../filesystem/read-tree';
import {fail} from '../log/decorations';

const envDebug = debuglog('environments');

export const defaultEnvironment = {
	name: 'index',
	display: true,
	displayName: 'Default',
	version: '0.1.0',
	applyTo: ['**/*'],
	include: ['**/*'],
	excludes: [],
	priority: 0,
	environment: {}
};

export default async function getEnvironments(base, options = {}) {
	const {log, cache} = options;
	const readFile = getReadFile({cache});

	// Check if there is a user environment folder
	const environmentBase = resolve(base, '@environments');
	const hasUserEnvironments = await exists(environmentBase);

	// Get available environments ids
	const userEnvironmentPaths = hasUserEnvironments ?
		(await readTree(environmentBase, cache))
			.filter(item => basename(item) === 'pattern.json') :
		[];

	envDebug('found environment files at %s', userEnvironmentPaths);

	// Load environments
	const userEnvironmentFiles = await Promise.all(
		userEnvironmentPaths.map(envFilePath => {
			envDebug('reading env file %s', envFilePath);
			const content = readFile(envFilePath);
			envDebug('%s %s', envFilePath, content);
			return content;
		})
	);

	// Parse environment file contents
	const userEnvironments = userEnvironmentFiles
		.map(userEnvironmentFile => {
			try {
				const raw = JSON.parse(userEnvironmentFile.toString('utf-8'));
				return merge({}, defaultEnvironment, raw);
			} catch (error) {
				if (log) {
					log.error(fail`Failed reading environment file ${userEnvironmentFile}:\n${error}`);
				}
				return null;
			}
		})
		.filter(Boolean);

	envDebug('read environment data');
	envDebug(userEnvironments);

	return userEnvironments.length ?
		userEnvironments :
		[defaultEnvironment];
}