Project API
The project module of the @codebolt/plugin-sdk.
import plugin from '@codebolt/plugin-sdk';
Quick Reference
| Method | Description |
|---|---|
getEditorFileStatus | |
getProjectPath | Retrieves the path of the current project. |
getProjectSettings | Retrieves the project settings from the server. |
getRepoMap | |
runProject |
Methods
getEditorFileStatus
plugin.project.getEditorFileStatus(): Promise<any>
No parameters.
Returns: Promise<any>
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.
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.
getRepoMap
plugin.project.getRepoMap(message: any): Promise<GetProjectPathResponse>
| Parameter | Type | Required | Description |
|---|---|---|---|
message | any | Yes |
Returns: Promise<GetProjectPathResponse>
runProject
plugin.project.runProject(): void
No parameters.
Returns: void