@pixpilot/scaffoldfy 0.37.0 → 0.39.0

package/dist/index.d.cts

@@ -228,7 +228,7 @@ interface DefaultValueConfig<T = string | number | boolean> {
  * - For explicit static values, use { type: 'static', value: yourValue }
  * - For conditional defaults, use { type: 'conditional', condition: 'expression', ifTrue: value, ifFalse: value }
  * - For interpolate strings, use { type: 'interpolate', value: '{{variable}}' } (will be interpolated with previously resolved prompts/variables)
- * - For exec-file, use { type: 'exec-file', file: 'path/to/script.js', args: [...], parameters: {...} }
+ * - For exec-file, use { type: 'exec-file', file: 'path/to/script', args: [...], parameters: {...} }
  */
 type DefaultValue<T = string | number | boolean> = T | DefaultValueConfig<T> | ConditionalDefaultConfig<T> | ExecFileValueConfig;
 /**
@@ -267,7 +267,7 @@ interface BasePrompt {
   required?: DynamicBooleanValue;
   enabled?: DynamicBooleanValue;
   override?: MergeStrategy;
-  $templateEnabled?: DynamicBooleanValue;
+  $configEnabled?: DynamicBooleanValue;
   $sourceUrl?: string;
   transformers?: string[];
 }
@@ -307,7 +307,7 @@ interface VariableDefinition {
   enabled?: DynamicBooleanValue;
   required?: DynamicBooleanValue;
   override?: MergeStrategy;
-  $templateEnabled?: DynamicBooleanValue;
+  $configEnabled?: DynamicBooleanValue;
   $sourceUrl?: string;
   transformers?: string[];
 }
@@ -342,7 +342,7 @@ interface TaskDefinition {
   rollback?: RollbackConfig;
   override?: MergeStrategy;
   $sourceUrl?: string;
-  $templateEnabled?: DynamicBooleanValue;
+  $configEnabled?: DynamicBooleanValue;
 }
 /**
  * Configuration file structure for template tasks
@@ -382,19 +382,62 @@ interface PluginHooks {
   onError?: (error: Error, task?: TaskDefinition) => Promise<void>;
 }
 //#endregion
-//#region src/dry-run.d.ts
+//#region src/configurations/cache.d.ts
 /**
- * Get diff for update-json task
+ * Clear the configuration cache (useful for testing)
  */
-declare function getUpdateJsonDiff(config: UpdateJsonConfig, initConfig: InitConfig): Promise<string>;
+declare function clearConfigurationCache(): void;
+//#endregion
+//#region src/configurations/load-configuration.d.ts
+/**
+ * Load a configuration file from local path or remote URL
+ * @param configPath - Path or URL to the configuration file
+ * @param visitedPaths - Set of already visited paths to detect circular dependencies
+ * @returns The loaded configuration
+ */
+declare function loadConfiguration(configPath: string, visitedPaths?: Set<string>): Promise<TasksConfiguration>;
+//#endregion
+//#region src/configurations/load-tasks-with-inheritance.d.ts
+/**
+ * Recursively load and merge configurations
+ * @param configPath - Path or URL to the configuration file
+ * @param baseDir - Base directory or URL for resolving relative paths in extends
+ * @param visitedPaths - Set of already visited paths
+ * @returns Merged configuration
+ */
+declare function loadAndMergeConfiguration(configPath: string, baseDir?: string, visitedPaths?: Set<string>): Promise<TasksConfiguration>;
+/**
+ * Load tasks from a configuration file with configuration inheritance support
+ * @param tasksFilePath - Path to the tasks configuration file
+ * @param options - Optional configuration
+ * @param options.sequential - If true, return configurations as separate items for sequential processing
+ * @returns Task configuration with tasks, optional variables, and optional prompts
+ */
+declare function loadTasksWithInheritance(tasksFilePath: string, options?: {
+  sequential?: boolean;
+}): Promise<{
+  tasks: TaskDefinition[];
+  variables?: VariableDefinition[];
+  prompts?: PromptDefinition[];
+  enabled?: EnabledValue;
+  configs?: TasksConfiguration[];
+  transformers?: Transformer[];
+}>;
+//#endregion
+//#region src/configurations/merge-configurations.d.ts
 /**
- * Get diff for write task
+ * Merge multiple configurations
+ * Later configurations override earlier ones for conflicting task IDs
+ * @param configurations - Array of configurations to merge (in priority order)
+ * @returns Merged configuration
  */
-declare function getWriteDiff(config: WriteConfig, initConfig: InitConfig): Promise<string>;
+declare function mergeConfigurations(configurations: TasksConfiguration[]): TasksConfiguration;
+//#endregion
+//#region src/dry-run/content-tasks.d.ts
 /**
- * Get diff for create task
+ * Get diff for update-json task
  */
-declare function getCreateDiff(config: CreateConfig, initConfig: InitConfig, task?: TaskDefinition): Promise<string>;
+declare function getUpdateJsonDiff(config: UpdateJsonConfig, initConfig: InitConfig): Promise<string>;
 /**
  * Get diff for regex-replace task
  */
@@ -403,6 +446,8 @@ declare function getRegexReplaceDiff(config: RegexReplaceConfig, initConfig: Ini
  * Get diff for replace-in-file task
  */
 declare function getReplaceInFileDiff(config: ReplaceInFileConfig, initConfig: InitConfig): Promise<string>;
+//#endregion
+//#region src/dry-run/file-tasks.d.ts
 /**
  * Get diff for delete task
  */
@@ -411,6 +456,8 @@ declare function getDeleteDiff(config: DeleteConfig, initConfig: InitConfig): st
  * Get diff for rename task
  */
 declare function getRenameDiff(config: RenameConfig, initConfig: InitConfig): string;
+//#endregion
+//#region src/dry-run/system-tasks.d.ts
 /**
  * Get diff for git-init task
  */
@@ -419,6 +466,8 @@ declare function getGitInitDiff(config: GitInitConfig): string;
  * Get diff for exec task
  */
 declare function getExecDiff(config: ExecConfig, initConfig: InitConfig): string;
+//#endregion
+//#region src/dry-run/index.d.ts
 /**
  * Get diff for any task type
  */
@@ -471,26 +520,6 @@ declare function clearPlugins(): void;
  * @param hooks - Hook functions to register
  */
 declare function registerHooks(hooks: Partial<PluginHooks>): void;
-/**
- * Call a lifecycle hook
- * @param hookName - Name of the hook
- * @param config - Initialization config for beforeAll/afterAll
- */
-declare function callHook(hookName: 'beforeAll' | 'afterAll', config: InitConfig): Promise<void>;
-/**
- * Call a lifecycle hook
- * @param hookName - Name of the hook
- * @param task - Task definition for beforeTask/afterTask
- * @param config - Initialization config
- */
-declare function callHook(hookName: 'beforeTask' | 'afterTask', task: TaskDefinition, config: InitConfig): Promise<void>;
-/**
- * Call a lifecycle hook
- * @param hookName - Name of the hook
- * @param error - Error that occurred
- * @param task - Optional task definition
- */
-declare function callHook(hookName: 'onError', error: Error, task?: TaskDefinition): Promise<void>;
 /**
  * Execute a plugin task
  * @param task - The task to execute
@@ -502,19 +531,6 @@ declare function callHook(hookName: 'onError', error: Error, task?: TaskDefiniti
 declare function executePluginTask(task: TaskDefinition, config: InitConfig, options: {
   dryRun: boolean;
 }): Promise<void>;
-/**
- * Get diff for a plugin task
- * @param task - The task to generate diff for
- * @param config - The initialization config
- * @returns Diff string or undefined if not supported
- */
-declare function getPluginTaskDiff(task: TaskDefinition, config: InitConfig): Promise<string | undefined>;
-/**
- * Validate a plugin task
- * @param task - The task to validate
- * @returns Array of validation errors
- */
-declare function validatePluginTask(task: TaskDefinition): string[];
 /**
  * Create a simple task plugin
  * @param name - Plugin name
@@ -534,280 +550,27 @@ declare function createTaskPlugin(name: string, taskType: string, execute: (task
   validate?: (task: TaskDefinition) => string[];
 }): TaskPlugin;
 //#endregion
-//#region src/prompts/collect-prompts.d.ts
-/**
- * Collect prompt answers from task-defined prompts
- * Only prompts with enabled=true (or enabled condition that evaluates to true) will be shown
- * @param prompts - Array of prompt definitions from tasks
- * @param resolvedDefaults - Map of pre-resolved default values
- * @param config - Current configuration context (for evaluating enabled conditions)
- * @returns Object mapping prompt IDs to their values
- */
-declare function collectPrompts(prompts: PromptDefinition[], resolvedDefaults?: Map<string, unknown>, config?: InitConfig): Promise<Record<string, unknown>>;
-//#endregion
-//#region src/prompts/resolve-all-default-values.d.ts
-/**
- * Pre-resolve all executable default values in parallel
- * @param prompts - Array of prompt definitions
- * @param context - Optional context for interpolating template variables
- * @returns Map of prompt IDs to their resolved default values
- */
-declare function resolveAllDefaultValues(prompts: PromptDefinition[], context?: InitConfig): Promise<Map<string, unknown>>;
-//#endregion
-//#region src/prompts/resolve-default-value.d.ts
-/**
- * Resolve a default value that may be static or executable
- * @param defaultValue - The default value configuration
- * @param promptId - The prompt ID for error reporting
- * @param context - Optional context for interpolating template variables in string defaults
- * @param prompt - Optional prompt definition for accessing $sourceUrl
- * @returns The resolved default value
- */
-declare function resolveDefaultValue<T = string | number | boolean>(defaultValue: DefaultValue<T> | undefined, promptId: string, context?: InitConfig, prompt?: PromptDefinition): Promise<T | undefined>;
-//#endregion
-//#region src/prompts/validate-prompts.d.ts
-/**
- * Validate prompt definitions
- * @param prompts - Array of prompt definitions to validate
- * @returns Array of validation error messages
- */
-declare function validatePrompts(prompts: PromptDefinition[]): string[];
-//#endregion
-//#region src/run-tasks.d.ts
-/**
- * Core task execution logic shared by both main() and runWithTasks()
- */
-declare function runTasks(tasks: TaskDefinition[], options: {
-  dryRun: boolean;
-  force: boolean;
-  tasksFilePath: string | undefined;
-  variables?: VariableDefinition[];
-  prompts?: PromptDefinition[];
-  templateEnabled?: EnabledValue;
-  transformers?: Transformer[];
-}): Promise<void>;
-/**
- * Run templates sequentially for variables/prompts, then all tasks together
- * Phase 1: Process variables and prompts sequentially from each template
- * Phase 2: Collect all tasks from all enabled templates
- * Phase 3: Execute all tasks together at the end
- * This allows later templates to use values from earlier templates in their conditions,
- * while still executing all tasks together after all variables/prompts are resolved
- */
-declare function runTemplatesSequentially(templates: TasksConfiguration[], options: {
-  dryRun: boolean;
-  force: boolean;
-  tasksFilePath: string | undefined;
-}, config?: InitConfig): Promise<void>;
-//#endregion
-//#region src/task-executors.d.ts
-declare function registerBuiltInPlugins(): void;
-/**
- * Execute a task based on its type
- */
-declare function executeTask(task: TaskDefinition, config: InitConfig, dryRun?: boolean): Promise<void>;
-/**
- * Run a single task with error handling
- */
-declare function runTask(task: TaskDefinition, config: InitConfig, taskNumber: number, totalTasks: number, dryRun?: boolean): Promise<boolean>;
-//#endregion
-//#region src/task-resolver.d.ts
-/**
- * Sort tasks by dependencies using topological sort
- */
-declare function topologicalSort(tasks: TaskDefinition[]): TaskDefinition[];
-//#endregion
-//#region src/template-inheritance.d.ts
-/**
- * Load a template configuration file from local path or remote URL
- * @param templatePath - Path or URL to the template file
- * @param visitedPaths - Set of already visited paths to detect circular dependencies
- * @returns The loaded template configuration
- */
-declare function loadTemplate(templatePath: string, visitedPaths?: Set<string>): Promise<TasksConfiguration>;
-/**
- * Load all templates in dependency order without merging
- * @param templatePath - Path or URL to the template file
- * @param baseDir - Base directory or URL for resolving relative paths in extends
- * @param visitedPaths - Set of already visited paths
- * @returns Array of sorted templates (in dependency order, ready for sequential processing)
- */
-declare function loadTemplatesInOrder(templatePath: string, baseDir?: string, visitedPaths?: Set<string>): Promise<TasksConfiguration[]>;
-/**
- * Recursively load and merge templates
- * @param templatePath - Path or URL to the template file
- * @param baseDir - Base directory or URL for resolving relative paths in extends
- * @param visitedPaths - Set of already visited paths
- * @returns Merged template configuration
- */
-declare function loadAndMergeTemplate(templatePath: string, baseDir?: string, visitedPaths?: Set<string>): Promise<TasksConfiguration>;
-/**
- * Merge multiple template configurations
- * Later templates override earlier ones for conflicting task IDs
- * @param templates - Array of templates to merge (in priority order)
- * @returns Merged template configuration
- */
-declare function mergeTemplates(templates: TasksConfiguration[]): TasksConfiguration;
-/**
- * Clear the template cache (useful for testing)
- */
-declare function clearTemplateCache(): void;
-/**
- * Load tasks from a configuration file with template inheritance support
- * @param tasksFilePath - Path to the tasks configuration file
- * @param options - Optional configuration
- * @param options.sequential - If true, return templates as separate items for sequential processing
- * @returns Task configuration with tasks, optional variables, and optional prompts
- */
-declare function loadTasksWithInheritance(tasksFilePath: string, options?: {
-  sequential?: boolean;
-}): Promise<{
-  tasks: TaskDefinition[];
-  variables?: VariableDefinition[];
-  prompts?: PromptDefinition[];
-  enabled?: EnabledValue;
-  templates?: TasksConfiguration[];
-  transformers?: Transformer[];
-}>;
-//#endregion
-//#region src/template-utils.d.ts
-/**
- * Configuration for template/templateFile properties
- */
-interface TemplateSource {
-  template?: string;
-  templateFile?: string;
-}
-/**
- * Result of template validation
- */
-interface TemplateValidationResult {
-  isValid: boolean;
-  hasInlineTemplate: boolean;
-  hasTemplateFile: boolean;
-  error?: string;
-}
-/**
- * Options for processing templates
- */
-interface ProcessTemplateOptions {
-  /** Enable Handlebars compilation for .hbs files */
-  enableHandlebars?: boolean;
-  /** Source URL for resolving relative template paths */
-  sourceUrl?: string;
-}
-/**
- * Check if a config has an inline template
- * @param config - Configuration object with potential template property
- * @returns True if inline template is present and non-empty
- */
-declare function hasInlineTemplate(config: TemplateSource): boolean;
-/**
- * Check if a config has a template file reference
- * @param config - Configuration object with potential templateFile property
- * @returns True if templateFile is present and non-empty
- */
-declare function hasTemplateFile(config: TemplateSource): boolean;
-/**
- * Check if a template file should be processed with Handlebars
- * @param templateFile - Path to the template file
- * @returns True if the file has .hbs extension
- */
-declare function shouldUseHandlebars(templateFile: string): boolean;
-/**
- * Validate template configuration
- * @param config - Configuration object to validate
- * @returns Validation result with details
- */
-declare function validateTemplateConfig(config: TemplateSource): TemplateValidationResult;
-/**
- * Process a template and return the rendered content
- * @param config - Template configuration
- * @param initConfig - Initialization config with variable values
- * @param task - Optional task definition for $sourceUrl resolution
- * @param options - Processing options
- * @returns Processed template content
- */
-declare function processTemplate(config: TemplateSource, initConfig: InitConfig, task?: TaskDefinition, options?: ProcessTemplateOptions): Promise<string>;
-/**
- * Get a description of the template source for display purposes
- * @param config - Template configuration
- * @returns Human-readable description of the template source
- */
-declare function getTemplateSourceDescription(config: TemplateSource): string;
-//#endregion
-//#region src/variables/collect-variables.d.ts
-/**
- * Collect variable values from resolved variables
- * Variables don't require user interaction - they're just resolved from static
- * values or executable commands
- *
- * @param variables - Array of variable definitions
- * @param resolvedValues - Map of pre-resolved variable values
- * @param context - Current configuration context (for transformer evaluation)
- * @returns Object mapping variable IDs to their values
- */
-declare function collectVariables(variables: VariableDefinition[], resolvedValues?: Map<string, unknown>, context?: InitConfig): Promise<Record<string, unknown>>;
-//#endregion
-//#region src/variables/resolve-all-variable-values.d.ts
-/**
- * Resolve all variable values sequentially to allow lazy evaluation of template enabled conditions
- * Each variable can access values from previous variables and prompts
- * @param variables - Array of variable definitions
- * @param context - Optional context for evaluating conditional variables
- * @param options - Optional resolution options
- * @param options.skipConditional - If true, skip conditional variables (they will be resolved later)
- * @returns Map of variable IDs to their resolved values
- */
-declare function resolveAllVariableValues(variables: VariableDefinition[], context?: InitConfig, options?: {
-  skipConditional?: boolean;
-}): Promise<Map<string, unknown>>;
-//#endregion
-//#region src/variables/resolve-variable-value.d.ts
-/**
- * Resolve a variable value that may be static, executable, or conditional
- * @param value - The variable value configuration
- * @param variableId - The variable ID for error reporting
- * @param context - Optional context for evaluating conditional values
- * @param sourceUrl - Optional source URL for resolving relative file paths in exec-file
- * @returns The resolved variable value
- */
-declare function resolveVariableValue<T = string | number | boolean>(value: DefaultValue<T>, variableId: string, context?: InitConfig, sourceUrl?: string): Promise<T | undefined>;
-//#endregion
-//#region src/variables/validate-variables.d.ts
-/**
- * Validate variable definitions for duplicate IDs
- * @param variables - Array of variable definitions to validate
- * @returns Array of error messages (empty if no errors)
- */
-declare function validateVariables(variables: VariableDefinition[]): string[];
-//#endregion
 //#region src/index.d.ts
-/**
- * Main function for executing tasks with default/empty tasks array
- * For most use cases, you should use runWithTasks() with your custom tasks
- */
-declare function main(customTasks?: TaskDefinition[]): Promise<void>;
 /**
  * Execute tasks with custom task definitions
  * @param customTasks - Array of task definitions to execute
  * @param options - Optional configuration
  * @param options.dryRun - Preview changes without applying them
  * @param options.force - Force execution even if checks fail
- * @param options.tasksFilePath - Path to the tasks file
+ * @param options.configFilePath - Path to the tasks file
  * @param options.variables - Optional top-level global variables
  * @param options.prompts - Optional top-level global prompts
- * @param options.templateEnabled - Optional template-level enabled condition
+ * @param options.configEnabled - Optional config-level enabled condition
  * @param options.transformers - Optional transformer definitions
  */
 declare function runWithTasks(customTasks: TaskDefinition[], options?: {
   dryRun?: boolean | undefined;
   force?: boolean | undefined;
-  tasksFilePath?: string | undefined;
+  configFilePath?: string | undefined;
   variables?: VariableDefinition[] | undefined;
   prompts?: PromptDefinition[] | undefined;
-  templateEnabled?: EnabledValue | undefined;
+  configEnabled?: EnabledValue | undefined;
   transformers?: Transformer[] | undefined;
 }): Promise<void>;
 //#endregion
-export { type AppendConfig, BasePrompt, ConditionExpression, ConditionalConfig, ConditionalDefaultConfig, ConfirmPrompt, type CopyConfig, type CreateConfig, DefaultValue, DefaultValueConfig, DefaultValueType, type DeleteConfig, DynamicBooleanValue, EnabledValue, type ExecConfig, ExecFileRuntime, ExecFileValueConfig, ExecutableConfig, type GitInitConfig, InitConfig, InputPrompt, MergeStrategy, type MkdirConfig, type MoveConfig, NumberPrompt, PluginHooks, PromptDefinition, PromptType, type RegexReplaceConfig, type RenameConfig, type ReplaceInFileConfig, RollbackConfig, SelectPrompt, TaskDefinition, TaskPlugin, TaskType, TasksConfiguration, type UpdateJsonConfig, VariableDefinition, type WriteConfig, callHook, clearPlugins, clearTemplateCache, collectPrompts, collectVariables, createTaskPlugin, displayTasksDiff, executePluginTask, executeTask, getCreateDiff, getDeleteDiff, getExecDiff, getGitInitDiff, getPlugin, getPluginForTaskType, getPluginTaskDiff, getRegexReplaceDiff, getRenameDiff, getReplaceInFileDiff, getTaskDiff, getTemplateSourceDescription, getUpdateJsonDiff, getWriteDiff, hasInlineTemplate, hasTemplateFile, isPluginTaskType, listPlugins, loadAndMergeTemplate, loadTasksWithInheritance, loadTemplate, loadTemplatesInOrder, main, mergeTemplates, processTemplate, registerBuiltInPlugins, registerHooks, registerPlugin, resolveAllDefaultValues, resolveAllVariableValues, resolveDefaultValue, resolveVariableValue, runTask, runTasks, runTemplatesSequentially, runWithTasks, shouldUseHandlebars, topologicalSort, unregisterPlugin, validatePluginTask, validatePrompts, validateScaffoldfyJsonFile, validateTemplateConfig, validateVariables };
+export { type AppendConfig, BasePrompt, ConditionExpression, ConditionalConfig, ConditionalDefaultConfig, ConfirmPrompt, type CopyConfig, type CreateConfig, DefaultValue, DefaultValueConfig, DefaultValueType, type DeleteConfig, DynamicBooleanValue, EnabledValue, type ExecConfig, ExecFileRuntime, ExecFileValueConfig, ExecutableConfig, type GitInitConfig, InitConfig, InputPrompt, MergeStrategy, type MkdirConfig, type MoveConfig, NumberPrompt, PluginHooks, PromptDefinition, PromptType, type RegexReplaceConfig, type RenameConfig, type ReplaceInFileConfig, RollbackConfig, SelectPrompt, TaskDefinition, TaskPlugin, TaskType, TasksConfiguration, type UpdateJsonConfig, VariableDefinition, type WriteConfig, clearConfigurationCache, clearPlugins, createTaskPlugin, displayTasksDiff, executePluginTask, getDeleteDiff, getExecDiff, getGitInitDiff, getPlugin, getPluginForTaskType, getRegexReplaceDiff, getRenameDiff, getReplaceInFileDiff, getTaskDiff, getUpdateJsonDiff, isPluginTaskType, listPlugins, loadAndMergeConfiguration, loadConfiguration, loadTasksWithInheritance, mergeConfigurations, registerHooks, registerPlugin, runWithTasks, unregisterPlugin, validateScaffoldfyJsonFile };