Class CargoWorkspaceProject

Project that consists of scripts plus multiple crates in a Cargo workspace.

Hierarchy (view full)

Project
- CargoWorkspaceProject

Index

Constructors

Constructors

constructor

new CargoWorkspaceProject(root, name?): CargoWorkspaceProject
Parameters
- root: string | Path
- Optional name: string
Returns CargoWorkspaceProject
Inherited from Project.constructor
- Defined in create.ts:119

Properties

`Readonly` cargoCrates

cargoCrates: Record<string, {
    dependencies?: Record<string, {
        features?: string[];
        version: string;
    }>;
    name: string;
}> = {}

Type declaration

Optional dependencies?: Record<string, {
features?: string[];
version: string;
}>
name: string

`Readonly` cargoToml

cargoToml: File = ...

The root file of the workspace

`Readonly` contractsDir

contractsDir: Directory = ...

Directory where deployable crates live.

`Readonly` envFile

envFile: File = ...

`Readonly` gitIgnore

gitIgnore: File = ...

`Readonly` librariesDir

librariesDir: Directory = ...

Directory where non-deployable crates live.

`Readonly` main

main: File = ...

`Optional` name

name?: string

`Readonly` packageJson

packageJson: File = ...

`Readonly` readme

readme: File = ...

root

root: Directory

`Readonly` shellNix

shellNix: File = ...

`Readonly` stateDir

stateDir: Directory = ...

`Readonly` wasmDir

wasmDir: Directory = ...

Accessors

path

get path(): string
Returns string
Inherited from Project.path
- Defined in create.ts:107

Methods

cargoUpdate

cargoUpdate(): CargoWorkspaceProject
Returns CargoWorkspaceProject
Inherited from Project.cargoUpdate
- Defined in create.ts:301

createDeployment

createDeployment(): Deployment
Returns Deployment
Inherited from Project.createDeployment
- Defined in create.ts:282

createGitRepo

createGitRepo(): CargoWorkspaceProject
Returns CargoWorkspaceProject
Inherited from Project.createGitRepo
- Defined in create.ts:137

getDeployment

getDeployment(): Promise<Deployment>
Returns Promise<Deployment>
Inherited from Project.getDeployment
- Defined in create.ts:286

logStatus

logStatus(): Promise<Core.Console>
Returns Promise<Core.Console>
Inherited from Project.logStatus
- Defined in create.ts:256

runNPMInstall

runNPMInstall(tools): CargoWorkspaceProject
Parameters
- tools: SystemTools
Returns CargoWorkspaceProject
Inherited from Project.runNPMInstall
- Defined in create.ts:239

writeApplicationTemplate

writeApplicationTemplate(): CargoWorkspaceProject
Returns CargoWorkspaceProject
Inherited from Project.writeApplicationTemplate
- Defined in create.ts:229

writePlatformManifests

writePlatformManifests(): CargoWorkspaceProject
Returns CargoWorkspaceProject
Inherited from Project.writePlatformManifests
- Defined in create.ts:166

Class CargoWorkspaceProject

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

root: string | Path

Optional name: string

Returns CargoWorkspaceProject

Properties

Readonly cargoCrates

Type declaration

Optional dependencies?: Record<string, { features?: string[]; version: string; }>

name: string

Readonly cargoToml

Readonly contractsDir

Readonly envFile

Readonly gitIgnore

Readonly librariesDir

Readonly main

Optional name

Readonly packageJson

Readonly readme

root

Readonly shellNix

Readonly stateDir

Readonly wasmDir

Accessors

path

Returns string

Methods

cargoUpdate

Returns CargoWorkspaceProject

createDeployment

Returns Deployment

createGitRepo

Returns CargoWorkspaceProject

getDeployment

Returns Promise<Deployment>

logStatus

Returns Promise<Core.Console>

runNPMInstall

Parameters

tools: SystemTools

Returns CargoWorkspaceProject

writeApplicationTemplate

Returns CargoWorkspaceProject

writePlatformManifests

Returns CargoWorkspaceProject

Settings

Member Visibility

Theme

On This Page

`Optional` name: string

`Readonly` cargoCrates

`Optional` dependencies?: Record<string, {
features?: string[];
version: string;
}>

`Readonly` cargoToml

`Readonly` contractsDir

`Readonly` envFile

`Readonly` gitIgnore

`Readonly` librariesDir

`Readonly` main

`Optional` name

`Readonly` packageJson

`Readonly` readme

`Readonly` shellNix

`Readonly` stateDir

`Readonly` wasmDir