Function readWorkspaceConfigFile

lib/graph/helpers/createWorkspace.js:71–133

(filePath)

}

async function readWorkspaceConfigFile(filePath) {
	const {
		default: fs
	} = await import("graceful-fs");
	const {promisify} = await import("node:util");
	const readFile = promisify(fs.readFile);
	const jsyaml = await import("js-yaml");

	let fileContent;
	try {
		fileContent = await readFile(filePath, {encoding: "utf8"});
	} catch (err) {
		throw new Error(
			`Failed to load workspace configuration from path ${filePath}: ${err.message}`, {
				cause: err
			});
	}
	let configs;
	try {
		configs = jsyaml.loadAll(fileContent, undefined, {
			filename: filePath,
		});
	} catch (err) {
		throw new Error(`Failed to parse workspace configuration at ${filePath}\nError: ${err.message}`);
	}

	if (!configs || !configs.length) {
		// No configs found => exit here
		log.verbose(`Found empty workspace configuration file at ${filePath}`);
		return configs;
	}

	// Validate found configurations with schema
	// Validation is done again in the Workspace class. But here we can reference the YAML file
	// which adds helpful information like the line number
	const validationResults = await Promise.all(
		configs.map(async (config, documentIndex) => {
			// Catch validation errors to ensure proper order of rejections within Promise.all
			try {
				await validateWorkspace({
					config,
					yaml: {
						path: filePath,
						source: fileContent,
						documentIndex
					}
				});
			} catch (error) {
				return error;
			}
		})
	);

	const validationErrors = validationResults.filter(($) => $);

	if (validationErrors.length > 0) {
		// Throw any validation errors
		// For now just throw the error of the first invalid document