[INTERNAL] SETTINGS -> OPTIONS

lib/config/Configuration.js

@@ -2,7 +2,7 @@ import path from "node:path";
 import os from "node:os";
 
 /**
- * Provides basic configuration settings for @ui5/project/ui5Framework/* resolvers.
+ * Provides basic configuration for @ui5/project.
  * Reads/writes configuration from/to ~/.ui5rc
  *
  * @public
@@ -11,32 +11,33 @@ import os from "node:os";
  */
 class Configuration {
  /**
- * A list of all configuration settings.
+ * A list of all configuration options.
  *
  * @public
  * @static
  */
- static SETTINGS = [
+ static OPTIONS = [
  "mavenSnapshotEndpointUrl",
  "ui5DataDir"
  ];
 
- #settings = new Map();
+ #options = new Map();
 
  /**
  * @param {object} configuration
  * @param {string} [configuration.mavenSnapshotEndpointUrl]
  * @param {string} [configuration.ui5DataDir]
  */
  constructor(configuration) {
- // Initialize map with undefined values for every setting
- Configuration.SETTINGS.forEach((key) => this.#settings.set(key, undefined));
+ // 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.SETTINGS.includes(key)) {
- throw new Error(`Unknown configuration setting '${key}'`);
+ if (!Configuration.OPTIONS.includes(key)) {
+ throw new Error(`Unknown configuration option '${key}'`);
  }
- this.#settings.set(key, value);
+ this.#options.set(key, value);
  });
  }
 
@@ -48,7 +49,7 @@ class Configuration {
  * @returns {string}
  */
  getMavenSnapshotEndpointUrl() {
- return this.#settings.get("mavenSnapshotEndpointUrl");
+ return this.#options.get("mavenSnapshotEndpointUrl");
  }
 
  /**
@@ -58,15 +59,15 @@ class Configuration {
  * @returns {string}
  */
  getUi5DataDir() {
- return this.#settings.get("ui5DataDir");
+ return this.#options.get("ui5DataDir");
  }
 
  /**
  * @public
  * @returns {object} The configuration in a JSON format
  */
  toJson() {
- return Object.fromEntries(this.#settings);
+ return Object.fromEntries(this.#options);
  }
 
  /**

test/lib/config/Configuration.js

@@ -28,9 +28,9 @@ test.afterEach.always((t) => {
  esmock.purge(t.context.Configuration);
 });
 
-test.serial("Available configuration settings", (t) => {
+test.serial("Configuration options", (t) => {
  const {Configuration} = t.context;
- t.deepEqual(Configuration.SETTINGS, [
+ t.deepEqual(Configuration.OPTIONS, [
  "mavenSnapshotEndpointUrl",
  "ui5DataDir"
  ]);