grunt-dojo2-extras

Index

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

OAuthScope

GitHub OAuth scopes define permissions granted to a specific token

PublishMode

PublishMode: "publish" | "commit" | "skip"

Variables

decryptIvName

decryptIvName: "publish_deploy_iv" = "publish_deploy_iv"

the name of the environment variable holding the decryption iv value

decryptKeyName

decryptKeyName: "publish_deploy_key" = "publish_deploy_key"

the name of the environment variable holding the decryption key value

githubAuthName

githubAuthName: "GITHUB_AUTH" = "GITHUB_AUTH"

the name of the environment variable holding the github authentication for API calls

logger

logger: LoggerInstance = new Logger({level: 'info',transports: [new transports.Console({showLevel: false})]})

privateKeyName

privateKeyName: "PRIVATE_KEY" = "PRIVATE_KEY"

the name of the environment variable holding the private key to publish to GitHub

Functions

cleanupModuleMocks

cleanupModuleMocks(): void

- Defined in tests/_support/loadModule.ts:24
Returns void

commitMessage

commitMessage(): string

- Defined in src/util/environment.ts:25
Returns string

createDeployKey

createDeployKey(deployKeyFile?: string, encryptedKeyFile?: string): Promise<KeyPairFiles & object>

- Defined in src/commands/initialize/createDeployKey.ts:26
Parameters
- Default value deployKeyFile: string = env.keyFile()
- Default value encryptedKeyFile: string = env.encryptedKeyFile(deployKeyFile)
Returns Promise<KeyPairFiles & object>

createHtmlApiMissingFilter

createHtmlApiMissingFilter(project: string, directory: string): TagFilter

- Defined in src/commands/getTags.ts:29
Parameters
- project: string
  
  project name
- directory: string
  
  the base directory where html api docs are stored
Returns TagFilter

a filter for existing html api docs

createJsonApiMissingFilter

createJsonApiMissingFilter(project: string, directory: string): TagFilter

- Defined in src/commands/getTags.ts:40
Parameters
- project: string
  
  project name
- directory: string
  
  the base directory where json api docs are stored
Returns TagFilter

a filter for existing json api docs

createKey

createKey(deployKeyFile?: string, keyComment?: string): Promise<KeyPairFiles>

- Defined in src/util/crypto.ts:22
Parameters
- Default value deployKeyFile: string = env.keyFile()
- Default value keyComment: string = "Automated Travis Deploy Key"
Returns Promise<KeyPairFiles>

createVersionFilter

createVersionFilter(comp: string): TagFilter

- Defined in src/commands/getTags.ts:59
Parameters
- comp: string
  
  a semver comparison
Returns TagFilter

a filter to check if the tag satisfies the semver

currentBranch

currentBranch(): string

- Defined in src/util/environment.ts:31
Returns string

the current branch as defined by the environment

decryptData

decryptData(data: ReadableStream, key: string, iv: string): Decipher

- Defined in src/util/crypto.ts:32
Parameters
- data: ReadableStream
- key: string
- iv: string
Returns Decipher

decryptDeployKey

decryptDeployKey(encryptedFile?: string, key?: string, iv?: string, decryptedFile?: string): Promise<boolean>

- Defined in src/commands/decryptDeployKey.ts:10
decrypts a deployment key

Parameters
- Default value encryptedFile: string = env.encryptedKeyFile()
- Default value key: string = process.env[env.decryptKeyName]
- Default value iv: string = process.env[env.decryptIvName]
- Default value decryptedFile: string = env.keyFile()
Returns Promise<boolean>

if decryption was carried out

encryptData

encryptData(data: ReadableStream, key?: string, iv?: string): EncryptResult

- Defined in src/util/crypto.ts:37
Parameters
- data: ReadableStream
- Default value key: string = randomUtf8(32)
- Default value iv: string = randomUtf8(16)
Returns EncryptResult

encryptedKeyFile

encryptedKeyFile(file?: string): any

- Defined in src/util/environment.ts:38
Parameters
- Default value file: string = keyFile()
Returns any

the name of the encrypted keyFile

equal

equal(aStream: Stream, bStream: Stream): Promise<Object>

- Defined in src/util/streams.ts:31
Parameters
- aStream: Stream
- bStream: Stream
Returns Promise<Object>

exec

exec(command: string, options?: ExecOptions): ChildProcess

- Defined in src/util/process.ts:39
Parameters
- command: string
- Default value options: ExecOptions = {}
Returns ChildProcess

getGithubSlug

getGithubSlug(options?: Options, grunt?: IGrunt): Slug

- Defined in tasks/util/getGithubSlug.ts:16
A standard way of configuring the target Github repository

Parameters
- Optional options: Options
- Optional grunt: IGrunt
Returns Slug

getHtmlApiPath

getHtmlApiPath(base: string, project: string, version: string): string

- Defined in src/commands/getTags.ts:13
creates a path to HTML API docs

Parameters
- base: string
- project: string
- version: string
Returns string

getJsonApiPath

getJsonApiPath(base: string, project: string, version: string): string

- Defined in src/commands/getTags.ts:20
creates a path to JSON API docs

Parameters
- base: string
- project: string
- version: string
Returns string

getTags

getTags(repo: GitHub, filters?: TagFilter[]): Promise<Tag[]>

- Defined in src/commands/getTags.ts:72
Get a list of GitHub tags that pass the supplied filters

Parameters
- repo: GitHub
  
  the GitHub repository
- Default value filters: TagFilter[] = []
  
  Tag filters to apply to the tag
Returns Promise<Tag[]>

a list of tags

gitCommit

gitCommit(): string

- Defined in src/util/environment.ts:45
Returns string

the hash of the commit that triggered this build

githubAuth

githubAuth(authStr?: string): Auth

- Defined in src/util/environment.ts:52
Parameters
- Default value authStr: string = process.env[githubAuthName]
Returns Auth

OAuth credentials to be used in GitHub queries

hasGitCredentials

hasGitCredentials(keyFile?: undefined | string): boolean

- Defined in src/util/environment.ts:60
Parameters
- Optional keyFile: undefined | string
  
  the filename of the key file to use for git credentials
Returns boolean

if the current environment will be able to run git commands requiring credentials

hasKeyFile

hasKeyFile(file?: string): boolean

- Defined in src/util/environment.ts:83
Parameters
- Default value file: string = keyFile()
  
  the filename of the key file used ssh+git permissions
Returns boolean

if the defined key file exists

hexoRootOverride

hexoRootOverride(): any

- Defined in src/util/environment.ts:75
Returns any

initAuthorization

initAuthorization(repo: GitHub, travis?: Travis): Promise<void>

- Defined in src/commands/initialize/initAuthorization.ts:31
Parameters
- repo: GitHub
- Default value travis: Travis = new Travis()
Returns Promise<void>

initDeployment

initDeployment(repo: GitHub, travis?: Travis, options?: Options): Promise<void>

- Defined in src/commands/initialize/initDeployment.ts:50
Parameters
- repo: GitHub
- Default value travis: Travis = new Travis()
- Default value options: Options = {deployKeyFile: env.keyFile(),encryptedKeyFile: env.encryptedKeyFile()}
Returns Promise<void>

installDependencies

installDependencies(dir: string): Promise<string>

- Defined in src/commands/installDependencies.ts:6
Parameters
- dir: string
Returns Promise<string>

isCronJob

isCronJob(): boolean

- Defined in src/util/environment.ts:90
Returns boolean

if the build was triggered by a cron job

isRunningOnTravis

isRunningOnTravis(): boolean

- Defined in src/util/environment.ts:97
Returns boolean

if we are currently running on Travis

keyFile

keyFile(): string

- Defined in src/util/environment.ts:104
Returns string

the name of the key file used for deploys as defined by the environment

latestFilter

latestFilter(_tag: Tag, index: number, array: Tag[]): boolean

- Defined in src/commands/getTags.ts:51
A filters only the latest

Parameters
- _tag: Tag
- index: number
  
  the index of the tag
- array: Tag[]
Returns boolean

if the tag is the latest

loadModule

loadModule<T>(require: NodeRequire, mid: string, mocks: any, returnDefault?: boolean): T

- Defined in tests/_support/loadModule.ts:4
Type parameters
- T
Parameters
- require: NodeRequire
- mid: string
- mocks: any
- Default value returnDefault: boolean = true
Returns T

makeTempDirectory

makeTempDirectory(base: string, prefix?: string): string

- Defined in src/util/file.ts:5
Parameters
- base: string
- Default value prefix: string = "tmp-"
Returns string

promiseExec

promiseExec(command: string, options?: ExecOptions): Promise<ChildProcess>

- Defined in src/util/process.ts:47
Parameters
- command: string
- Default value options: ExecOptions = {}
Returns Promise<ChildProcess>

promiseSpawn

promiseSpawn(command: string, args: string[], options?: SpawnOptions): Promise<ChildProcess>

- Defined in src/util/process.ts:64
Parameters
- command: string
- args: string[]
- Default value options: SpawnOptions = {}
Returns Promise<ChildProcess>

promisify

promisify(proc: ChildProcess): Promise<ChildProcess>

- Defined in src/util/process.ts:10
Parameters
- proc: ChildProcess
Returns Promise<ChildProcess>

publish

publish(options: Options): Promise<void>

- Defined in src/commands/publish.ts:27
Parameters
- options: Options
Returns Promise<void>

publishMode

publishMode(defaultValue?: PublishMode): PublishMode

- Defined in src/util/environment.ts:111
Parameters
- Default value defaultValue: PublishMode = isRunningOnTravis() ? 'skip' : 'commit'
Returns PublishMode

The current publish mode defined by the environment

repositorySource

repositorySource(): string

- Defined in src/util/environment.ts:118
Returns string

the current Github repository as defined by the environment (e.g. dojo/core)

setupWrappedAsyncStub

setupWrappedAsyncStub(this: any, stub: SinonStub, dfd: Deferred<any>, callback: function): void

- Defined in tests/_support/tasks.ts:4
Parameters
- this: any
- stub: SinonStub
- dfd: Deferred<any>
- callback: function
  - - (): any
    - Returns any
Returns void

spawn

spawn(command: string, args: string[], options?: SpawnOptions): ChildProcess

- Defined in src/util/process.ts:56
Parameters
- command: string
- args: string[]
- Default value options: SpawnOptions = {}
Returns ChildProcess

sync

sync(options: Options): Promise<void>

- Defined in src/commands/sync.ts:12
Parameters
- options: Options
Returns Promise<void>

throwWithError

throwWithError(errorMessage?: string): (Anonymous function)

- Defined in tests/_support/util.ts:1
Parameters
- Default value errorMessage: string = "Unexpected code path"
Returns (Anonymous function)

tmpDirectory

tmpDirectory(): string

- Defined in tests/_support/tmpFiles.ts:4
Returns string

tmpFile

tmpFile(name?: string): string

- Defined in tests/_support/tmpFiles.ts:11
Parameters
- Default value name: string = String(Math.floor(Math.random() * 10000))
Returns string

toString

toString(stream: Readable): Promise<string>

- Defined in src/util/streams.ts:8
Parameters
- stream: Readable
Returns Promise<string>

typedoc

typedoc(source: string, target: string, options?: BaseOptions | HtmlOptions): Promise<void>

- Defined in src/commands/typedoc.ts:78
Parameters
- source: string
- target: string
- Default value options: BaseOptions | HtmlOptions = {}
Returns Promise<void>

wrapAsyncTask

wrapAsyncTask<T>(task: function): (Anonymous function)

- Defined in tasks/util/wrapAsyncTask.ts:5
Type parameters
- T
Parameters
- task: function
  - - (this: IMultiTask<T>): Promise<any>
    - Parameters
      - this: IMultiTask<T>
      Returns Promise<any>
Returns (Anonymous function)

Index

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

OAuthScope

PublishMode

Variables

decryptIvName

decryptKeyName

githubAuthName

logger

privateKeyName

Functions

cleanupModuleMocks

Returns void

commitMessage

Returns string

createDeployKey

Parameters

Default value deployKeyFile: string = env.keyFile()

Default value encryptedKeyFile: string = env.encryptedKeyFile(deployKeyFile)

Returns Promise<KeyPairFiles & object>

createHtmlApiMissingFilter

Parameters

project: string

directory: string

Returns TagFilter

createJsonApiMissingFilter

Parameters

project: string

directory: string

Returns TagFilter

createKey

Parameters

Default value deployKeyFile: string = env.keyFile()

Default value keyComment: string = "Automated Travis Deploy Key"

Returns Promise<KeyPairFiles>

createVersionFilter

Parameters

comp: string

Returns TagFilter

currentBranch

Returns string

decryptData

Parameters

data: ReadableStream

key: string

iv: string

Returns Decipher

decryptDeployKey

Parameters

Default value encryptedFile: string = env.encryptedKeyFile()

Default value key: string = process.env[env.decryptKeyName]

Default value iv: string = process.env[env.decryptIvName]

Default value decryptedFile: string = env.keyFile()

Returns Promise<boolean>

encryptData

Parameters

data: ReadableStream

Default value key: string = randomUtf8(32)

Default value iv: string = randomUtf8(16)

Returns EncryptResult

encryptedKeyFile

Parameters

Default value file: string = keyFile()

Returns any

equal

Parameters

aStream: Stream

bStream: Stream

Returns Promise<Object>

exec

Parameters

command: string

Default value options: ExecOptions = {}

Returns ChildProcess

getGithubSlug