@caviar/test

Testing utility for caviar, caviar blocks, and caviar plugins

Install

$ npm i @caviar/test -D

Usage

const {
  runBlock
} = require('@caviar/test')

const block = await runBlock(NextBlock, options)

await runBlock(block: Class, options: RunBlockOptions): Block

• block Class the subclass of caviar.Block
• options RunBlockOptions

interface RunBlockOptions {
  // Which is the same as the apply function of caviar.Plugin
  apply?: Function(getHooks: Function)
  // Array of config layers
  // [app layer, lower layer, ..., the lowest layer]
  configChain: Array<object>
  // The current working directory
  cwd: string
  dev?: boolean = false
  phase?: string = 'default'
}

Returns Block the block which has already run.

License

MIT