Class CreatePackageConfig

Hierarchy

CreatePackageConfig

Index

Constructors

Properties

_buildDir _distFile _files _gitBranch _gitCommitMessage _gitOrganization _gitSubmodules _mainName _mainSrcFileName _mainSrcFileTemplate _organizationEmail _organizationName _packageJsonModifier _packages _pkgDir _preferredPackageSystem _renameFiles _sourceDir _templatesDir

Constructors

constructor

new CreatePackageConfig(): CreatePackageConfig
Returns CreatePackageConfig
- Defined in fi/hg/create/types/CreatePackageConfig.ts:44

Properties

`Private` _buildDir

_buildDir: string

`Private` _distFile

_distFile: string

`Private` _files

_files: readonly string[]

`Private` _gitBranch

_gitBranch: string

`Private` _gitCommitMessage

_gitCommitMessage: string

`Private` _gitOrganization

_gitOrganization: string

`Private` _gitSubmodules

_gitSubmodules: readonly GitSubmoduleConfig[]

`Private` _mainName

_mainName: string

`Private` _mainSrcFileName

_mainSrcFileName: string

`Private` _mainSrcFileTemplate

_mainSrcFileTemplate: string

`Private` _organizationEmail

_organizationEmail: string

`Private` _organizationName

_organizationName: string

`Private` _packageJsonModifier

_packageJsonModifier: PackageJsonModifyCallback

`Private` _packages

_packages: readonly string[]

`Private` _pkgDir

_pkgDir: string

`Private` _preferredPackageSystem

_preferredPackageSystem: PackageManagerType

`Private` _renameFiles

_renameFiles: {
[key: string]: string;
}

Type declaration

[key: string]: string

`Private` _sourceDir

_sourceDir: string

`Private` _templatesDir

_templatesDir: string

Methods

`Private` _getDefaultMainName

_getDefaultMainName(): string
Returns string
- Defined in fi/hg/create/types/CreatePackageConfig.ts:214

getBuildDir

getBuildDir(): string
Build directory relative to the package directory

Returns string
- Defined in fi/hg/create/types/CreatePackageConfig.ts:150

getDistFile

getDistFile(): string
Returns string
- Defined in fi/hg/create/types/CreatePackageConfig.ts:230

getFiles

getFiles(): readonly string[]
Returns readonly string[]
- Defined in fi/hg/create/types/CreatePackageConfig.ts:260

getGitBranch

getGitBranch(): string
Returns string
- Defined in fi/hg/create/types/CreatePackageConfig.ts:204

getGitCommitMessage

getGitCommitMessage(): string
Returns string
- Defined in fi/hg/create/types/CreatePackageConfig.ts:194

getGitOrganization

getGitOrganization(): string
Returns string
- Defined in fi/hg/create/types/CreatePackageConfig.ts:98

getGitSubmodules

getGitSubmodules(): readonly GitSubmoduleConfig[]
Returns readonly GitSubmoduleConfig[]
- Defined in fi/hg/create/types/CreatePackageConfig.ts:290

getMainName

getMainName(): string
Returns string
- Defined in fi/hg/create/types/CreatePackageConfig.ts:220

getMainSourceFileName

getMainSourceFileName(): string
Returns string
- Defined in fi/hg/create/types/CreatePackageConfig.ts:240

getMainSourceFileTemplate

getMainSourceFileTemplate(): string
Returns string
- Defined in fi/hg/create/types/CreatePackageConfig.ts:250

getOrganizationEmail

getOrganizationEmail(): string
Returns string
- Defined in fi/hg/create/types/CreatePackageConfig.ts:118

getOrganizationName

getOrganizationName(): string
Returns string
- Defined in fi/hg/create/types/CreatePackageConfig.ts:108

getPackageDirectory

getPackageDirectory(): string
The package directory

Returns string
- Defined in fi/hg/create/types/CreatePackageConfig.ts:134

getPackageJsonModifier

getPackageJsonModifier(): PackageJsonModifyCallback
Returns PackageJsonModifyCallback
- Defined in fi/hg/create/types/CreatePackageConfig.ts:300

getPackages

getPackages(): readonly string[]
Returns readonly string[]
- Defined in fi/hg/create/types/CreatePackageConfig.ts:280

getPreferredPackageSystem

getPreferredPackageSystem(): PackageManagerType
Returns PackageManagerType
- Defined in fi/hg/create/types/CreatePackageConfig.ts:88

getRenameFiles

getRenameFiles(): {
[key: string]: string;
}
Returns {
[key: string]: string;
}
- [key: string]: string
- Defined in fi/hg/create/types/CreatePackageConfig.ts:270

getSourceDir

getSourceDir(): string
Source directory relative to the package directory

Returns string
- Defined in fi/hg/create/types/CreatePackageConfig.ts:167

getTemplatesDirectory

getTemplatesDirectory(): string
Source directory relative to the package directory

Returns string
- Defined in fi/hg/create/types/CreatePackageConfig.ts:184

setBuildDir

setBuildDir(value: string): CreatePackageConfig
Set build directory relative to the package directory
Parameters
- value: string
Returns CreatePackageConfig
- Defined in fi/hg/create/types/CreatePackageConfig.ts:142

setDistFile

setDistFile(value: string): CreatePackageConfig
Parameters
- value: string
Returns CreatePackageConfig
- Defined in fi/hg/create/types/CreatePackageConfig.ts:225

setFiles

setFiles(value: string[] | readonly string[]): CreatePackageConfig
Parameters
- value: string[] | readonly string[]
Returns CreatePackageConfig
- Defined in fi/hg/create/types/CreatePackageConfig.ts:255

setGitBranch

setGitBranch(value: string): CreatePackageConfig
Parameters
- value: string
Returns CreatePackageConfig
- Defined in fi/hg/create/types/CreatePackageConfig.ts:199

setGitCommitMessage

setGitCommitMessage(value: string): CreatePackageConfig
Parameters
- value: string
Returns CreatePackageConfig
- Defined in fi/hg/create/types/CreatePackageConfig.ts:189

setGitOrganization

setGitOrganization(value: string): CreatePackageConfig
Parameters
- value: string
Returns CreatePackageConfig
- Defined in fi/hg/create/types/CreatePackageConfig.ts:93

setGitSubmodules

setGitSubmodules(value: readonly GitSubmoduleConfig[] | GitSubmoduleConfig[]): CreatePackageConfig
Parameters
- value: readonly GitSubmoduleConfig[] | GitSubmoduleConfig[]
Returns CreatePackageConfig
- Defined in fi/hg/create/types/CreatePackageConfig.ts:285

setMainName

setMainName(value: string): CreatePackageConfig
Parameters
- value: string
Returns CreatePackageConfig
- Defined in fi/hg/create/types/CreatePackageConfig.ts:209

setMainSourceFileName

setMainSourceFileName(value: string): CreatePackageConfig
Parameters
- value: string
Returns CreatePackageConfig
- Defined in fi/hg/create/types/CreatePackageConfig.ts:235

setMainSourceFileTemplate

setMainSourceFileTemplate(value: string): CreatePackageConfig
Parameters
- value: string
Returns CreatePackageConfig
- Defined in fi/hg/create/types/CreatePackageConfig.ts:245

setOrganizationEmail

setOrganizationEmail(value: string): CreatePackageConfig
Parameters
- value: string
Returns CreatePackageConfig
- Defined in fi/hg/create/types/CreatePackageConfig.ts:113

setOrganizationName

setOrganizationName(value: string): CreatePackageConfig
Parameters
- value: string
Returns CreatePackageConfig
- Defined in fi/hg/create/types/CreatePackageConfig.ts:103

setPackageDirectory

setPackageDirectory(value: string): CreatePackageConfig
Set the package directory
Parameters
- value: string
Returns CreatePackageConfig
- Defined in fi/hg/create/types/CreatePackageConfig.ts:126

setPackageJsonModifier

setPackageJsonModifier(value: PackageJsonModifyCallback): CreatePackageConfig
Parameters
- value: PackageJsonModifyCallback
Returns CreatePackageConfig
- Defined in fi/hg/create/types/CreatePackageConfig.ts:295

setPackages

setPackages(value: string[] | readonly string[]): CreatePackageConfig
Parameters
- value: string[] | readonly string[]
Returns CreatePackageConfig
- Defined in fi/hg/create/types/CreatePackageConfig.ts:275

setPreferredPackageSystem

setPreferredPackageSystem(value: PackageManagerType): CreatePackageConfig
Parameters
- value: PackageManagerType
Returns CreatePackageConfig
- Defined in fi/hg/create/types/CreatePackageConfig.ts:83

setRenameFiles

setRenameFiles(value: {
[key: string]: string;
}): CreatePackageConfig
Parameters
- value: {
  [key: string]: string;
  }
  - [key: string]: string
Returns CreatePackageConfig
- Defined in fi/hg/create/types/CreatePackageConfig.ts:265

setSourceDir

setSourceDir(value: string): CreatePackageConfig
Set source directory relative to the package directory
Parameters
- value: string
Returns CreatePackageConfig
- Defined in fi/hg/create/types/CreatePackageConfig.ts:159

setTemplatesDirectory

setTemplatesDirectory(value: string): CreatePackageConfig
Set templates directory relative to the package directory
Parameters
- value: string
Returns CreatePackageConfig
- Defined in fi/hg/create/types/CreatePackageConfig.ts:176

toJSON

toJSON(): ReadonlyJsonObject
Returns ReadonlyJsonObject
- Defined in fi/hg/create/types/CreatePackageConfig.ts:77

toString

toString(): string
Returns string
- Defined in fi/hg/create/types/CreatePackageConfig.ts:73

`Static` createFromDataObject

createFromDataObject(configData: CreatePackageConfigDataObject): CreatePackageConfig
Parameters
- configData: CreatePackageConfigDataObject
Returns CreatePackageConfig
- Defined in fi/hg/create/types/CreatePackageConfig.ts:55

`Static` createFromTemplateFile

createFromTemplateFile(templateConfigFile: string): CreatePackageConfig
Parameters
- templateConfigFile: string
Returns CreatePackageConfig
- Defined in fi/hg/create/types/CreatePackageConfig.ts:47

Class CreatePackageConfig

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns CreatePackageConfig

Properties

Private _buildDir

Private _distFile

Private _files

Private _gitBranch

Private _gitCommitMessage

Private _gitOrganization

Private _gitSubmodules

Private _mainName

Private _mainSrcFileName

Private _mainSrcFileTemplate

Private _organizationEmail

Private _organizationName

Private _packageJsonModifier

Private _packages

Private _pkgDir

Private _preferredPackageSystem

Private _renameFiles

Type declaration

[key: string]: string

Private _sourceDir

Private _templatesDir

Methods

Private _getDefaultMainName

Returns string

getBuildDir

Returns string

getDistFile

Returns string

getFiles

Returns readonly string[]

getGitBranch

Returns string

getGitCommitMessage

Returns string

getGitOrganization

Returns string

getGitSubmodules

Returns readonly GitSubmoduleConfig[]

getMainName

Returns string

getMainSourceFileName

Returns string

getMainSourceFileTemplate

Returns string

getOrganizationEmail

Returns string

getOrganizationName

Returns string

getPackageDirectory

Returns string

getPackageJsonModifier

Returns PackageJsonModifyCallback

getPackages

Returns readonly string[]

getPreferredPackageSystem

Returns PackageManagerType

getRenameFiles

Returns { [key: string]: string; }

[key: string]: string

getSourceDir

Returns string

getTemplatesDirectory

Returns string

setBuildDir

Parameters

value: string

Returns CreatePackageConfig

setDistFile

Parameters

value: string

`Private` _buildDir

`Private` _distFile

`Private` _files

`Private` _gitBranch

`Private` _gitCommitMessage

`Private` _gitOrganization

`Private` _gitSubmodules

`Private` _mainName

`Private` _mainSrcFileName

`Private` _mainSrcFileTemplate

`Private` _organizationEmail

`Private` _organizationName

`Private` _packageJsonModifier

`Private` _packages

`Private` _pkgDir

`Private` _preferredPackageSystem

`Private` _renameFiles

`Private` _sourceDir

`Private` _templatesDir

`Private` _getDefaultMainName

Returns {
[key: string]: string;
}

value: {
[key: string]: string;
}