kist/dist/ts/interface/ConfigInterface.ts

Lightweight Package Pipeline Processor with Plugin Architecture

// ============================================================================
// Import
// ============================================================================

import { MetadataInterface } from "./MetadataInterface.js";
import { OptionsInterface } from "./OptionsInterface.js";
import { StageInterface } from "./StageInterface.js";

// ============================================================================
// Interfaces
// ============================================================================

/**
 * ConfigInterface defines the overall configuration for the packaging
 * pipeline. This configuration determines the structure, behavior, and
 * execution flow of the entire pipeline, including stages, global settings,
 * and optional metadata.
 */
export interface ConfigInterface {
    /**
     * Optional path(s) to parent configuration file(s) to inherit from.
     * Child configuration values override parent values. Stages are merged
     * by name (child stage with same name replaces parent stage), or appended
     * if no matching name exists.
     *
     * @example
     * ```yaml
     * extends: "./kist.base.yml"
     * ```
     *
     * @example
     * ```yaml
     * extends:
     *   - "./kist.base.yml"
     *   - "./kist.dev-defaults.yml"
     * ```
     */
    extends?: string | string[];

    /**
     * Optional metadata that provides additional context or descriptive
     * information about the pipeline configuration. This can include the
     * pipeline name, version, author, or any other relevant details. Useful
     * for documentation, tracking, and integration with external systems.
     */
    metadata?: MetadataInterface;

    /**
     * Optional global options that apply universally across the entire
     * pipeline. These options can control aspects like logging levels, step
     * timeouts, error handling, concurrency limits, and other settings that
     * affect the overall pipeline behavior.
     */
    options?: OptionsInterface;

    /**
     * A list of stages to be executed in the pipeline. Stages run in parallel
     * by default, but dependencies specified in each stage can enforce a
     * specific execution order. Stages should be defined in the logical
     * sequence that aligns with the pipeline's objectives.
     */
    stages: StageInterface[];

    /**
     * An optional function or set of rules for validating the configuration
     * before execution. This can be used to ensure that the pipeline meets
     * certain criteria or standards before running, catching potential
     * configuration errors early.
     *
     * @param config - The full configuration object to validate.
     * @returns A boolean indicating whether the configuration is valid, or
     *      throws an error if validation fails.
     */
    validateConfig?(config: ConfigInterface): boolean;
}