@pnpm/tabtab/lib/filename.js

tab completion helpers, for node cli programs. Inspired by npm completion.

const { COMPLETION_FILE_EXT } = require('./constants');

/**
 * Get a template file name for the SHELL provided.
 * @param {import('./constants').SupportedShell} shell
 * @returns {String}
 */
const templateFileName = shell => {
  const ext = COMPLETION_FILE_EXT[shell];
  if (!ext) {
    throw new Error(`Unsupported shell: ${shell}`);
  }
  return `completion.${ext}`;
};

/**
 * Get a extension for the completion file of the SHELL (without the leading period).
 * @param {String} name
 * @param {import('./constants').SupportedShell} shell
 * @returns {String}
 */
const completionFileName = (name, shell) => {
  const ext = COMPLETION_FILE_EXT[shell];
  if (!ext) {
    throw new Error(`Unsupported shell: ${shell}`);
  }
  return `${name}.${ext}`;
};

/**
 * Get a tabtab file name for the SHELL provided.
 * @param {import('./constants').SupportedShell} shell
 * @returns {String}
 */
const tabtabFileName = shell => {
  const ext = COMPLETION_FILE_EXT[shell];
  if (!ext) {
    throw new Error(`Unsupported shell: ${shell}`);
  }
  return `__tabtab.${ext}`;
};

module.exports = {
  templateFileName,
  completionFileName,
  tabtabFileName,
};