@ui5/project/lib/config/Configuration.js

UI5 CLI - Project

import path from "node:path";
import os from "node:os";

/**
 * Provides basic configuration for @ui5/project.
 * Reads/writes configuration from/to ~/.ui5rc
 *
 * @public
 * @class
 * @alias @ui5/project/config/Configuration
 */
class Configuration {
	/**
	 * A list of all configuration options.
	 *
	 * @public
	 * @static
	 */
	static OPTIONS = [
		"mavenSnapshotEndpointUrl",
		"ui5DataDir"
	];

	#options = new Map();

	/**
	 * @param {object} configuration
	 * @param {string} [configuration.mavenSnapshotEndpointUrl]
	 * @param {string} [configuration.ui5DataDir]
	 */
	constructor(configuration) {
		// Initialize map with undefined values for every option so that they are
		// returned via toJson()
		Configuration.OPTIONS.forEach((key) => this.#options.set(key, undefined));

		Object.entries(configuration).forEach(([key, value]) => {
			if (!Configuration.OPTIONS.includes(key)) {
				throw new Error(`Unknown configuration option '${key}'`);
			}
			this.#options.set(key, value);
		});
	}

	/**
	 * Maven Repository Snapshot URL.
	 * Used to download artifacts and packages from Maven's build-snapshots URL.
	 *
	 * @public
	 * @returns {string}
	 */
	getMavenSnapshotEndpointUrl() {
		return this.#options.get("mavenSnapshotEndpointUrl");
	}

	/**
	 * Configurable directory where the framework artefacts are stored.
	 *
	 * @public
	 * @returns {string}
	 */
	getUi5DataDir() {
		return this.#options.get("ui5DataDir");
	}

	/**
	 * @public
	 * @returns {object} The configuration in a JSON format
	 */
	toJson() {
		return Object.fromEntries(this.#options);
	}

	/**
	 * Creates Configuration from a JSON file
	 *
	 * @public
	 * @static
	 * @param {string} [filePath="~/.ui5rc"] Path to configuration JSON file
	 * @returns {Promise<@ui5/project/config/Configuration>} Configuration instance
	 */
	static async fromFile(filePath) {
		filePath = filePath || path.resolve(path.join(os.homedir(), ".ui5rc"));

		const {default: fs} = await import("graceful-fs");
		const {promisify} = await import("node:util");
		const readFile = promisify(fs.readFile);
		let config;
		try {
			const fileContent = await readFile(filePath);
			if (!fileContent.length) {
				config = {};
			} else {
				config = JSON.parse(fileContent);
			}
		} catch (err) {
			if (err.code === "ENOENT") {
				// "File or directory does not exist"
				config = {};
			} else {
				throw new Error(
					`Failed to read UI5 CLI configuration from ${filePath}: ${err.message}`, {
						cause: err
					});
			}
		}

		return new Configuration(config);
	}

	/**
	 * Saves Configuration to a JSON file
	 *
	 * @public
	 * @static
	 * @param {@ui5/project/config/Configuration} config Configuration to save
	 * @param {string} [filePath="~/.ui5rc"] Path to configuration JSON file
	 * @returns {Promise<void>}
	 */
	static async toFile(config, filePath) {
		filePath = filePath || path.resolve(path.join(os.homedir(), ".ui5rc"));

		const {default: fs} = await import("graceful-fs");
		const {promisify} = await import("node:util");
		const writeFile = promisify(fs.writeFile);

		try {
			return writeFile(filePath, JSON.stringify(config.toJson()));
		} catch (err) {
			throw new Error(
				`Failed to write UI5 CLI configuration to ${filePath}: ${err.message}`, {
					cause: err
				});
		}
	}
}

export default Configuration;