lib/utils.js

import { platform } from 'node:os';
import which from 'which';

import { forceRunAsync } from './run.js';

export function ascending(a, b) {
  if (a === b) return 0;
  return a < b ? -1 : 1;
};

export function descending(a, b) {
  if (a === b) return 0;
  return a > b ? -1 : 1;
};

export function flatten(arr) {
  let result = [];
  for (const item of arr) {
    if (Array.isArray(item)) {
      result = result.concat(flatten(item));
    } else {
      result.push(item);
    }
  }
  return result;
}

export function shortSha(sha) {
  return sha.slice(0, 12);
};

let isGhAvailableCache;
export function isGhAvailable() {
  if (isGhAvailableCache === undefined) {
    isGhAvailableCache = which.sync('gh', { nothrow: true }) !== null;
  }
  return isGhAvailableCache;
};

/**
 * Returns the user's preferred text editor command.
 * @param {object} [options]
 * @param {boolean} [options.git] - Whether to try the GIT_EDITOR environment
 * variable or `git config`.
 * @returns {Promise<string|null>}
 */
export async function getEditor(options = {}) {
  const {
    git = false
  } = options;

  if (git) {
    if (process.env.GIT_EDITOR) {
      return process.env.GIT_EDITOR;
    }
    const out = await forceRunAsync(
      'git',
      ['config', 'core.editor'],
      { captureStdout: 'lines' }
    );
    if (out && out[0]) {
      return out[0];
    }
  }

  return process.env.VISUAL || process.env.EDITOR ||
          (platform() === 'win32' ? 'notepad.exe' : 'vi');
};