Event-driven tooling

What kind of tool would Beemo be without the ability to listen to events? A terrible one, and as such, Beemo totally supports them! Events provide an easy mechanism for hooking into the lifecycle of a Beemo process.

To begin, create an index file in your configuration module that exports a function, either as a default export or as a named bootstrap export. This function will receive a Beemo Tool instance for the current process, in which listeners can be registered.

index.ts

import { Tool } from '@beemo/core';

export default function bootstrap(tool: Tool) {

// Add command line args to every execution

tool.driverRegistry.get('eslint').onBeforeExecute.listen((context) => {

context.addOptions(['--color', '--report-unused-disable-directives']);

});

}

The bootstrap function supports async/await.

Bootstrap resolution

The bootstrap file is looked for and resolved in the following order relative to the configuration module.

• index.ts
• index.js
• src/index.ts
• lib/index.js
• main field in package.json

Supported events

The following list of events, and their arguments, can be listened to.

Tool

Event	Arguments	Type	Description
onResolveDependencies	context: ConfigContext, drivers: Driver[]	Normal	Called after a list of Drivers have been resolved in which to create configuration files.
onRunCreateConfig	context: ConfigContext, driverNames: string[]	Normal	Called before beemo create-config is ran.
onRunDriver	context: DriverContext, driver: Driver	Normal	Called before beemo <driver> is ran. Requires a scope of the driver name.
onRunScript	context: ScriptContext	Normal	Called before beemo run-script <script> is ran. Requires a scope of the script name.
onScaffold	context: ScaffoldContext, generator: string, action: string, name?: string	Normal	Called before templates are generated when scaffolding.

Driver

Event	Arguments	Type	Description
onAfterExecute	context: DriverContext, response: unknown	Concurrent	Called after the driver has successfully been executed.
onBeforeExecute	context: DriverContext, argv: string[]	Concurrent	Called before the underlying Driver binary command is executed.
onCreateConfigFile	context: ConfigContext, path: Path, config: object	Normal	Called before the configuration file is written.
onCopyConfigFile	context: ConfigContext, path: Path, config: object	Normal	Called before the configuration file is copied from module.
onDeleteConfigFile	context: ConfigContext, path: Path	Normal	Called before the configuration file is deleted. Occurs during the cleanup phase.
onFailedExecute	context: DriverContext, error: Error	Concurrent	Called after the driver has failed to execute.
onLoadModuleConfig	context: ConfigContext, path: Path, config: object	Normal	Called after configuration has been loaded from the configuration module.
onLoadPackageConfig	context: ConfigContext, config: object	Normal	Called after configuration has been extracted from package.json.
onMergeConfig	context: ConfigContext, config: object	Normal	Called after multiple configuration sources have been merged into 1.
onReferenceConfigFile	context: ConfigContext, path: Path, config: object	Normal	Called before the configuration file is referenced.
onTemplateConfigFile	context: ConfigContext, path: Path, config: object/string	Normal	Called before the configuration file is written. The config is built using a consumer template, so can appear as an object or raw string (config file contents).

Script

Event	Arguments	Type	Description
onAfterExecute	context: ScriptContext, response: unknown	Concurrent	Called after the script has successfully been executed.
onBeforeExecute	context: ScriptContext, argv: string[]	Concurrent	Called before the Script#execute method is ran.
onFailedExecute	context: ScriptContext, error: Error	Concurrent	Called after the script has failed to execute.

Type declarations

• Driver - An instance of the Driver class.
• Script - An instance of the Script class.
• Context, DriverContext, ScriptContext, ScaffoldContext - Special objects passed through the entire execution process.