Skip to content

spectacular-dashboard / TaskStatusService / TaskStatusService

Class: TaskStatusService ​

TaskStatusService.TaskStatusService

Service for managing task file status based on acceptance criteria

Table of contents ​

Constructors ​

Properties ​

Methods ​

Constructors ​

constructor ​

• new TaskStatusService(): TaskStatusService

Returns ​

TaskStatusService

Properties ​

_disposables ​

• Private _disposables: Disposable[] = []

Defined in ​

src/TaskStatusService.ts:30


instance ​

▪ Static Private instance: TaskStatusService

Defined in ​

src/TaskStatusService.ts:29

Methods ​

dispose ​

▸ dispose(): void

Returns ​

void

Defined in ​

src/TaskStatusService.ts:331


findMainTasksFile ​

▸ findMainTasksFile(taskFilePath): Promise<null | string>

Find the main tasks.md file for a given task file

Parameters ​

NameType
taskFilePathstring

Returns ​

Promise<null | string>

Defined in ​

src/TaskStatusService.ts:181


isTaskFile ​

▸ isTaskFile(filePath): boolean

Check if a file is a task file (in tasks folder with task frontmatter)

Parameters ​

NameType
filePathstring

Returns ​

boolean

Defined in ​

src/TaskStatusService.ts:42


parseTaskFile ​

▸ parseTaskFile(content): null | TaskParseResult

Parse a task file and extract frontmatter and acceptance criteria

Parameters ​

NameType
contentstring

Returns ​

null | TaskParseResult

Defined in ​

src/TaskStatusService.ts:52


processTaskFileChange ​

▸ processTaskFileChange(filePath): Promise<{ mainTasksUpdated: boolean ; newStatus: undefined | string ; oldStatus: undefined | string ; statusChanged: boolean }>

Process a task file change and update status if needed

Parameters ​

NameType
filePathstring

Returns ​

Promise<{ mainTasksUpdated: boolean ; newStatus: undefined | string ; oldStatus: undefined | string ; statusChanged: boolean }>

Defined in ​

src/TaskStatusService.ts:258


updateMainTasksTable ​

▸ updateMainTasksTable(mainTasksPath, taskFileName, newStatus): Promise<boolean>

Update the status tag in the main tasks.md table for a specific task

Parameters ​

NameType
mainTasksPathstring
taskFileNamestring
newStatusstring

Returns ​

Promise<boolean>

Defined in ​

src/TaskStatusService.ts:206


updateTaskStatus ​

▸ updateTaskStatus(content, newStatus): string

Update the status in frontmatter based on acceptance criteria

Parameters ​

NameType
contentstring
newStatusstring

Returns ​

string

Defined in ​

src/TaskStatusService.ts:143


getInstance ​

▸ getInstance(): TaskStatusService

Returns ​

TaskStatusService

Defined in ​

src/TaskStatusService.ts:32

Released under the MIT License.