Class ProjectConfig

constructor

• new ProjectConfig(config: Config.Internal): ProjectConfig

  To convert a Config type to a Config.Internal type, use the internal.internalConfig function.

  Parameters

  • config: Config.Internal

  Returns ProjectConfig

Readonlyclr

Readonlycompiler

Readonlyconsole

Readonlyfs

ReadonlylaunchYear

Readonlypaths

Readonlyreplace

Readonlystages

Readonlytitle

export

• export(): Default

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

  Returns Default

  Since

  0.1.0-alpha.1

getDistDir

• getDistDir(
      fs: FileSystem,
      subDir?: DistDirectory,
      ...subpaths: string[],
  ): string

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

  Parameters

  • fs: FileSystem

    Instance used to work with paths and files.
  • OptionalsubDir: DistDirectory

    Sub-path to get.
  • ...subpaths: string[]

    Optional additional subpaths.

  Returns string

  Relative path.

  Since

  0.1.0-alpha — Previously defined in ProjectConfig class.

getScriptsPath

• getScriptsPath(fs: FileSystem, subDir?: "logs", ...subpaths: string[]): string

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

  Parameters

  • fs: FileSystem

    Instance used to work with paths and files.
  • OptionalsubDir: "logs"

    Sub-path to get.
  • ...subpaths: string[]

    Optional additional subpaths.

  Returns string

  Relative path.

  Since

  0.1.0-alpha — Previously defined in ProjectConfig class.

getSrcDir

• getSrcDir(
      fs: FileSystem,
      subDir: SourceDirectory,
      ...subpaths: string[],
  ): string[]

  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: FileSystem

    Instance used to work with paths and files.
  • subDir: SourceDirectory

    Sub-path to get.
  • ...subpaths: string[]

    Optional additional subpaths.

  Returns string[]

  Relative path.

  Since

  0.1.0-alpha — Previously defined in ProjectConfig class.

• getSrcDir(fs: FileSystem, subDir?: undefined, ...subpaths: string[]): string
  Internal

  Parameters

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

  Returns string
• getSrcDir(
      fs: FileSystem,
      subDir?: SourceDirectory,
      ...subpaths: string[],
  ): string | string[]
  Internal

  Parameters

  • fs: FileSystem
  • OptionalsubDir: SourceDirectory
  • ...subpaths: string[]

  Returns string | string[]

getStage

• getStage(
      stage: Name,
      console: Logger,
  ): Promise<undefined | [Stage.Class, Partial<Stage.Args>]>

  Gets the instance for the given stage.

  Parameters

  • stage: Name

    Stage to get.

    • "snapshot"
    • "compile"
    • "test"
    • "document"
    • "build"
    • "package"
    • "release"
  • console: Logger

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

  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.

  Since

  0.1.0-alpha — Previously defined in ProjectConfig class.

minimum

• minimum(): Config

  Returns the minimum required properties of this config.

  Useful for creating stripped-down or default configuration objects.

  Returns Config

  The minimum required properties for this config.

  Since

  0.1.0-alpha — Previously defined in ProjectConfig class.

toJSON

• toJSON(): Config.Internal

  The object shape used when converting to JSON.

  Returns Config.Internal

  See

  JSON.stringify

  Since

  0.1.0-alpha — Previously defined in ProjectConfig class.

toString

• toString(): string

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

  Returns string

  See

  Object.prototype.toString()

  Since

  0.1.0-alpha — Previously defined in ProjectConfig class.