import type { CommandRegistry } from '../commands';
import type { IStdinContext } from '../context';
import type { Environment } from '../environment';

/**
 * Context within which to call ICommandRunner.tabComplete().
 */
export interface ITabCompleteContext {
  name: string;
  /**
   * Command arguments. The last argument is the one to tab complete and may be an empty string.
   */
  args: string[];

  shellId: string;

  // The following are typed as optional so that an IJavaScriptTabCompleteContext can be passed
  // around as an ITabCompleteContext. In reality they are always set for built-in commands.
  // Need to do this better, i.e. have an interface for built-in commands that always includes
  // these, and the javascript doesn't include any of them.
  commandRegistry?: CommandRegistry;
  environment?: Environment;
  stdinContext?: IStdinContext;
}