interface ClideHooks { afterExecute: ( payload: { result: unknown; setResult: (result: unknown) => void; state: State; }, ) => MaybePromise<void>; afterParse: ( payload: { context: Context; parsedOptions: { [key: string]: | undefined | OptionPrimitiveType<(keyof OptionPrimitiveTypeMap)
>; }; setParsedOptions: ( optionValues: { [key: string]: | undefined | OptionPrimitiveType<(keyof OptionPrimitiveTypeMap)
>; }, ) => void; }, ) => MaybePromise<void>; afterResolve: ( payload: { addResolvedCommands: (resolvedCommands: ResolvedCommand[]) => void; context: Context; resolvedCommands: ResolvedCommand[]; }, ) => MaybePromise<void>; afterStateChange: ( payload: { changes: Partial<NextState>; state: State }, ) => MaybePromise<void>; beforeEnd: ( payload: { data: unknown; setData: (data: unknown) => void; state: State; }, ) => MaybePromise<void>; beforeExecute: ( payload: { initialData: unknown; setInitialData: (data: unknown) => void; setResultAndSkip: (result: unknown) => void; skip: () => void; state: State; }, ) => MaybePromise<void>; beforeNext: ( payload: { data: unknown; nextCommand: undefined | ResolvedCommand; setData: (data: unknown) => void; setNextCommand: (command: ResolvedCommand) => void; state: State; }, ) => MaybePromise<void>; beforeParse: ( payload: { commandString: string | string[]; context: Context; optionsConfig: OptionsConfig; setParsedOptionsAndSkip: ( optionValues: { [key: string]: | undefined | OptionPrimitiveType<(keyof OptionPrimitiveTypeMap)
>; }, ) => void; setParseFn: (parseFn: ParseCommandFn) => void; skip: () => void; }, ) => MaybePromise<void>; beforeResolve: ( payload: { addResolvedCommands: (resolvedCommands: ResolvedCommand[]) => void; commandsDir: string; commandString: string; context: Context; setParseFn: (parseFn: ParseCommandFn) => void; setResolveFn: (resolveFn: ResolveCommandFn) => void; skip: () => void; }, ) => MaybePromise<void>; beforeResolveNext: ( payload: { addResolvedCommands: (resolvedCommands: ResolvedCommand[]) => void; commandsDir: string; commandString: string; context: Context; lastResolved: ResolvedCommand; setParseFn: (parseFn: ParseCommandFn) => void; setResolveFn: (resolveFn: ResolveCommandFn) => void; skip: () => void; }, ) => MaybePromise<void>; beforeStateChange: ( payload: { changes: Partial<NextState>; setChanges: (changes: Partial<NextState>) => void; skip: () => void; state: State; }, ) => MaybePromise<void>; error: ( payload: { context: Context; error: unknown; ignore: () => void; setError: (error: unknown) => void; }, ) => MaybePromise<void>; exit: ( payload: { cancel: () => void; code: number; context: Context; message?: any; setCode: (code: number) => void; setMessage: (message: any) => void; }, ) => MaybePromise<void>;} Properties
afterExecute
afterExecute: ( payload: { result: unknown; setResult: (result: unknown) => void; state: State; },) => MaybePromise<void> afterParse
afterParse: ( payload: { context: Context; parsedOptions: { [key: string]: | undefined | OptionPrimitiveType<(keyof OptionPrimitiveTypeMap)
>; }; setParsedOptions: ( optionValues: { [key: string]: | undefined | OptionPrimitiveType<(keyof OptionPrimitiveTypeMap)
>; }, ) => void; },) => MaybePromise<void> afterStateChange
afterStateChange: ( payload: { changes: Partial<NextState>; state: State },) => MaybePromise<void> beforeEnd
beforeEnd: ( payload: { data: unknown; setData: (data: unknown) => void; state: State; },) => MaybePromise<void> beforeExecute
beforeExecute: ( payload: { initialData: unknown; setInitialData: (data: unknown) => void; setResultAndSkip: (result: unknown) => void; skip: () => void; state: State; },) => MaybePromise<void> beforeNext
beforeNext: ( payload: { data: unknown; nextCommand: undefined | ResolvedCommand; setData: (data: unknown) => void; setNextCommand: (command: ResolvedCommand) => void; state: State; },) => MaybePromise<void> beforeParse
beforeParse: ( payload: { commandString: string | string[]; context: Context; optionsConfig: OptionsConfig; setParsedOptionsAndSkip: ( optionValues: { [key: string]: | undefined | OptionPrimitiveType<(keyof OptionPrimitiveTypeMap)
>; }, ) => void; setParseFn: (parseFn: ParseCommandFn) => void; skip: () => void; },) => MaybePromise<void> beforeResolve
beforeResolve: ( payload: { addResolvedCommands: (resolvedCommands: ResolvedCommand[]) => void; commandsDir: string; commandString: string; context: Context; setParseFn: (parseFn: ParseCommandFn) => void; setResolveFn: (resolveFn: ResolveCommandFn) => void; skip: () => void; },) => MaybePromise<void> beforeResolveNext
beforeResolveNext: ( payload: { addResolvedCommands: (resolvedCommands: ResolvedCommand[]) => void; commandsDir: string; commandString: string; context: Context; lastResolved: ResolvedCommand; setParseFn: (parseFn: ParseCommandFn) => void; setResolveFn: (resolveFn: ResolveCommandFn) => void; skip: () => void; },) => MaybePromise<void> beforeStateChange
beforeStateChange: ( payload: { changes: Partial<NextState>; setChanges: (changes: Partial<NextState>) => void; skip: () => void; state: State; },) => MaybePromise<void> error
error: ( payload: { context: Context; error: unknown; ignore: () => void; setError: (error: unknown) => void; },) => MaybePromise<void> exit
exit: ( payload: { cancel: () => void; code: number; context: Context; message?: any; setCode: (code: number) => void; setMessage: (message: any) => void; },) => MaybePromise<void>
The core hooks interface that defines lifecycle events for the CLI execution process. Hooks are called in sequential order as listed below.