import { AstNode } from './newparser/parser.ts';
import { Result } from './Result.ts';

export type Nodes = AstNode[];

export type ParsingError = {
  /** Relevant nodes that should be shown with the message provided */
  nodes: AstNode[];
  /** Why did the parsing failed? */
  message: string;
};

export type FailedParse = {
  errors: ParsingError[];
  /** The content that was parsed so far */
  partialValue?: unknown;
};

export type ParseContext = {
  /** The nodes we parsed */
  nodes: Nodes;
  /**
   * A set of nodes that were already visited. Helpful when writing a parser,
   * and wanting to skip all the nodes we've already used
   */
  visitedNodes: Set<AstNode>;
  /** The command path breadcrumbs, to print when asking for help */
  hotPath?: string[];
};

export type ParsingResult<Into> = Result<FailedParse, Into>;

export type RegisterOptions = {
  forceFlagLongNames: Set<string>;
  forceFlagShortNames: Set<string>;
};

export type Register = {
  /**
   * Inform the parser with context before parsing.
   * Right now, only used to force flags in the parser.
   */
  register(opts: RegisterOptions): void;
};

export type ArgParser<Into> = Partial<Register> & {
  /**
   * Parse from AST nodes into the value provided in [[Into]].
   *
   * @param context The parsing context
   */
  parse(context: ParseContext): Promise<ParsingResult<Into>>;
};

export type ParsingInto<AP extends ArgParser<any>> = AP extends ArgParser<
  infer R
>
  ? R
  : never;