neonctl 1.23.1 → 1.23.3

package/commands/auth.js

@@ -6,11 +6,10 @@ import { log } from '../log.js';
 import { getApiClient } from '../api.js';
 import { isCi } from '../env.js';
 import { CREDENTIALS_FILE } from '../config.js';
-import { showHelpMiddleware } from '../help.js';
 export const command = 'auth';
 export const aliases = ['login'];
 export const describe = 'Authenticate';
-export const builder = (yargs) => yargs.middleware(showHelpMiddleware(yargs, true));
+export const builder = (yargs) => yargs;
 export const handler = async (args) => {
     await authFlow(args);
 };
@@ -43,7 +42,7 @@ const preserveCredentials = async (path, credentials, apiClient) => {
     });
 };
 export const ensureAuth = async (props) => {
-    if (props._.length === 0) {
+    if (props._.length === 0 || props.help) {
         return;
     }
     if (props.apiKey || props._[0] === 'auth') {

package/commands/branches.js

@@ -4,7 +4,6 @@ import { branchCreateRequest, branchCreateRequestEndpointOptions, } from '../par
 import { retryOnLock } from '../api.js';
 import { branchIdFromProps, fillSingleProject } from '../utils/enrichers.js';
 import { looksLikeBranchId, looksLikeLSN, looksLikeTimestamp, } from '../utils/formats.js';
-import { showHelpMiddleware } from '../help.js';
 import { psql } from '../utils/psql.js';
 const BRANCH_FIELDS = [
     'id',
@@ -68,8 +67,7 @@ export const builder = (argv) => argv
     },
 }), async (args) => await addCompute(args))
     .command('delete <id|name>', 'Delete a branch', (yargs) => yargs, async (args) => await deleteBranch(args))
-    .command('get <id|name>', 'Get a branch', (yargs) => yargs, async (args) => await get(args))
-    .middleware(showHelpMiddleware(argv), true);
+    .command('get <id|name>', 'Get a branch', (yargs) => yargs, async (args) => await get(args));
 export const handler = (args) => {
     return args;
 };

package/commands/connection_string.js

@@ -1,6 +1,5 @@
 import { EndpointType } from '@neondatabase/api-client';
 import { branchIdFromProps, fillSingleProject } from '../utils/enrichers.js';
-import { showHelpMiddleware } from '../help.js';
 import { writer } from '../writer.js';
 import { psql } from '../utils/psql.js';
 export const command = 'connection-string [branch]';
@@ -9,7 +8,6 @@ export const describe = 'Get connection string';
 export const builder = (argv) => {
     return argv
         .usage('$0 connection-string [branch] [options]')
-        .middleware(showHelpMiddleware(argv, true))
         .positional('branch', {
         describe: 'Branch name or id. If ommited will use the primary branch',
         type: 'string',

package/commands/databases.js

@@ -1,14 +1,12 @@
 import { retryOnLock } from '../api.js';
 import { branchIdFromProps, fillSingleProject } from '../utils/enrichers.js';
 import { writer } from '../writer.js';
-import { showHelpMiddleware } from '../help.js';
 const DATABASE_FIELDS = ['name', 'owner_name', 'created_at'];
 export const command = 'databases';
 export const describe = 'Manage databases';
 export const aliases = ['database', 'db'];
 export const builder = (argv) => argv
     .usage('$0 databases <sub-command> [options]')
-    .middleware(showHelpMiddleware(argv))
     .options({
     'project-id': {
         describe: 'Project ID',

package/commands/operations.js

@@ -1,13 +1,11 @@
 import { fillSingleProject } from '../utils/enrichers.js';
 import { writer } from '../writer.js';
-import { showHelpMiddleware } from '../help.js';
 const OPERATIONS_FIELDS = ['id', 'action', 'status', 'created_at'];
 export const command = 'operations';
 export const describe = 'Manage operations';
 export const aliases = ['operation'];
 export const builder = (argv) => argv
     .usage('$0 operations <sub-command> [options]')
-    .middleware(showHelpMiddleware(argv))
     .options({
     'project-id': {
         describe: 'Project ID',

package/commands/projects.js

@@ -1,4 +1,3 @@
-import { showHelpMiddleware } from '../help.js';
 import { log } from '../log.js';
 import { projectCreateRequest } from '../parameters.gen.js';
 import { writer } from '../writer.js';
@@ -20,7 +19,6 @@ export const aliases = ['project'];
 export const builder = (argv) => {
     return argv
         .usage('$0 projects <sub-command> [options]')
-        .middleware(showHelpMiddleware(argv))
         .command('list', 'List projects', (yargs) => yargs, async (args) => {
         await list(args);
     })

package/commands/roles.js

@@ -1,13 +1,11 @@
 import { retryOnLock } from '../api.js';
 import { branchIdFromProps, fillSingleProject } from '../utils/enrichers.js';
 import { writer } from '../writer.js';
-import { showHelpMiddleware } from '../help.js';
 const ROLES_FIELDS = ['name', 'created_at'];
 export const command = 'roles';
 export const describe = 'Manage roles';
 export const aliases = ['role'];
 export const builder = (argv) => argv
-    .middleware(showHelpMiddleware(argv))
     .usage('$0 roles <sub-command> [options]')
     .options({
     'project-id': {

package/commands/set_context.js

@@ -1,11 +1,8 @@
-import yargs from 'yargs';
-import { showHelpMiddleware } from '../help.js';
 import { updateContextFile } from '../context.js';
 import { branchIdFromProps } from '../utils/enrichers.js';
 export const command = 'set-context';
 export const describe = 'Set the current context';
 export const builder = (argv) => argv
-    .middleware(showHelpMiddleware(yargs, true))
     .usage('$0 set-context [options]')
     .options({
     'project-id': {

package/commands/user.js

@@ -1,8 +1,7 @@
-import { showHelpMiddleware } from '../help.js';
 import { writer } from '../writer.js';
 export const command = 'me';
 export const describe = 'Show current user';
-export const builder = (yargs) => yargs.middleware(showHelpMiddleware(yargs, true));
+export const builder = (yargs) => yargs;
 export const handler = async (args) => {
     await me(args);
 };

package/help.js

@@ -23,6 +23,11 @@ const formatHelp = (help) => {
         });
         commandsBlock.forEach((line) => {
             const [command, description] = splitColumns(line);
+            // patch the previous command if it was multiline
+            if (!description && ui.rows.length > 1) {
+                ui.rows[ui.rows.length - 2][0].text += command;
+                return;
+            }
             ui.div(chalk.cyan(command));
             ui.div({
                 text: chalk.gray(drawPointer(SPACE_WIDTH)),
@@ -112,8 +117,3 @@ export const showHelp = async (argv) => {
     process.stderr.write(formatHelp(help).join('\n') + '\n');
     process.exit(0);
 };
-export const showHelpMiddleware = (argv, ignoreSubCmdPresence) => async (args) => {
-    if ((!ignoreSubCmdPresence && args._.length === 1) || args.help) {
-        await showHelp(argv);
-    }
-};

package/index.js

@@ -25,6 +25,7 @@ import { isAxiosError } from 'axios';
 import { matchErrorCode } from './errors.js';
 import { showHelp } from './help.js';
 import { currentContextFile, enrichFromContext } from './context.js';
+const NO_SUBCOMMANDS_VERBS = ['auth', 'me', 'cs', 'connection-string', 'set-context'];
 let builder = yargs(hideBin(process.argv));
 builder = builder
     .scriptName(pkg.name)
@@ -91,6 +92,19 @@ builder = builder
     },
 })
     .middleware((args) => fillInArgs(args), true)
+    .help(false)
+    .group('help', 'Global options:')
+    .option('help', {
+    describe: 'Show help',
+    type: 'boolean',
+    default: false,
+})
+    .alias('help', 'h')
+    .middleware(async (args) => {
+    if (args.help || args._.length === 1 && !NO_SUBCOMMANDS_VERBS.includes(args._[0])) {
+        await showHelp(builder);
+    }
+})
     .middleware(ensureAuth)
     .middleware(enrichFromContext)
     .command(commands)
@@ -104,14 +118,6 @@ builder = builder
     .middleware(analyticsMiddleware, true)
     .group('version', 'Global options:')
     .alias('version', 'v')
-    .help(false)
-    .group('help', 'Global options:')
-    .option('help', {
-    describe: 'Show help',
-    type: 'boolean',
-    default: false,
-})
-    .alias('help', 'h')
     .completion()
     .scriptName(basename(process.argv[1]) === 'neon' ? 'neon' : 'neonctl')
     .fail(async (msg, err) => {

package/package.json

@@ -5,7 +5,7 @@
     "url": "git@github.com:neondatabase/neonctl.git"
   },
   "type": "module",
-  "version": "1.23.1",
+  "version": "1.23.3",
   "description": "CLI tool for NeonDB Cloud management",
   "main": "index.js",
   "author": "NeonDB",

package/utils/ui.js

@@ -40,7 +40,11 @@ export const consumeBlockIfMatches = (lines, matcher) => {
     }
     return result;
 };
-export const splitColumns = (line) => line.trim().split(/\s{2,}/);
+export const splitColumns = (line) => {
+    const result = line.trim().split(/\s{2,}/);
+    result[1] = result[1] ?? '';
+    return result;
+};
 export const drawPointer = (width) => {
     const result = [];
     result.push('└');