Class Generator

Generates a Dockerfile for a SoftwareEnvironment instance

Hierarchy

Doer
- Generator
  - PackageGenerator
  - DockerGenerator

Index

Constructors

constructor

Properties

Constructors

constructor

new Generator(urlFetcher: UrlFetcher, folder: string | undefined, baseImage?: undefined | string): Generator

Overrides Doer.constructor
- Defined in src/Generator.ts:15
Parameters
- urlFetcher: UrlFetcher
- folder: string | undefined
- Optional baseImage: undefined | string
Returns Generator

Properties

Optional baseImage

baseImage: undefined | string

Manually define the image to inherit FROM

folder

folder: string

The directory to scan for relevant files

Protected Readonly urlFetcher

urlFetcher: UrlFetcher

The instance of IUrlFetcher to fetch URLs

Methods

applies

applies(): boolean

- Defined in src/Generator.ts:202
Does this generator apply to the package?

Returns boolean

aptKeysCommand

aptKeysCommand(sysVersion: string): string | undefined

- Defined in src/Generator.ts:263
A Bash command to run to install required apt keys

Parameters
- sysVersion: string
  
  The Ubuntu system version being used
Returns string | undefined

aptPackages

aptPackages(sysVersion: string): Array<string>

- Defined in src/Generator.ts:281
A list of any required apt packages

Parameters
- sysVersion: string
  
  The Ubuntu system version being used
Returns Array<string>

aptRepos

aptRepos(sysVersion: string): Array<string>

- Defined in src/Generator.ts:272
A list of any required apt repositories

Parameters
- sysVersion: string
  
  The Ubuntu system version being used
Returns Array<string>

baseIdentifier

baseIdentifier(): string

- Defined in src/Generator.ts:242
Generate a base image identifier

Returns string

baseName

baseName(): string

- Defined in src/Generator.ts:209
Name of the base image

Returns string

baseVersion

baseVersion(): string

- Defined in src/Generator.ts:216
Version of the base image

Returns string

baseVersionName

baseVersionName(baseIdentifier: string): string

- Defined in src/Generator.ts:225
Get the name of an Ubuntu release

Parameters
- baseIdentifier: string
  
  The base image name e.g. ubuntu:18.04
Returns string

envVars

envVars(sysVersion: string): Array<[string, string]>

- Defined in src/Generator.ts:254
A list of environment variables to set in the image as name, value pairs

Parameters
- sysVersion: string
  
  The Ubuntu system version being used
Returns Array<[string, string]>

exists

exists(subpath: string): boolean

Inherited from Doer.exists
- Defined in src/Doer.ts:35
Does a path exist within the project folder?

Parameters
- subpath: string
  
  The path within the folder
Returns boolean

fetch

fetch(url: string, options?: any): Promise<any>

Inherited from Doer.fetch
- Defined in src/Doer.ts:83
Fetch content from a URL

Parameters
- url: string
  
  The URL to fetch
- Default value options: any = { responseType: 'json' }
  
  Request options
Returns Promise<any>

generate

generate(comments?: boolean, stencila?: boolean): string

- Defined in src/Generator.ts:32
Generate a Dockerfile for a SoftwareEnvironment instance

Parameters
- Default value comments: boolean = true
  
  Should a comments be added to the Dockerfile?
- Default value stencila: boolean = false
  
  Should relevant Stencila language packages be installed in the image?
Returns string

glob

glob(pattern: string | Array<string>): Array<string>

Inherited from Doer.glob
- Defined in src/Doer.ts:44
Get a list of paths that match a pattern in the project folder.

Parameters
- pattern: string | Array<string>
  
  The glob pattern
Returns Array<string>

installCommand

installCommand(sysVersion: string): string | undefined

- Defined in src/Generator.ts:310
The Bash command to run to install required language packages

Parameters
- sysVersion: string
  
  The Ubuntu system version being used
Returns string | undefined

installFiles

installFiles(sysVersion: string): Array<[string, string]>

- Defined in src/Generator.ts:301
A list of files that need to be be copied into the image before running installCommand

Parameters
- sysVersion: string
  
  The Ubuntu system version being used
Returns Array<[string, string]>

An array of [src, dest] tuples

projectFiles

projectFiles(sysVersion: string): Array<[string, string]>

- Defined in src/Generator.ts:320
The project's files that should be copied across to the image

Parameters
- sysVersion: string
  
  The Ubuntu system version being used
Returns Array<[string, string]>

An array of [src, dest] tuples

read

read(subpath: string): string

Inherited from Doer.read
- Defined in src/Doer.ts:63
Read a file within the project folder

Parameters
- subpath: string
  
  The path within the folder
Returns string

runCommand

runCommand(sysVersion: string): string | undefined

- Defined in src/Generator.ts:332
The default command to run in containers created from this image

Usually command will a file with a name main and the extension of the generator's language e.g. .R if it exists in the folder.

Parameters
- sysVersion: string
  
  The Ubuntu system version being used
Returns string | undefined

stencilaInstall

stencilaInstall(sysVersion: string): string | undefined

- Defined in src/Generator.ts:290
A Bash command to run to install Stencila execution host package/s

Parameters
- sysVersion: string
  
  The Ubuntu system version being used
Returns string | undefined

write

write(subpath: string, content: string): void

Inherited from Doer.write
- Defined in src/Doer.ts:73
Write to a file within the project folder

Parameters
- subpath: string
  
  The path within the folder
- content: string
  
  The content to write to the file
Returns void

Generated using TypeDoc