obsidian-dev-utils
Version:
This is the collection of useful functions that you can use for your Obsidian plugin development
43 lines (42 loc) • 1.5 kB
text/typescript
/**
* @packageDocumentation
*
* This module provides utility functions to handle the build process for static assets and cleaning
* the build output folder. It includes functions to copy static files to the distribution folder
* and to remove the existing build output.
*/
/**
* Removes the distribution folder and its contents.
*
* This function deletes the entire distribution folder to ensure a clean build environment.
*
* @returns A {@link Promise} that resolves when the folder has been removed.
*/
export declare function buildClean(): Promise<void>;
/**
* Compiles the code.
*
* @returns A {@link Promise} that resolves when the code compiles successfully.
*/
export declare function buildCompile(): Promise<void>;
/**
* Compiles the Svelte code.
*
* @returns A {@link Promise} that resolves when the code compiles successfully.
*/
export declare function buildCompileSvelte(): Promise<void>;
/**
* Compiles the TypeScript code.
*
* @returns A {@link Promise} that resolves when the code compiles successfully.
*/
export declare function buildCompileTypeScript(): Promise<void>;
/**
* Copies all static files from the static assets folder to the distribution folder.
*
* This function recursively reads the contents of the static assets folder and copies
* each file to the corresponding path in the distribution folder.
*
* @returns A {@link Promise} that resolves when all files have been copied.
*/
export declare function buildStatic(): Promise<void>;