Function getHookListrTasks

packages/api/core/src/util/hook.ts:35–75

(
  childTrace: typeof autoTrace,
  forgeConfig: ResolvedForgeConfig,
  hookName: Hook,
  ...hookArgs: ForgeSimpleHookSignatures[Hook]
)

};

export const getHookListrTasks = async <
  Hook extends keyof ForgeSimpleHookSignatures,
>(
  childTrace: typeof autoTrace,
  forgeConfig: ResolvedForgeConfig,
  hookName: Hook,
  ...hookArgs: ForgeSimpleHookSignatures[Hook]
): Promise<ForgeListrTaskDefinition[]> => {
  const { hooks } = forgeConfig;
  const tasks: ForgeListrTaskDefinition[] = [];
  if (hooks) {
    d(`hook triggered: ${hookName}`);
    if (typeof hooks[hookName] === 'function') {
      d('calling hook:', hookName, 'with args:', hookArgs);
      tasks.push({
        title: `Running ${chalk.yellow(hookName)} hook from forgeConfig`,
        task: childTrace(
          {
            name: 'forge-config-hook',
            category: '@electron-forge/hooks',
            extraDetails: { hook: hookName },
          },
          async () => {
            await (hooks[hookName] as ForgeSimpleHookFn<Hook>)(
              forgeConfig,
              ...hookArgs,
            );
          },
        ),
      });
    }
  }
  tasks.push(
    ...(await forgeConfig.pluginInterface.getHookListrTasks(
      childTrace,
      hookName,
      hookArgs,
    )),
  );
  return tasks;
};

export async function runMutatingHook<
  Hook extends keyof ForgeMutatingHookSignatures,