NPM Build Utilities @ 0.1.3
    Preparing search index...

    Interface DefaultInternal

    This is the shape of the internal config when it's exported to create a default config file.

    Used by Config.Class.export

    0.1.0-alpha.1

    interface Default {
        launchYear: string;
        title: string;
        clr?: Colour;
        compiler?: Partial<Stage.Compiler.Args>;
        console?: Partial<Logger.Args>;
        fs?: Partial<FileSystemType.Args>;
        paths?: {
            changelog?: string;
            dist?: { _: string; docs: string; scss: string };
            notes?: { release: string };
            readme?: string;
            release?: string;
            scripts?: { _: string; logs: string };
            snapshot?: string;
            src?: {
                _: string;
                docs: string | string[];
                scss: string | string[];
                ts: string | string[];
            };
        };
        stages?: {
            build?: boolean
            | Partial<Stage.Args.Build>;
            compile?: boolean | Partial<Stage.Args.Compile>;
            document?: boolean | Partial<Stage.Args.Document>;
            package?: boolean | Partial<Stage.Args.Package>;
            release?: boolean | Partial<Stage.Args.Release>;
            snapshot?: boolean | Partial<Stage.Args.Snapshot>;
            test?: boolean | Partial<Stage.Args.Test>;
        };
    }
    Index

    Properties

    launchYear: string
    title: string
    clr?: Colour
    console?: Partial<Logger.Args>
    paths?: {
        changelog?: string;
        dist?: { _: string; docs: string; scss: string };
        notes?: { release: string };
        readme?: string;
        release?: string;
        scripts?: { _: string; logs: string };
        snapshot?: string;
        src?: {
            _: string;
            docs: string | string[];
            scss: string | string[];
            ts: string | string[];
        };
    }

    Type declaration

    • Optionalchangelog?: string

      Relative path to changelog file.

    • Optionaldist?: { _: string; docs: string; scss: string }

      Destination directories for compiled files.

    • Optionalnotes?: { release: string }

      Relative path to notes files used during development.

      • release: string

        Release notes file.

        Used for updating the changelog and the github release notes.

    • Optionalreadme?: string

      Relative path to readme file.

    • Optionalrelease?: string

      Directory for release zip files.

    • Optionalscripts?: { _: string; logs: string }

      Location of build scripts and related files.

    • Optionalsnapshot?: string

      Directory for snapshot zip files.

    • Optionalsrc?: {
          _: string;
          docs: string | string[];
          scss: string | string[];
          ts: string | string[];
      }

      Source for files to be compiled.

      • _ expects a directory
      • docs expects a directory (or array of such)
      • scss expects a directory, file path, or globs (or array of such)
      • ts expects a directory or file path (or array of such)
    stages?: {
        build?: boolean | Partial<Stage.Args.Build>;
        compile?: boolean | Partial<Stage.Args.Compile>;
        document?: boolean | Partial<Stage.Args.Document>;
        package?: boolean | Partial<Stage.Args.Package>;
        release?: boolean | Partial<Stage.Args.Release>;
        snapshot?: boolean | Partial<Stage.Args.Snapshot>;
        test?: boolean | Partial<Stage.Args.Test>;
    }