Skip to main content

Project API

The project module of the @codebolt/plugin-sdk.

import plugin from '@codebolt/plugin-sdk';

Quick Reference

MethodDescription
getEditorFileStatus
getProjectPathRetrieves the path of the current project.
getProjectSettingsRetrieves the project settings from the server.
getRepoMap
runProject

Methods


getEditorFileStatus

plugin.project.getEditorFileStatus(): Promise<any>

No parameters.

Returns: Promise<any>

Full reference →


getProjectPath

plugin.project.getProjectPath(): Promise<GetProjectPathResponse>

Retrieves the path of the current project.

No parameters.

Returns: Promise<GetProjectPathResponse> — A promise that resolves with the project path response.

Full reference →


getProjectSettings

plugin.project.getProjectSettings(): Promise<GetProjectSettingsResponse>

Retrieves the project settings from the server.

No parameters.

Returns: Promise<GetProjectSettingsResponse> — A promise that resolves with the project settings response.

Full reference →


getRepoMap

plugin.project.getRepoMap(message: any): Promise<GetProjectPathResponse>
ParameterTypeRequiredDescription
messageanyYes

Returns: Promise<GetProjectPathResponse>

Full reference →


runProject

plugin.project.runProject(): void

No parameters.

Returns: void

Full reference →