Design System Utilities @ 0.1.1-alpha.0
    Preparing search index...

    Interface ClassInternal

    Shape for the project config class (i.e., Config.Class).

    Properties are properly defined in Config.

    0.1.0-alpha.1

    interface Class {
        clr: Colour;
        compiler: Partial<Args> | undefined;
        console: Partial<Args> | undefined;
        fs: Partial<FileSystemType.Args>;
        launchYear: string;
        paths: BuildUtilities.Config.Internal.Paths;
        replace: Replace | ((stage: Stage) => Replace);
        stages: BuildUtilities.Config.Internal.Stages;
        title: string;
        export(): Default;
        getDistDir(
            fs: FileSystemType,
            subDir?: DistDirectory,
            ...subpaths: string[],
        ): string;
        getScriptsPath(
            fs: FileSystemType,
            subDir?: "logs",
            ...subpaths: string[],
        ): string;
        getSrcDir(
            fs: FileSystemType,
            subDir: SourceDirectory,
            ...subpaths: string[],
        ): string[];
        getSrcDir(
            fs: FileSystemType,
            subDir?: undefined,
            ...subpaths: string[],
        ): string;
        getSrcDir(
            fs: FileSystemType,
            subDir?: SourceDirectory,
            ...subpaths: string[],
        ): string | string[];
        getStage(
            stage: Name,
            console: Logger,
        ): Promise<[Class, Partial<Args>] | undefined>;
        minimum(): BuildUtilities.Config;
        toJSON(): BuildUtilities.Config.Internal;
        toString(): string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    clr compiler console fs launchYear paths replace stages title

    Methods

    export getDistDir getScriptsPath getSrcDir getStage minimum toJSON toString

    Properties

    clr: Colour

    Default output colour to the terminal.

    compiler: Partial<Args> | undefined
    console: Partial<Args> | undefined
    fs: Partial<FileSystemType.Args>

    Optional arguments to use when constructing FileSystem.

    launchYear: string
    paths: BuildUtilities.Config.Internal.Paths
    replace: Replace | ((stage: Stage) => Replace)

    Placeholders to be replaced during the build processes.

    stages: BuildUtilities.Config.Internal.Stages
    title: string

    Methods

    • Internal

      Used to export the default config to write a config file when one did not exist.

      Returns Default

      0.1.0-alpha.1

    • Internal

      Gets a path to the Config.Paths.dist directories.

      Parameters

      • fs: FileSystemType

        Instance used to work with paths and files.

      • OptionalsubDir: DistDirectory

        Sub-path to get.

      • ...subpaths: string[]

        Optional additional subpaths.

      Returns string

      Relative path.

      0.1.0-alpha — Previously defined in ProjectConfig class.

    • Internal

      Gets a path to the Config.Paths.scripts directories.

      Parameters

      • fs: FileSystemType

        Instance used to work with paths and files.

      • OptionalsubDir: "logs"

        Sub-path to get.

      • ...subpaths: string[]

        Optional additional subpaths.

      Returns string

      Relative path.

      0.1.0-alpha — Previously defined in ProjectConfig class.

    • Internal

      Gets a path to the Config.Paths.src directories.

      Overloaded for more accurate typing:

      • If a subdirectory is defined, the results will be an array.
      • If no subdirectory is defined, then the return will always be a string.

      Parameters

      • fs: FileSystemType

        Instance used to work with paths and files.

      • subDir: SourceDirectory

        Sub-path to get.

      • ...subpaths: string[]

        Optional additional subpaths.

      Returns string[]

      Relative path.

      0.1.0-alpha — Previously defined in ProjectConfig class.

    • Internal

      Parameters

      • fs: FileSystemType
      • OptionalsubDir: undefined
      • ...subpaths: string[]

      Returns string

    • Internal

      Parameters

      Returns string | string[]

    • Internal

      Gets the instance for the given stage.

      Parameters

      • stage: Name

        Stage to get.

      • console: Logger

      Returns Promise<[Class, Partial<Args>] | undefined>

      An array with first the stage’s class and then the configured arguments for that class, or undefined if that class is disabled by the config.

      0.1.0-alpha — Previously defined in ProjectConfig class.

    • Internal

      Returns the minimum required properties of this config.

      Useful for creating stripped-down or default configuration objects.

      Returns BuildUtilities.Config

      The minimum required properties for this config.

      0.1.0-alpha — Previously defined in ProjectConfig class.

    • Internal

      Overrides the default function to return a string representation of this object.

      Returns string

      Object.prototype.toString()

      0.1.0-alpha — Previously defined in ProjectConfig class.

    Settings

    Member Visibility

    On This Page

    Properties
    Methods