Class ProjectConfig

A super-simple class just for the configuration of the project.

Since

0.1.0-alpha

Since

0.1.0-alpha.1 — Now implements Config.Class instead of Config.Internal.

Implements

Config.Class

Index

Constructors

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
- Defined in lib/04-project/classes/ProjectConfig.ts:121

Properties

`Readonly`clr

clr: Colour

Default output colour to the terminal.

`Readonly`compiler

compiler: undefined | Partial<Stage.Compiler.Args>

Optional arguments to use when constructing Stage.Compiler.

`Readonly`console

console: undefined | Partial<Logger.Args>

Optional arguments to use when constructing Logger.

`Readonly`fs

fs: Partial<FileSystemType.Args>

Optional arguments to use when constructing FileSystem.

`Readonly`launchYear

launchYear: string

A four-digit year string representing the launch date of the project.

`Readonly`paths

paths: Config.Internal.Paths

Paths to files or directories.

Absolute or relative to node’s cwd.

`Readonly`replace

replace: Replace | ((stage: Stage) => Replace)

Placeholders to be replaced during the build processes.

`Readonly`stages

stages: Config.Internal.Stages

All build stages and whether or not they run, including custom implementations.

If true, the default class is run. If false, it is not run at all.

`Readonly`title

title: string

Project’s human-friendly name in title case.

Accessors

`Protected` `Static`default

get default(): Config.Internal
A “local” “cache” of default config values, used primarily for ProjectConfig.export.

Returns Config.Internal
Since
0.1.0-alpha.1
- Defined in lib/04-project/classes/ProjectConfig.ts:71

Methods

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
Implementation of Class.export
- Defined in lib/04-project/classes/ProjectConfig.ts:273

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.
Implementation of Class.getDistDir
- Defined in lib/04-project/classes/ProjectConfig.ts:371

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.
Implementation of Class.getScriptsPath
- Defined in lib/04-project/classes/ProjectConfig.ts:385

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.
Implementation of Class.getSrcDir
- Defined in lib/04-project/classes/ProjectConfig.ts:399
getSrcDir(fs: FileSystem, subDir?: undefined, ...subpaths: string[]): string
Internal
Parameters
- fs: FileSystem
- OptionalsubDir: undefined
- ...subpaths: string[]
Returns string
Implementation of Class.getSrcDir
- Defined in lib/04-project/classes/ProjectConfig.ts:405
getSrcDir(
    fs: FileSystem,
    subDir?: SourceDirectory,
    ...subpaths: string[],
): string | string[]
Internal
Parameters
- fs: FileSystem
- OptionalsubDir: SourceDirectory
- ...subpaths: string[]
Returns string | string[]
Implementation of Class.getSrcDir
- Defined in lib/04-project/classes/ProjectConfig.ts:411

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.
Implementation of Class.getStage
- Defined in lib/04-project/classes/ProjectConfig.ts:442

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.
Implementation of Class.minimum
- Defined in lib/04-project/classes/ProjectConfig.ts:485

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.
Implementation of Class.toJSON
- Defined in lib/04-project/classes/ProjectConfig.ts:497

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.
Implementation of Class.toString
- Defined in lib/04-project/classes/ProjectConfig.ts:512

Class ProjectConfig

Since

Since

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ProjectConfig

Properties

Readonlyclr

Readonlycompiler

Readonlyconsole

Readonlyfs

ReadonlylaunchYear

Readonlypaths

Readonlyreplace

Readonlystages

Readonlytitle

Accessors

Protected Staticdefault

Returns Config.Internal

Since

Methods

export

Returns Default

Since

getDistDir

Parameters

Returns string

Since

getScriptsPath

Parameters

Returns string

Since

getSrcDir

Parameters

Returns string[]

Since

Parameters

Returns string

Parameters

Returns string | string[]

getStage

Parameters

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

Since

minimum

Returns Config

Since

toJSON

Returns Config.Internal

See

Since

toString

Returns string

See

Since

Settings

On This Page

`Readonly`clr

`Readonly`compiler

`Readonly`console

`Readonly`fs

`Readonly`launchYear

`Readonly`paths

`Readonly`replace

`Readonly`stages

`Readonly`title

`Protected` `Static`default