Class BuildRaw

This build mode looks for a Rust toolchain in the same environment as the one in which the script is running, i.e. no build container.

Hierarchy

BuildLocal
- BuildRaw

Index

Constructors

constructor

new BuildRaw(options): BuildRaw
Parameters
- options: Partial<{
      builder: string;
      caching: boolean;
      dockerImage: "ghcr.io/hackbg/fadroma:master";
      dockerSocket: "/var/run/docker.sock";
      dockerfile: string;
      noFetch: false;
      outputDir: string;
      outputGid: undefined | string;
      outputUid: undefined | string;
      podman: false;
      preferredRemote: undefined | string;
      quiet: false;
      raw: false;
      script: string;
      sshAuthSocket: undefined | string;
      toolchain: "";
      verbose: false;
      workspace: string;
  }>
Returns BuildRaw
Inherited from BuildLocal.constructor
- Defined in fadroma-build.ts:68

Properties

`Optional` buildGid

buildGid?: number = ...

Owner gid that is set on build artifacts.

`Optional` buildUid

buildUid?: number = ...

Owner uid that is set on build artifacts.

caching

caching: boolean = true

Whether to enable build caching. When set to false, this builder will rebuild even when binary and checksum are both present in wasm/ directory

`Readonly` id

id: "Raw" = 'Raw'

Unique identifier of this builder implementation.

log

log: BuildConsole = ...

Logging handle.

noFetch

noFetch: boolean = false

Whether to skip any git fetch calls in the build script.

outputDir

outputDir: OpaqueDirectory

Name of directory where build artifacts are collected.

quiet

quiet: boolean = false

Whether the build log should be printed only on error, or always

revision

revision: string = HEAD

Default Git reference from which to build sources.

runtime

runtime: string = ...

Node.js runtime that runs the build subprocess. Defaults to the same one that is running this script.

`Optional` script

script?: string

The build script.

toolchain

toolchain: null | string = null

Version of Rust toolchain to use.

verbose

verbose: boolean = false

Whether the build process should print more detail to the console.

`Optional` workspace

workspace?: string

The project workspace.

`Static` variants

variants: Record<string, BuilderClass<Builder>> = {}

Global registry of builder variants. Populated downstream.

Methods

build

build(buildable): Promise<Built>
Build a Source into a Template
Parameters
- buildable: Buildable
Returns Promise<Built>
Overrides BuildLocal.build
- Defined in fadroma-build.ts:470

buildMany

buildMany(inputs): Promise<Built[]>
Build multiple Sources.
Parameters
- inputs: Buildable[]
Returns Promise<Built[]>
Overrides BuildLocal.buildMany
- Defined in fadroma-build.ts:464

`Protected` getEnvAndTemp

getEnvAndTemp(buildable, workspace?, revision?): {
    env: {
        _BUILD_GID: string;
        _BUILD_UID: string;
        _OUTPUT: string;
        _REGISTRY: string;
        _TOOLCHAIN: null | string;
    };
    tmpBuild: null | Path;
    tmpGit: null | Path;
}
Parameters
- buildable: Buildable
- Optional workspace: string
- Optional revision: string
Returns {
    env: {
        _BUILD_GID: string;
        _BUILD_UID: string;
        _OUTPUT: string;
        _REGISTRY: string;
        _TOOLCHAIN: null | string;
    };
    tmpBuild: null | Path;
    tmpGit: null | Path;
}
- env: {
      _BUILD_GID: string;
      _BUILD_UID: string;
      _OUTPUT: string;
      _REGISTRY: string;
      _TOOLCHAIN: null | string;
  }
  - _BUILD_GID: string
  - _BUILD_UID: string
  - _OUTPUT: string
  - _REGISTRY: string
  - _TOOLCHAIN: null | string
- tmpBuild: null | Path
- tmpGit: null | Path
- Defined in fadroma-build.ts:487

`Protected` getGitDir

getGitDir(...args): DotGit
Overridable.
Parameters
- Rest ...args: [template: Partial<Template<any>>]
Returns DotGit
- Defined in fadroma-build.ts:524

`Protected` hashPath

hashPath(location): string
Parameters
- location: string | Path
Returns string
the SHA256 hash of the file at the specified location
Inherited from BuildLocal.hashPath
- Defined in fadroma-build.ts:103

`Protected` populatePrebuilt

populatePrebuilt(buildable): boolean
Parameters
- buildable: Buildable & Partial<Built>
Returns boolean
Inherited from BuildLocal.populatePrebuilt
- Defined in fadroma-build.ts:91

`Protected` prebuild

prebuild(outputDir, crate?, revision?): null | Built
Check if artifact exists in local artifacts cache directory. If it does, don't rebuild it but return it from there.
Parameters
- outputDir: string
- Optional crate: string
- revision: string = HEAD
Returns null | Built
Inherited from BuildLocal.prebuild
- Defined in fadroma-build.ts:80

`Protected` resolveSource

resolveSource(buildable): Buildable
Parameters
- buildable: string | Buildable
Returns Buildable
a fully populated Buildable from the original
Inherited from BuildLocal.resolveSource
- Defined in fadroma-build.ts:107

`Protected` runBuild

runBuild(buildable, env): Promise<Path>
Parameters
- buildable: Buildable
- env: {
  _OUTPUT: string;
  }
  - _OUTPUT: string
Returns Promise<Path>
- Defined in fadroma-build.ts:527

`Protected` spawn

spawn(...args): ChildProcess
Overridable.
Parameters
- Rest ...args: [command: string, args: readonly string[], options: SpawnOptions]
Returns ChildProcess
- Defined in fadroma-build.ts:520

Class BuildRaw

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns BuildRaw

Properties

Optional buildGid

Optional buildUid

caching

Readonly id

log

noFetch

outputDir

quiet

revision

runtime

Optional script

toolchain

verbose

Optional workspace

Static variants

Methods

build

Parameters

buildable: Buildable

Returns Promise<Built>

buildMany

Parameters

inputs: Buildable[]

Returns Promise<Built[]>

Protected getEnvAndTemp

Parameters

buildable: Buildable

Optional workspace: string

Optional revision: string

Returns { env: { _BUILD_GID: string; _BUILD_UID: string; _OUTPUT: string; _REGISTRY: string; _TOOLCHAIN: null | string; }; tmpBuild: null | Path; tmpGit: null | Path; }

env: { _BUILD_GID: string; _BUILD_UID: string; _OUTPUT: string; _REGISTRY: string; _TOOLCHAIN: null | string; }

_BUILD_GID: string

_BUILD_UID: string

_OUTPUT: string

_REGISTRY: string

_TOOLCHAIN: null | string

tmpBuild: null | Path

tmpGit: null | Path

Protected getGitDir

Parameters

Rest ...args: [template: Partial<Template<any>>]

Returns DotGit

Protected hashPath

Parameters

location: string | Path

Returns string

Protected populatePrebuilt

Parameters

buildable: Buildable & Partial<Built>

Returns boolean

Protected prebuild

Parameters

outputDir: string

Optional crate: string

revision: string = HEAD

Returns null | Built

Protected resolveSource

Parameters

buildable: string | Buildable

Returns Buildable

Protected runBuild

Parameters

buildable: Buildable

env: { _OUTPUT: string; }

_OUTPUT: string

Returns Promise<Path>

Protected spawn

Parameters

Rest ...args: [command: string, args: readonly string[], options: SpawnOptions]

`Optional` buildGid

`Optional` buildUid

`Readonly` id

`Optional` script

`Optional` workspace

`Static` variants

`Protected` getEnvAndTemp

`Optional` workspace: string

`Optional` revision: string

Returns {
env: {
_BUILD_GID: string;
_BUILD_UID: string;
_OUTPUT: string;
_REGISTRY: string;
_TOOLCHAIN: null | string;
};
tmpBuild: null | Path;
tmpGit: null | Path;
}

env: {
_BUILD_GID: string;
_BUILD_UID: string;
_OUTPUT: string;
_REGISTRY: string;
_TOOLCHAIN: null | string;
}

`Protected` getGitDir

`Rest` ...args: [template: Partial<Template<any>>]

`Protected` hashPath

`Protected` populatePrebuilt

`Protected` prebuild

`Optional` crate: string

`Protected` resolveSource

`Protected` runBuild

env: {
_OUTPUT: string;
}

`Protected` spawn

`Rest` ...args: [command: string, args: readonly string[], options: SpawnOptions]