feat(config): support multiple profiles

package.json

@@ -49,7 +49,8 @@
     "lodash": "^4.17.21",
     "stream-json": "^1.7.5",
     "yaml": "^2.3.0",
-    "yargs": "^17.7.2"
+    "yargs": "^17.7.2",
+    "zod": "^3.22.2"
   },
   "devDependencies": {
     "eslint": "^8.40.0",

src/cli.js

@@ -2,9 +2,10 @@
 
 import { parser } from "./parser.js";
 import { isUsageError } from "./errors.js";
+import { loadYargsConfig } from "./utils/config.js";
 
 try {
-  await parser.parse();
+  await parser.config(loadYargsConfig()).parse();
 } catch (err) {
   if (isUsageError(err)) {
     parser.showHelp();

src/middleware/client.js

@@ -2,8 +2,9 @@ import { Client } from "@ibm-generative-ai/node-sdk";
 
 import { version } from "../utils/version.js";
 
+const agent = version ? `cli/${version}` : "cli";
+
 export const clientMiddleware = (args) => {
-  const agent = version ? `cli/${version}` : "cli";
   args.client = new Client({
     apiKey: args.apiKey,
     endpoint: args.endpoint,

src/middleware/profile.js

@@ -0,0 +1,15 @@
+import { loadConfig } from "../utils/config.js";
+
+// If profile has been selected, merge its configuration into yargs
+export const profileMiddleware = (args) => {
+  if (!args.profile) return;
+
+  const { configuration, credentials } = loadConfig();
+  const profileConfig = {
+    ...(configuration.profiles && configuration.profiles[args.profile]),
+    ...(credentials.profiles && credentials.profiles[args.profile]),
+  };
+  Object.entries(profileConfig).forEach(([key, value]) => {
+    args[key] = value;
+  });
+};

src/parser.js

@@ -28,6 +28,7 @@ import {
 import { groupOptions } from "./utils/yargs.js";
 import { loadConfig, mergeConfig, storeConfig } from "./utils/config.js";
 import { clientMiddleware } from "./middleware/client.js";
+import { profileMiddleware } from "./middleware/profile.js";
 
 export const parser = yargs(hideBin(process.argv))
   .options({
@@ -50,7 +51,13 @@ export const parser = yargs(hideBin(process.argv))
       type: "number",
       defaultDescription: "none",
     },
+    profile: {
+      describe: "Use a specific profile from your configuration",
+      requiresArg: true,
+      type: "string",
+    },
   })
+  .middleware(profileMiddleware)
   .help()
   .alias("h", "help")
   .updateStrings({ "Options:": "Global Options:" })
@@ -88,13 +95,26 @@ export const parser = yargs(hideBin(process.argv))
           configuration: {},
           credentials: {},
         };
+        const profile = await question("Profile (leave empty for default): ");
+        if (profile) {
+          config.configuration.profiles = { [profile]: {} };
+          config.credentials.profiles = { [profile]: {} };
+        }
         const endpoint = await question("Endpoint (leave empty to skip): ");
         if (endpoint) {
-          config.configuration.endpoint = endpoint;
+          if (profile) {
+            config.configuration.profiles[profile].endpoint = endpoint;
+          } else {
+            config.configuration.endpoint = endpoint;
+          }
         }
         const apiKey = await question("API Key (leave empty to skip): ");
         if (apiKey) {
-          config.credentials.apiKey = apiKey;
+          if (profile) {
+            config.credentials.profiles[profile].apiKey = apiKey;
+          } else {
+            config.credentials.apiKey = apiKey;
+          }
         }
 
         rl.close();
@@ -1117,14 +1137,17 @@ export const parser = yargs(hideBin(process.argv))
       .demandCommand(1, 1, "Please choose a command")
   )
   .demandCommand(1, 1, "Please choose a command")
-  .config(loadConfig().configuration)
   .strict()
   .fail(false)
-  .completion('completion', "Generate completion script", (current, argv, completionFilter, done) => {
-    completionFilter((err, defaultCompletions) => {
-      const filteredCompletions = defaultCompletions
-        .filter(completion => !completion.startsWith("$0"))
-        .filter(completion => !completion.startsWith("completion"))
-      done(filteredCompletions)
-    })
-  });
+  .completion(
+    "completion",
+    "Generate completion script",
+    (current, argv, completionFilter, done) => {
+      completionFilter((err, defaultCompletions) => {
+        const filteredCompletions = defaultCompletions
+          .filter((completion) => !completion.startsWith("$0"))
+          .filter((completion) => !completion.startsWith("completion"));
+        done(filteredCompletions);
+      });
+    }
+  );

src/utils/config.js

@@ -4,19 +4,71 @@ import fs, { writeFileSync } from "fs";
 
 import YAML from "yaml";
 import _ from "lodash";
+import { z } from "zod";
 
 const CONFIG_DIR_PATH = path.join(os.homedir(), ".genai");
 const CONFIG_PATH = path.join(CONFIG_DIR_PATH, "configuration.yml");
 // Credentials and their storage are defined by the Node SDK. Currently, the SDK doesn't expose any utilities to manage them.
 const CREDENTIALS_PATH = path.join(CONFIG_DIR_PATH, "credentials.yml");
 
+const configurationSchema = z
+  .object({
+    endpoint: z.string(), // default profile
+    profiles: z.record(
+      z
+        .object({
+          endpoint: z.string(),
+        })
+        .partial()
+    ),
+  })
+  .partial();
+
+const credentialsSchema = z
+  .object({
+    apiKey: z.string(), // default profile
+    profiles: z.record(
+      z
+        .object({
+          apiKey: z.string(),
+        })
+        .partial()
+    ),
+  })
+  .partial();
+
+const parseYamlFromFile = (path) =>
+  fs.existsSync(path) ? YAML.parse(fs.readFileSync(path, "utf8")) : {};
+
+let cachedConfig = null;
 export const loadConfig = () => {
-  const parseYamlFromFile = (path) =>
-    fs.existsSync(path) ? YAML.parse(fs.readFileSync(path, "utf8")) : {};
-  return {
-    configuration: parseYamlFromFile(CONFIG_PATH),
-    credentials: parseYamlFromFile(CREDENTIALS_PATH),
-  };
+  if (cachedConfig) return cachedConfig;
+  cachedConfig = {};
+  try {
+    cachedConfig.configuration = configurationSchema.parse(
+      parseYamlFromFile(CONFIG_PATH)
+    );
+  } catch (err) {
+    cachedConfig = null;
+    throw new Error(
+      `Failed to load the configuration, patch or remove ${CONFIG_PATH}\nDetails: ${YAML.stringify(
+        err.format()
+      )}`
+    );
+  }
+  try {
+    cachedConfig.credentials = credentialsSchema.parse(
+      parseYamlFromFile(CREDENTIALS_PATH)
+    );
+  } catch (err) {
+    cachedConfig = null;
+    throw new Error(
+      `Failed to load credentials, patch or remove ${CREDENTIALS_PATH}\nDetails: ${YAML.stringify(
+        err.format()
+      )}`
+    );
+  }
+  return cachedConfig;
 };
 
 export const storeConfig = (config) => {
@@ -25,9 +77,21 @@ export const storeConfig = (config) => {
   }
   writeFileSync(CONFIG_PATH, YAML.stringify(config.configuration ?? {}));
   writeFileSync(CREDENTIALS_PATH, YAML.stringify(config.credentials ?? {}));
+  cachedConfig = config;
 };
 
 export const mergeConfig = (config) => {
   const currentConfig = loadConfig();
   storeConfig(_.merge({}, currentConfig, config));
 };
+
+export const loadYargsConfig = () => {
+  const {
+    configuration: { profiles: _, ...configuration },
+    credentials: { profiles: __, ...credentials },
+  } = loadConfig();
+  return {
+    ...configuration,
+    ...credentials,
+  };
+};

yarn.lock

@@ -87,6 +87,7 @@ __metadata:
     stream-json: ^1.7.5
     yaml: ^2.3.0
     yargs: ^17.7.2
+    zod: ^3.22.2
   bin:
     genai: ./src/cli.js
   languageName: unknown
@@ -1978,3 +1979,10 @@ __metadata:
   checksum: f185ba87342ff16f7a06686767c2b2a7af41110c7edf7c1974095d8db7a73792696bcb4a00853de0d2edeb34a5b2ea6a55871bc864227dace682a0a28de33e1f
   languageName: node
   linkType: hard
+
+"zod@npm:^3.22.2":
+  version: 3.22.2
+  resolution: "zod@npm:3.22.2"
+  checksum: 231e2180c8eabb56e88680d80baff5cf6cbe6d64df3c44c50ebe52f73081ecd0229b1c7215b9552537f537a36d9e36afac2737ddd86dc14e3519bdbc777e82b9
+  languageName: node
+  linkType: hard