Skip to content

dev

Builds the Obsidian plugin in development mode using esbuild with watch.

In addition to esbuild’s own source-graph watch, the development build also watches the plugin’s node_modules folder and restarts the whole build (including the type-check) when it changes, so a dependency reinstall or rebuild is picked up.

Import:

import { dev } from 'obsidian-dev-utils/script-utils/bundlers/esbuild-impl/obsidian-plugin-builder';

Signature:

function dev(options: BuildOptions | undefined): Promise<CliTaskResult>

Parameters:

ParameterTypeDescription
optionsBuildOptions | undefinedOptional build parameters (mode is set to Development automatically).

Returns: Promise<CliTaskResult> — A Promise that resolves to a CliTaskResult indicating the build result.


Links to this page: