azdo-cli 0.22.0-develop.764 → 0.22.0-feature-046-config-help.765

package/dist/{chunk-W4EVKARR.js → chunk-MHJ6OBX3.js}

@@ -49,45 +49,56 @@ function parseCredentialStore(value, platform = process.platform) {
 }
 
 // src/services/config-store.ts
+var CREDENTIAL_STORE_NOTES = {
+  keyring: "OS vault, default",
+  dpapi: "Windows only; DPAPI-encrypted files under ~/.azdo/credentials"
+};
 var SETTINGS = [
   {
     key: "org",
     description: "Azure DevOps organization name",
     type: "string",
     example: "mycompany",
-    required: true
+    required: true,
+    scoped: false
   },
   {
     key: "project",
     description: "Azure DevOps project name",
     type: "string",
     example: "MyProject",
-    required: true
+    required: true,
+    scoped: true
   },
   {
     key: "fields",
     description: "Extra work item fields to include (comma-separated reference names)",
     type: "string[]",
     example: "System.Tags,Custom.Priority",
-    required: false
+    required: false,
+    scoped: true
   },
   {
     key: "markdown",
     description: "Convert rich text fields to markdown on display",
     type: "boolean",
     example: "true",
-    required: false
+    required: false,
+    scoped: true
   },
   {
     key: "credentialStore",
-    description: 'Where credentials are stored: "keyring" (OS vault, default) or "dpapi" (Windows only, ~/.azdo/credentials)',
+    description: "Where credentials are stored (keyring or dpapi)",
     type: "string",
     example: "dpapi",
-    required: false
+    required: false,
+    scoped: false,
+    values: CREDENTIAL_STORES.map((value) => ({ value, note: CREDENTIAL_STORE_NOTES[value] })),
+    env: "AZDO_CREDENTIAL_STORE"
   }
 ];
 var VALID_KEYS = SETTINGS.map((s) => s.key);
-var SCOPED_KEYS = ["project", "fields", "markdown"];
+var SCOPED_KEYS = SETTINGS.filter((s) => s.scoped).map((s) => s.key);
 function getConfigPath() {
   return path.join(os.homedir(), ".azdo", "config.json");
 }
@@ -1178,7 +1189,7 @@ async function deletePat(org) {
   }
   try {
     const { unlinkSync: unlinkSync2 } = await import("fs");
-    const { lockPath: lockPath2 } = await import("./oauth-token-refresh-RUT4XIMM.js");
+    const { lockPath: lockPath2 } = await import("./oauth-token-refresh-QPPOTES2.js");
     unlinkSync2(lockPath2(org));
   } catch {
   }

package/dist/index.js

@@ -39,7 +39,7 @@ import {
   tokenResponseToCredential,
   unsetConfigValue,
   unsetOrgScopedValue
-} from "./chunk-W4EVKARR.js";
+} from "./chunk-MHJ6OBX3.js";
 
 // src/program.ts
 import { Command as Command19 } from "commander";
@@ -2777,9 +2777,41 @@ async function promptForSetting(cfg, setting, ask) {
 
 `);
 }
+var SETTING_TYPE_LABEL = {
+  string: "string",
+  "string[]": "comma-separated list",
+  boolean: "true | false"
+};
+function describeSettingValues(setting) {
+  if (!setting.values) return `type: ${SETTING_TYPE_LABEL[setting.type]}`;
+  const list = setting.values.map((v) => v.note ? `${v.value} (${v.note})` : v.value).join(", ");
+  return `values: ${list}`;
+}
+function renderSettingsHelp(settings = SETTINGS) {
+  const keyWidth = Math.max(...settings.map((s) => s.key.length)) + 3;
+  const indent = " ".repeat(2 + keyWidth);
+  const lines = ["Settings (azdo config set <key> <value>):", ""];
+  for (const setting of settings) {
+    const facts = [
+      describeSettingValues(setting),
+      `scope: ${setting.scoped ? "global, or per organization with --org <org>" : "global only"}`
+    ];
+    if (setting.required) facts.push("required");
+    if (setting.env) facts.push(`env: ${setting.env} overrides the stored value`);
+    lines.push(`  ${setting.key.padEnd(keyWidth)}${setting.description}`);
+    for (const fact of facts) lines.push(`${indent}${fact}`);
+    lines.push(`${indent}example: azdo config set ${setting.key} ${setting.example}`);
+    lines.push("");
+  }
+  return lines.join("\n").trimEnd();
+}
+var KEY_ARGUMENT_HELP = `setting key (${SETTINGS.map((s) => s.key).join(", ")})`;
+var KEY_HELP_POINTER = "\nRun `azdo config --help` for each setting's meaning, accepted values and scope.\n";
 function createConfigCommand() {
   const config = new Command4("config");
   config.description("Manage CLI settings");
+  config.addHelpText("after", `
+${renderSettingsHelp()}`);
   config.addHelpText(
     "after",
     [
@@ -2797,7 +2829,7 @@ function createConfigCommand() {
     ].join("\n")
   );
   const set = new Command4("set");
-  set.description("Set a configuration value").argument("<key>", "setting key (org, project, fields, markdown, credentialStore)").argument("<value>", "setting value").option("--org <org>", "set value in an org-scoped configuration").option("--json", "output in JSON format").option("--copy-credentials", "with credentialStore dpapi: copy Credential Manager credentials without asking").option("--no-copy-credentials", "with credentialStore dpapi: do not offer to copy Credential Manager credentials").action((key, value, options) => {
+  set.description("Set a configuration value").argument("<key>", KEY_ARGUMENT_HELP).argument("<value>", "setting value").option("--org <org>", "set value in an org-scoped configuration").option("--json", "output in JSON format").option("--copy-credentials", "with credentialStore dpapi: copy Credential Manager credentials without asking").option("--no-copy-credentials", "with credentialStore dpapi: do not offer to copy Credential Manager credentials").addHelpText("after", KEY_HELP_POINTER).action((key, value, options) => {
     try {
       if (options.org) {
         setOrgScopedValue(options.org, key, value);
@@ -2831,7 +2863,7 @@ function createConfigCommand() {
     writeJson();
   });
   const get = new Command4("get");
-  get.description("Get a configuration value").argument("<key>", "setting key (org, project, fields, markdown, credentialStore)").option("--org <org>", "read from an org-scoped configuration").option("--json", "output in JSON format").action((key, options) => {
+  get.description("Get a configuration value").argument("<key>", KEY_ARGUMENT_HELP).option("--org <org>", "read from an org-scoped configuration").option("--json", "output in JSON format").addHelpText("after", KEY_HELP_POINTER).action((key, options) => {
     try {
       const value = options.org ? getOrgScopedValue(options.org, key) : getConfigValue(key);
       if (options.json) {
@@ -2864,7 +2896,7 @@ function createConfigCommand() {
     writeConfigList(cfg);
   });
   const unset = new Command4("unset");
-  unset.description("Remove a configuration value").argument("<key>", "setting key (org, project, fields, markdown, credentialStore)").option("--org <org>", "remove from an org-scoped configuration").option("--json", "output in JSON format").action((key, options) => {
+  unset.description("Remove a configuration value").argument("<key>", KEY_ARGUMENT_HELP).option("--org <org>", "remove from an org-scoped configuration").option("--json", "output in JSON format").addHelpText("after", KEY_HELP_POINTER).action((key, options) => {
     try {
       if (options.org) {
         unsetOrgScopedValue(options.org, key);

package/dist/{oauth-token-refresh-RUT4XIMM.js → oauth-token-refresh-QPPOTES2.js}

@@ -5,7 +5,7 @@ import {
   lockPath,
   locksDir,
   refreshIfNeeded
-} from "./chunk-W4EVKARR.js";
+} from "./chunk-MHJ6OBX3.js";
 export {
   _resetInFlight,
   classifyRefreshFailure,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "azdo-cli",
-  "version": "0.22.0-develop.764",
+  "version": "0.22.0-feature-046-config-help.765",
   "description": "Azure DevOps CLI tool",
   "type": "module",
   "bin": {