Interface ProjectInit

Project initialization options.

interface ProjectInit {
    cacheDir?: string;
    distDir?: string;
    gitignore?: boolean | GitIgnoreFile;
    npmignore?: boolean | GitIgnoreFile;
    rootDir?: string;
    sourceDir?: string;
    targetDir?: string;
    tools?: ProjectToolsInit;
}

Hierarchy (view full)

Implemented by

Properties

cacheDir? distDir? gitignore? npmignore? rootDir? sourceDir? targetDir? tools?

Properties

Optional ReadonlycacheDir

cacheDir?: string

Cache directory relative to build target directory.

Default Value

Temporary directory.

Optional ReadonlydistDir

distDir?: string

Distributable files` directory relative to {@link ProjectConfig#rootDir project root}.

@defaultValue dist

Optional Readonlygitignore

gitignore?: boolean | GitIgnoreFile

How to manage .gitignore file.

Either a flag, or custom GitIgnoreFile instance.

Default Value

true.

Optional Readonlynpmignore

npmignore?: boolean | GitIgnoreFile

How to manage .npmignore file.

Either a flag, or custom GitIgnoreFile instance.

Default Value

true.

Optional ReadonlyrootDir

rootDir?: string

Root project directory.

Default Value

current working directory.

Optional ReadonlysourceDir

sourceDir?: string

Root source files directory relative to project root.

Default Value

src.

Optional ReadonlytargetDir

targetDir?: string

Directory containing build targets relative to project root.

Unlike distDir, this one is not supposed to be published at NPM.

Default Value

target.

Optional Readonlytools

tools?: ProjectToolsInit

Development tools initializers for the project.

Settings

Member Visibility

On This Page

Properties