@finopsbricks/fob-snap 0.1.0 → 0.1.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@finopsbricks/fob-snap",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Snapshots app client + fob-snap CLI (2-in-1). Import the client in workers, or use the CLI to push snapshots and manage widgets/dashboards.",
   "type": "module",
   "main": "src/index.js",

package/src/cli/_helpers.js

@@ -60,3 +60,32 @@ export function listOptions(cmd) {
     .option('--page <n>', 'Page number', Number, 1)
     .option('--limit <n>', 'Page size (max 500)', Number, 100);
 }
+
+/**
+ * Help formatting for the whole tree, per the CLI standard's command-grammar note
+ * (Options: above Global Options:, hang-indented descriptions).
+ *
+ * `subcommandTerm` drops commander's default `[options]` suffix so the name column
+ * stays narrow enough for descriptions to wrap cleanly; aliases are preserved
+ * (`remove|rm`), since help is the only place a reader discovers them.
+ *
+ * `showGlobalOptions` renders the mandated `Options:` / `Global Options:` split.
+ *
+ * Commander does not inherit `configureHelp()` through `addCommand()`, so this
+ * walks the tree rather than being set once at the root.
+ */
+export function configureTreeHelp(cmd) {
+  cmd.configureHelp({
+    helpWidth: process.stdout.columns || 92,
+    showGlobalOptions: true,
+    subcommandTerm: (c) => {
+      const name = c.aliases().length ? `${c.name()}|${c.aliases().join('|')}` : c.name();
+      return `${name} ${c.usage().replace(/\[options\] ?/, '')}`.trim();
+    },
+    // Commander adds an implicit `help [command]` subcommand; `--help` is already
+    // under Options:, so the row is noise in a resource listing.
+    visibleCommands: (c) => c.commands.filter((sub) => sub.name() !== 'help' && !sub._hidden),
+  });
+  for (const child of cmd.commands) configureTreeHelp(child);
+  return cmd;
+}

package/src/cli/config/index.js

@@ -3,7 +3,7 @@
  *
  * A profile is a named `{ api_url, api_key, api_secret }` set stored in
  * ~/.fob/fob-snap/config.yml. `add` takes flags, or prompts interactively for any
- * missing credential (secret via a hidden prompt) — the `login` flow.
+ * missing credential (secret via a hidden prompt).
  */
 
 import { Command } from 'commander';
@@ -58,7 +58,7 @@ function currentHandler(argv) {
 }
 
 function buildProfilesCommand() {
-  const profiles = new Command('profiles').alias('login').description('Manage credential profiles');
+  const profiles = new Command('profiles').description('Manage credential profiles');
 
   profiles
     .command('add')

package/src/cli/dashboards/index.js

@@ -62,7 +62,7 @@ async function unshareHandler(argv) {
 }
 
 export function buildDashboardsCommand() {
-  const dashboards = new Command('dashboards').alias('dashboard').description('Manage dashboards, placements, and share links');
+  const dashboards = new Command('dashboards').description('Manage dashboards, placements, and share links');
 
   listOptions(dashboards.command('list').description("List the org's dashboards")).action(safe(listHandler));
   jsonOption(dashboards.command('show').description('Show a dashboard with its placements').argument('<id>', 'Dashboard id')).action(safe(showHandler));
@@ -74,7 +74,7 @@ export function buildDashboardsCommand() {
     .option('--json', 'Output raw JSON')
     .action(safe(createHandler));
 
-  dashboards.command('delete').alias('rm').description('Delete a dashboard').argument('<id>', 'Dashboard id').action(safe(deleteHandler));
+  dashboards.command('delete').description('Delete a dashboard').argument('<id>', 'Dashboard id').action(safe(deleteHandler));
 
   dashboards
     .command('add-widget')

package/src/cli/index.js

@@ -13,6 +13,7 @@ import { dirname, join } from 'node:path';
 import { Command } from 'commander';
 
 import { setProfileOverride } from './config-store.js';
+import { safe, configureTreeHelp } from './_helpers.js';
 import { gettingStartedHandler } from './getting-started.js';
 import { buildConfigCommand } from './config/index.js';
 import { buildSnapshotsCommand } from './snapshots/index.js';
@@ -30,9 +31,9 @@ export function run(argv) {
   program
     .name('fob-snap')
     .usage('<resource> <action> [target] [options]')
-    .description('Push snapshots and manage widgets/dashboards for Snapshots (snapshots.finopsbricks.com).')
     .version(packageVersion(), '-v, --version', 'Show version number')
-    .option('--profile <name>', 'Use credentials from a specific configured profile')
+    .option('--profile <name>', 'Use credentials from a specific configured profile (overrides current)')
+    // Runs before any action handler, at any depth.
     .hook('preAction', (thisCommand) => {
       const { profile } = thisCommand.opts();
       if (profile) setProfileOverride(profile);
@@ -41,7 +42,7 @@ export function run(argv) {
   program
     .command('getting-started')
     .description('Print setup instructions')
-    .action(gettingStartedHandler);
+    .action(safe(gettingStartedHandler));
 
   program
     .addCommand(buildConfigCommand())
@@ -51,5 +52,8 @@ export function run(argv) {
     .allowUnknownOption(false)
     .showHelpAfterError();
 
+  // Applied tree-wide because configureHelp() is not inherited through addCommand().
+  configureTreeHelp(program);
+
   program.parse(argv, { from: 'user' });
 }

package/src/cli/snapshots/index.js

@@ -52,7 +52,7 @@ async function listHandler(argv) {
 }
 
 export function buildSnapshotsCommand() {
-  const snapshots = new Command('snapshots').alias('snap').description('Push and list snapshot versions');
+  const snapshots = new Command('snapshots').description('Push and list snapshot versions');
 
   snapshots
     .command('push')

package/src/cli/widgets/index.js

@@ -62,7 +62,7 @@ async function deleteHandler(argv) {
 }
 
 export function buildWidgetsCommand() {
-  const widgets = new Command('widgets').alias('widget').description('Manage widgets');
+  const widgets = new Command('widgets').description('Manage widgets');
 
   listOptions(widgets.command('list').description("List the org's widgets")).action(safe(listHandler));
   jsonOption(widgets.command('show').description('Show one widget').argument('<id>', 'Widget id')).action(safe(showHandler));
@@ -77,7 +77,7 @@ export function buildWidgetsCommand() {
     .option('--json', 'Output raw JSON')
     .action(safe(createHandler));
 
-  widgets.command('delete').alias('rm').description('Delete a widget (snapshots cascade)').argument('<id>', 'Widget id').action(safe(deleteHandler));
+  widgets.command('delete').description('Delete a widget (snapshots cascade)').argument('<id>', 'Widget id').action(safe(deleteHandler));
 
   return widgets;
 }