22 declarations
(input_paths: InputPath[], task_root_dirs: PathId[], config: GroConfig, timings?: Timings | undefined): Promise<FindTasksResult> import {find_tasks} from '@fuzdev/gro/task.js'; Finds modules from input paths. (see input_path.ts for more)
input_pathsInputPath[]task_root_dirsPathId[]configtimings?TimingsPromise<FindTasksResult>
FindModulesFailure type { type: "unmapped_input_paths"; unmapped_input_paths: InputPath[]; resolved_input_paths: ResolvedInputPath[]; input_paths: InputPath[]; task_root_dirs: PathId[]; reasons: string[]; } | { type: "input_directories_with_no_files"; input_directories_with_no_files: InputPath[]; resolved_input_files: ResolvedInputFile[]; resolved_input_files_by_root_dir: Map<PathId, ResolvedInputFile[]>; resolved_input_paths: ResolvedInputPath[]; input_paths: InputPath[]; task_root_dirs: PathId[]; reasons: string[]; }
import type {FindModulesFailure} from '@fuzdev/gro/task.js'; FindTasksResult type ({ ok: true; } & { value: FoundTasks; }) | (({ ok: false; } & { type: "unmapped_input_paths"; unmapped_input_paths: InputPath[]; resolved_input_paths: ResolvedInputPath[]; input_paths: InputPath[]; task_root_dirs: PathId[]; reasons: string[]; }) | ({ ok: false; } & { type: "input_directories_with_no_files"; input_directories_with_no_files: InputPath[]; resolved_input_files: ResolvedInputFile[]; resolved_input_files_by_root_dir: Map<PathId, ResolvedInputFile[]>; resolved_input_paths: ResolvedInputPath[]; input_paths: InputPath[]; task_root_dirs: PathId[]; reasons: string[]; }))
import type {FindTasksResult} from '@fuzdev/gro/task.js'; FoundTask import type {FoundTask} from '@fuzdev/gro/task.js'; input_pathtype InputPath
idtype PathId
task_root_dirtype PathId
FoundTasks import type {FoundTasks} from '@fuzdev/gro/task.js'; resolved_input_filestype ResolvedInputFile[]
resolved_input_files_by_root_dirtype Map<PathId, ResolvedInputFile[]>
resolved_input_pathstype ResolvedInputPath[]
input_pathstype InputPath[]
task_root_dirstype PathId[]
InvokeTask import type {InvokeTask} from '@fuzdev/gro/task.js'; (call)type (task_name: string, args?: Args | undefined, config?: GroConfig | undefined): Promise<void>
task_namestringargs?Argsconfig?Promise<void>(path: string): boolean import {is_task_path} from '@fuzdev/gro/task.js'; pathstringboolean (found_tasks: FoundTasks, root_path?: PathId): Promise<LoadTasksResult> import {load_tasks} from '@fuzdev/gro/task.js'; found_tasksroot_pathPathIdprocess.cwd()Promise<LoadTasksResult>
LoadedTasks import type {LoadedTasks} from '@fuzdev/gro/task.js'; modulestype TaskModuleMeta[]
found_taskstype FoundTasks
LoadTasksFailure type LoadModulesFailure<TaskModuleMeta>
import type {LoadTasksFailure} from '@fuzdev/gro/task.js'; typetype "load_module_failures"
load_module_failurestype LoadModuleFailure[]
reasonstype string[]
modulestype TaskModuleMeta[]
LoadTasksResult type ({ ok: true; } & { value: LoadedTasks; }) | ({ ok: false; } & LoadTasksFailure)
import type {LoadTasksResult} from '@fuzdev/gro/task.js'; import {SilentError} from '@fuzdev/gro/task.js'; This is used to tell Gro to exit silently, usually still with with a non-zero exit code. Using it means error logging is handled by the code that threw it.
ErrorTask<TArgs, TArgsSchema, TReturn> import type {Task} from '@fuzdev/gro/task.js'; Task<TArgs = Args, TArgsSchema extends z.ZodType<Args, Args> = z.ZodType<Args, Args>, TReturn = unknown>TArgsArgsTArgsSchemaz.ZodType<Args, Args>z.ZodType<Args, Args>TReturnunknownruntype (ctx: TaskContext<TArgs>): TReturn | Promise<TReturn>
ctxTaskContext<TArgs>TReturn | Promise<TReturn>summary?type string
Args?type TArgsSchema
".task.js" import {TASK_FILE_SUFFIX_JS} from '@fuzdev/gro/task.js'; ".task.ts" import {TASK_FILE_SUFFIX_TS} from '@fuzdev/gro/task.js'; string[] import {TASK_FILE_SUFFIXES} from '@fuzdev/gro/task.js'; TaskContext<TArgs> import type {TaskContext} from '@fuzdev/gro/task.js'; TaskContext<TArgs = object>TArgsobjectargstype TArgs
configtype GroConfig
svelte_configResolved on first access, so tasks that don't touch it never pay to read the SvelteKit config.
type Promise<ParsedSvelteConfig>
filertype Filer
logtype Logger
timingstype Timings
invoke_tasktype (task_name: string, args?: Args | undefined, config?: GroConfig | undefined): Promise<void>
task_namestringargs?Argsconfig?Promise<void>import {TaskError} from '@fuzdev/gro/task.js'; This is used by tasks to signal a known failure. It's useful for cleaning up logging because we usually don't need their stack trace.
ErrorTaskModule import type {TaskModule} from '@fuzdev/gro/task.js'; tasktype Task<Args, ZodType<Args, Args, $ZodTypeInternals<Args, Args>>, unknown>
TaskModuleMeta import type {TaskModuleMeta} from '@fuzdev/gro/task.js'; ModuleMeta<TaskModule>nametype string
(id: PathId, task_root_dir: PathId, input_path: InputPath, root_path: PathId): string import {to_task_name} from '@fuzdev/gro/task.js'; idPathIdtask_root_dirPathIdinput_pathroot_pathPathIdstring (mod: Record<string, any>): mod is TaskModule import {validate_task_module} from '@fuzdev/gro/task.js'; modRecord<string, any>boolean