neonctl 1.29.1 → 1.29.4

package/src/commands/user.ts

@@ -1,21 +0,0 @@
-import yargs from 'yargs';
-
-import { CommonProps } from '../types.js';
-import { writer } from '../writer.js';
-
-export const command = 'me';
-export const describe = 'Show current user';
-export const builder = (yargs: yargs.Argv) =>
-  yargs.option('context-file', {
-    hidden: true,
-  });
-export const handler = async (args: CommonProps) => {
-  await me(args);
-};
-
-const me = async (props: CommonProps) => {
-  const { data } = await props.apiClient.getCurrentUserInfo();
-  writer(props).end(data, {
-    fields: ['login', 'email', 'name', 'projects_limit'],
-  });
-};

package/src/config.ts

@@ -1,22 +0,0 @@
-import { join } from 'node:path';
-import { homedir } from 'node:os';
-import { existsSync, mkdirSync } from 'node:fs';
-import yargs from 'yargs';
-
-import { isCi } from './env.js';
-
-export const CREDENTIALS_FILE = 'credentials.json';
-
-export const defaultDir = join(
-  process.env.XDG_CONFIG_HOME || join(homedir(), '.config'),
-  'neonctl',
-);
-
-export const ensureConfigDir = async ({
-  'config-dir': configDir,
-  'force-auth': forceAuth,
-}: yargs.Arguments<{ 'config-dir': string }>) => {
-  if (!existsSync(configDir) && (!isCi() || forceAuth)) {
-    mkdirSync(configDir, { recursive: true });
-  }
-};

package/src/context.ts

@@ -1,61 +0,0 @@
-import { accessSync, readFileSync, writeFileSync } from 'node:fs';
-import { homedir } from 'node:os';
-import { normalize, resolve } from 'node:path';
-import yargs from 'yargs';
-
-export type Context = {
-  projectId?: string;
-  branchId?: string;
-};
-
-const CONTEXT_FILE = '.neon';
-const CHECK_FILES = [CONTEXT_FILE, 'package.json', '.git'];
-
-const wrapWithContextFile = (dir: string) => resolve(dir, CONTEXT_FILE);
-
-export const currentContextFile = () => {
-  const cwd = process.cwd();
-  let currentDir = cwd;
-  const root = normalize('/');
-  const home = homedir();
-  while (currentDir !== root && currentDir !== home) {
-    for (const file of CHECK_FILES) {
-      try {
-        accessSync(resolve(currentDir, file));
-        return wrapWithContextFile(currentDir);
-      } catch (e) {
-        // ignore
-      }
-    }
-    currentDir = resolve(currentDir, '..');
-  }
-
-  return wrapWithContextFile(cwd);
-};
-
-export const readContextFile = (file: string): Context => {
-  try {
-    return JSON.parse(readFileSync(file, 'utf-8'));
-  } catch (e) {
-    return {};
-  }
-};
-
-export const enrichFromContext = (
-  args: yargs.Arguments<{ contextFile: string }>,
-) => {
-  if (args._[0] === 'set-context') {
-    return;
-  }
-  const context = readContextFile(args.contextFile);
-  if (!args.branch && !args.id && !args.name) {
-    args.branch = context.branchId;
-  }
-  if (!args.projectId) {
-    args.projectId = context.projectId;
-  }
-};
-
-export const updateContextFile = (file: string, context: Context) => {
-  writeFileSync(file, JSON.stringify(context, null, 2));
-};

package/src/env.ts

@@ -1,7 +0,0 @@
-export const isCi = () => {
-  return process.env.CI !== 'false' && Boolean(process.env.CI);
-};
-
-export const isDebug = () => {
-  return Boolean(process.env.DEBUG);
-};

package/src/errors.ts

@@ -1,24 +0,0 @@
-export type ErrorCode =
-  | 'REQUEST_TIMEOUT'
-  | 'AUTH_FAILED'
-  | 'API_ERROR'
-  | 'UNKNOWN_COMMAND'
-  | 'MISSING_ARGUMENT'
-  | 'UNKNOWN_ERROR';
-
-const ERROR_MATCHERS = [
-  [/^Unknown command: (.*)$/, 'UNKNOWN_COMMAND'],
-  [/^Missing required argument: (.*)$/, 'MISSING_ARGUMENT'],
-] as const;
-export const matchErrorCode = (message?: string): ErrorCode => {
-  if (!message) {
-    return 'UNKNOWN_ERROR';
-  }
-  for (const [matcher, code] of ERROR_MATCHERS) {
-    const match = message.match(matcher);
-    if (match) {
-      return code;
-    }
-  }
-  return 'UNKNOWN_ERROR';
-};

package/src/help.ts

@@ -1,185 +0,0 @@
-import yargs from 'yargs';
-import cliui from 'cliui';
-import chalk from 'chalk';
-
-import {
-  consumeBlockIfMatches,
-  consumeNextMatching,
-  drawPointer,
-  splitColumns,
-} from './utils/ui.js';
-
-// target width for the leftmost column
-const SPACE_WIDTH = 20;
-
-const formatHelp = (help: string) => {
-  const lines = help.split('\n');
-  const result = [] as string[];
-  // full command, like `neonctl projects list`
-  const topLevelCommand = consumeNextMatching(lines, /^.*/);
-
-  if (topLevelCommand) {
-    result.push(
-      chalk.bold(
-        topLevelCommand.replace('[options]', chalk.reset.green('[options]')),
-      ),
-    );
-    result.push('');
-  }
-
-  // commands description block
-  // example command to see: neonctl projects
-  const commandsBlock = consumeBlockIfMatches(lines, /^Commands:/);
-  if (commandsBlock.length > 0) {
-    const header = commandsBlock.shift() as string;
-    result.push(header);
-    const ui = cliui({
-      width: 0,
-    });
-    commandsBlock.forEach((line) => {
-      if (line.match(/^\s{3,}/)) {
-        ui.div(
-          {
-            text: '',
-            width: SPACE_WIDTH,
-            padding: [0, 0, 0, 0],
-          },
-          { text: line.trim(), padding: [0, 0, 0, 0] },
-        );
-        return;
-      }
-
-      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)),
-          width: SPACE_WIDTH,
-          padding: [0, 0, 0, 0],
-        },
-        { text: description, padding: [0, 0, 0, 2] },
-      );
-    });
-    result.push(ui.toString());
-    result.push('');
-  }
-
-  // positional args block
-  // example command to see: neonctl branches rename
-  const positionalsBlock = consumeBlockIfMatches(lines, /Positionals:/);
-  if (positionalsBlock.length > 0) {
-    const header = positionalsBlock.shift() as string;
-    result.push(header);
-    const ui = cliui({
-      width: 0,
-    });
-    positionalsBlock.forEach((line) => {
-      const [positional, description] = splitColumns(line);
-      ui.div(
-        {
-          text: positional,
-          width: SPACE_WIDTH,
-          padding: [0, 2, 0, 0],
-        },
-        {
-          text: description,
-          padding: [0, 0, 0, 0],
-        },
-      );
-    });
-    result.push(ui.toString());
-    result.push('');
-  }
-
-  // command description
-  // example command to see: neonctl projects list
-  const descritpionBlock = consumeBlockIfMatches(lines, /^(?!.*options:)/i);
-  if (descritpionBlock.length > 0) {
-    result.push(...descritpionBlock);
-    result.push('');
-  }
-
-  while (true) {
-    // there are two options blocks: global and specific
-    // example to see both: neonctl projects create
-    const optionsBlock = consumeBlockIfMatches(lines, /.*options:/i);
-    if (optionsBlock.length === 0) {
-      break;
-    }
-    result.push(optionsBlock.shift() as string);
-    optionsBlock.forEach((line) => {
-      const [option, description] = splitColumns(line);
-      const ui = cliui({
-        width: 0,
-      });
-      if (option.startsWith('-')) {
-        ui.div({
-          text: chalk.green(option),
-          padding: [0, 0, 0, 0],
-        });
-        ui.div(
-          {
-            text: chalk.gray(drawPointer(SPACE_WIDTH)),
-            width: SPACE_WIDTH,
-            padding: [0, 2, 0, 0],
-          },
-          {
-            text: chalk.rgb(210, 210, 210)(description ?? ''),
-            padding: [0, 0, 0, 0],
-          },
-        );
-      } else {
-        ui.div(
-          {
-            padding: [0, 0, 0, 0],
-            text: '',
-            width: SPACE_WIDTH,
-          },
-          {
-            text: chalk.rgb(210, 210, 210)(option),
-            padding: [0, 0, 0, 0],
-          },
-        );
-      }
-
-      result.push(ui.toString());
-    });
-    result.push('');
-  }
-
-  const exampleBlock = consumeBlockIfMatches(lines, /Examples:/);
-  if (exampleBlock.length > 0) {
-    result.push(exampleBlock.shift() as string);
-    const ui = cliui({
-      width: 0,
-    });
-    for (const line of exampleBlock) {
-      const [command, description] = splitColumns(line);
-      ui.div({
-        text: chalk.bold(command),
-        padding: [0, 0, 0, 0],
-      });
-      ui.div({
-        text: chalk.reset(description),
-        padding: [0, 0, 0, 2],
-      });
-    }
-    result.push(ui.toString());
-  }
-
-  return [...result, ...lines];
-};
-
-export const showHelp = async (argv: yargs.Argv) => {
-  // add wrap to ensure that there are no line breaks
-  const help = await argv.getHelp();
-  process.stderr.write(formatHelp(help).join('\n') + '\n');
-  process.exit(0);
-};

package/src/index.ts

@@ -1,180 +0,0 @@
-import { basename } from 'node:path';
-import yargs from 'yargs';
-import { hideBin } from 'yargs/helpers';
-import axiosDebug from 'axios-debug-log';
-axiosDebug({
-  request(debug, config) {
-    debug(`${config.method?.toUpperCase()} ${config.url}`);
-  },
-  response(debug, response) {
-    debug(`${response.status} ${response.statusText}`);
-  },
-  error(debug, error) {
-    debug(error);
-  },
-});
-import { Api } from '@neondatabase/api-client';
-
-import { ensureAuth } from './commands/auth.js';
-import { defaultDir, ensureConfigDir } from './config.js';
-import { log } from './log.js';
-import { defaultClientID } from './auth.js';
-import { fillInArgs } from './utils/middlewares.js';
-import pkg from './pkg.js';
-import commands from './commands/index.js';
-import { analyticsMiddleware, sendError } from './analytics.js';
-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)
-  .locale('en')
-  .usage('$0 <command> [options]')
-  .parserConfiguration({
-    'populate--': true,
-  })
-  .help()
-  .option('output', {
-    alias: 'o',
-    group: 'Global options:',
-    describe: 'Set output format',
-    type: 'string',
-    choices: ['json', 'yaml', 'table'],
-    default: 'table',
-  })
-  .option('api-host', {
-    describe: 'The API host',
-    hidden: true,
-    default: process.env.NEON_API_HOST ?? 'https://console.neon.tech/api/v2',
-  })
-  // Setup config directory
-  .option('config-dir', {
-    describe: 'Path to config directory',
-    group: 'Global options:',
-    type: 'string',
-    default: defaultDir,
-  })
-  .option('force-auth', {
-    describe: 'Force authentication',
-    type: 'boolean',
-    hidden: true,
-    default: false,
-  })
-  .middleware(ensureConfigDir)
-  .options({
-    'oauth-host': {
-      description: 'URL to Neon OAuth host',
-      hidden: true,
-      default: process.env.NEON_OAUTH_HOST ?? 'https://oauth2.neon.tech',
-    },
-    'client-id': {
-      description: 'OAuth client id',
-      hidden: true,
-      type: 'string',
-      default: defaultClientID,
-    },
-    'api-key': {
-      describe: 'API key',
-      group: 'Global options:',
-      type: 'string',
-      default: process.env.NEON_API_KEY ?? '',
-    },
-    apiClient: {
-      hidden: true,
-      coerce: (v) => v as Api<unknown>,
-      default: null as unknown as Api<unknown>,
-    },
-    'context-file': {
-      describe: 'Context file',
-      type: 'string',
-      default: currentContextFile,
-    },
-  })
-  .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] as string))
-    ) {
-      await showHelp(builder);
-    }
-  })
-  .middleware(ensureAuth)
-  .middleware(enrichFromContext as any)
-  .command(commands as any)
-  .strictCommands()
-  .option('analytics', {
-    describe: 'Manage analytics. Example: --no-analytics, --analytics false',
-    group: 'Global options:',
-    type: 'boolean',
-    default: true,
-  })
-  .middleware(analyticsMiddleware, true)
-  .group('version', 'Global options:')
-  .alias('version', 'v')
-  .completion()
-  .scriptName(basename(process.argv[1]) === 'neon' ? 'neon' : 'neonctl')
-  .epilog(
-    'For more information, visit https://neon.tech/docs/reference/neon-cli',
-  )
-  .wrap(null)
-  .fail(async (msg, err) => {
-    if (process.argv.some((arg) => arg === '--help' || arg === '-h')) {
-      await showHelp(builder);
-      process.exit(0);
-    }
-
-    if (isAxiosError(err)) {
-      if (err.code === 'ECONNABORTED') {
-        log.error('Request timed out');
-        sendError(err, 'REQUEST_TIMEOUT');
-      } else if (err.response?.status === 401) {
-        sendError(err, 'AUTH_FAILED');
-        log.error('Authentication failed, please run `neonctl auth`');
-      } else {
-        if (err.response?.data?.message) {
-          log.error(err.response?.data?.message);
-        }
-        log.debug(
-          'status: %d %s | path: %s',
-          err.response?.status,
-          err.response?.statusText,
-          err.request?.path,
-        );
-        sendError(err, 'API_ERROR');
-      }
-    } else {
-      sendError(err || new Error(msg), matchErrorCode(msg || err?.message));
-      log.error(msg || err?.message);
-    }
-    err?.stack && log.debug('Stack: %s', err.stack);
-    process.exit(1);
-  });
-
-(async () => {
-  const args = await builder.argv;
-  if (args._.length === 0 || args.help) {
-    await showHelp(builder);
-    process.exit(0);
-  }
-})();

package/src/log.ts

@@ -1,16 +0,0 @@
-import { format } from 'node:util';
-import { isDebug } from './env.js';
-
-export const log = {
-  debug: (...args: unknown[]) => {
-    if (isDebug()) {
-      process.stderr.write(`DEBUG: ${format(...args)}\n`);
-    }
-  },
-  info: (...args: unknown[]) => {
-    process.stderr.write(`INFO: ${format(...args)}\n`);
-  },
-  error: (...args: unknown[]) => {
-    process.stderr.write(`ERROR: ${format(...args)}\n`);
-  },
-};