branch-remover/src/CommandLine/CommandLineParams.ts

A small application for quickly removing unnecessary branches from GitHub.

export type CommandLineParams = {

  version?: boolean;

  help?: boolean;

  /**
   * Indicates that the script is running in test mode and should not actually delete branches.
   */
  test?: boolean;

  /**
   * Indicates that the script should not ask the user for confirmation to delete branches.
   */
  quiet?: boolean;

  /**
   * Indicates that the default answer should be YES.
   */
  yes?: boolean;

  /**
   * Indicates the need to display detailed information about each branch.
   */
  details?: boolean;

  /**
   * API provider for working with branches.
   */
  provider?: string;

  /**
   * Regular expression to check for branch names that should be ignored.
   */
  ignore?: string;

  /**
   * Rules for deleting merged branches.
   */
  merged?: string;

  /**
   * Rules for deleting stale branches.
   */
  stale?: string;

  /**
   * Path to custom config file.
   */
  config?: string;

  /**
   * The command or file path to be executed before removing a branch.
   */
  before?: string;

  /**
   * The command or path to the file that will be executed after removing the branch.
   */
  after?: string;

  /**
   * Specifies caching options.
   */
  cache?: string;

  /**
   * Enables the output of debug information.
   */
  debug?: boolean;

};