Merge pull request #1 from lilBunnyRabbit/dev

v0.0.0

Author: lilBunnyRabbit

.github/workflows/release.yml

@@ -1,10 +1,9 @@
 name: Release
 
 on:
-  # Disabled for template
-  # push:
-  #   branches:
-  #     - master
+  push:
+    branches:
+      - master
 
   workflow_dispatch:
 

.gitignore

@@ -1,2 +1,3 @@
 node_modules/
 dist/
+.vscode/

README.md

@@ -1,18 +1,89 @@
-# NPM Package Template
+# [TypeScript](https://www.typescriptlang.org/) Task Management System
 
-[![npm version](https://img.shields.io/npm/v/@lilbunnyrabbit/<package-name>.svg)](https://www.npmjs.com/package/@lilbunnyrabbit/<package-name>)
-[![npm downloads](https://img.shields.io/npm/dt/@lilbunnyrabbit/<package-name>.svg)](https://www.npmjs.com/package/@lilbunnyrabbit/<package-name>)
+[![npm version](https://img.shields.io/npm/v/@lilbunnyrabbit/task-manager.svg)](https://www.npmjs.com/package/@lilbunnyrabbit/task-manager)
+[![npm downloads](https://img.shields.io/npm/dt/@lilbunnyrabbit/task-manager.svg)](https://www.npmjs.com/package/@lilbunnyrabbit/task-manager)
 
-This repository serves as a template for creating npm packages, simplifying the setup and development process for your npm packages. Replace all the `<package-name>` and `<repo-name>` with the name of the repository and/or package.
+A flexible and powerful task management system built with [TypeScript](https://www.typescriptlang.org/). It helps in managing both synchronous and asynchronous tasks with ease, allowing you to queue tasks, execute them sequentially or in parallel, and monitor their progress.
+
+> [!NOTE]  
+> This project uses `EventEmitter` and `Optional` from [![npm version](https://img.shields.io/npm/v/%40lilbunnyrabbit%2Futils?label=%40lilbunnyrabbit%2Futils)](https://www.npmjs.com/package/@lilbunnyrabbit/utils) for handling events and optional values.
 
 ## Installation
 
 To use this package in your project, run:
 
 ```sh
-npm i @lilbunnyrabbit/<package-name>
+npm i @lilbunnyrabbit/task-manager
+```
+
+## Getting Started
+
+This system revolves around two main components: [`TaskManager`](#taskmanager) and [`Task`](#task).
+
+- **[`TaskManager`](#taskmanager)**: Manages task execution, queuing, and progress tracking. It can run tasks sequentially or in parallel, giving full control over execution.
+- **[`Task`](#task)**: Represents a single unit of work. Each task encapsulates its own logic, data, and execution state, with custom error handling and progress reporting.
+
+### Creating a Task
+
+You can create a task using the `createTask` function:
+
+```ts
+import { createTask } from "@lilbunnyrabbit/task-manager";
+
+const myTask = createTask<void, string>({
+  name: "Example Task",
+
+  async execute() {
+    return "Task Completed!";
+  },
+});
+```
+
+### Managing Tasks with TaskManager
+
+[`Tasks`](#task) are managed using the [`TaskManager`](#taskmanager), which allows you to add tasks, track progress, and handle task completion:
+
+```ts
+import { TaskManager } from "@lilbunnyrabbit/task-manager";
+
+const manager = new TaskManager();
+
+manager.addTasks([myTask()]);
+manager.start();
 ```
 
+## Examples
+
+You can find more examples of how to use this task management system in the [`examples`](./examples) folder. Some key examples include:
+
+- **[Basic Task Execution](./examples/basic-example)**: Learn how to create and execute a simple task.
+- **[Sequential Task Execution](./examples/sequential-example)**: Execute tasks one after the other.
+- **[Parallel Task Execution](./examples/parallel-example)**: Run tasks concurrently with parallel execution.
+
+## API Overview
+
+This is a quick rundown of the key classes and methods in the task management system.
+
+If you're looking for detailed API docs, check out the [full documentation](https://lilbunnyrabbit.github.io/task-manager/docs/api) generated via [Typedoc](https://typedoc.org/).
+
+### TaskManager
+
+The `TaskManager` is responsible for managing tasks and controlling their execution.
+
+- `addTasks(tasks: Task[])`: Adds tasks to the queue.
+- `start([force: boolean])`: Starts executing the tasks in the queue.
+- `stop()`: Stops execution of tasks.
+- `reset()`: Resets the task manager and its state.
+- `clearQueue()`: Clears the task queue.
+
+### Task
+
+A `Task` represents a single unit of work within the system.
+
+- `execute()`: Executes the task.
+- `parse()`: Returns a UI-friendly representation of the task's state.
+- `clone()`: Clones the task for re-execution.
+
 ## Development
 
 This section provides a guide for developers to set up the project environment and utilize various npm scripts defined in the project for efficient development and release processes.
@@ -22,8 +93,8 @@ This section provides a guide for developers to set up the project environment a
 Clone the repository and install dependencies:
 
 ```sh
-git clone https://github.com/lilBunnyRabbit/<repo-name>.git
-cd <repo-name>
+git clone https://github.com/lilBunnyRabbit/task-manager.git
+cd task-manager
 npm install
 ```
 

docs/api/.nojekyll

@@ -0,0 +1 @@
+TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.

docs/api/assets/highlight.css

@@ -0,0 +1,99 @@
+:root {
+    --light-hl-0: #795E26;
+    --dark-hl-0: #DCDCAA;
+    --light-hl-1: #000000;
+    --dark-hl-1: #D4D4D4;
+    --light-hl-2: #A31515;
+    --dark-hl-2: #CE9178;
+    --light-hl-3: #AF00DB;
+    --dark-hl-3: #C586C0;
+    --light-hl-4: #001080;
+    --dark-hl-4: #9CDCFE;
+    --light-hl-5: #0000FF;
+    --dark-hl-5: #569CD6;
+    --light-hl-6: #0070C1;
+    --dark-hl-6: #4FC1FF;
+    --light-hl-7: #267F99;
+    --dark-hl-7: #4EC9B0;
+    --light-hl-8: #098658;
+    --dark-hl-8: #B5CEA8;
+    --light-hl-9: #008000;
+    --dark-hl-9: #6A9955;
+    --light-hl-10: #000000FF;
+    --dark-hl-10: #D4D4D4;
+    --light-code-background: #FFFFFF;
+    --dark-code-background: #1E1E1E;
+}
+
+@media (prefers-color-scheme: light) { :root {
+    --hl-0: var(--light-hl-0);
+    --hl-1: var(--light-hl-1);
+    --hl-2: var(--light-hl-2);
+    --hl-3: var(--light-hl-3);
+    --hl-4: var(--light-hl-4);
+    --hl-5: var(--light-hl-5);
+    --hl-6: var(--light-hl-6);
+    --hl-7: var(--light-hl-7);
+    --hl-8: var(--light-hl-8);
+    --hl-9: var(--light-hl-9);
+    --hl-10: var(--light-hl-10);
+    --code-background: var(--light-code-background);
+} }
+
+@media (prefers-color-scheme: dark) { :root {
+    --hl-0: var(--dark-hl-0);
+    --hl-1: var(--dark-hl-1);
+    --hl-2: var(--dark-hl-2);
+    --hl-3: var(--dark-hl-3);
+    --hl-4: var(--dark-hl-4);
+    --hl-5: var(--dark-hl-5);
+    --hl-6: var(--dark-hl-6);
+    --hl-7: var(--dark-hl-7);
+    --hl-8: var(--dark-hl-8);
+    --hl-9: var(--dark-hl-9);
+    --hl-10: var(--dark-hl-10);
+    --code-background: var(--dark-code-background);
+} }
+
+:root[data-theme='light'] {
+    --hl-0: var(--light-hl-0);
+    --hl-1: var(--light-hl-1);
+    --hl-2: var(--light-hl-2);
+    --hl-3: var(--light-hl-3);
+    --hl-4: var(--light-hl-4);
+    --hl-5: var(--light-hl-5);
+    --hl-6: var(--light-hl-6);
+    --hl-7: var(--light-hl-7);
+    --hl-8: var(--light-hl-8);
+    --hl-9: var(--light-hl-9);
+    --hl-10: var(--light-hl-10);
+    --code-background: var(--light-code-background);
+}
+
+:root[data-theme='dark'] {
+    --hl-0: var(--dark-hl-0);
+    --hl-1: var(--dark-hl-1);
+    --hl-2: var(--dark-hl-2);
+    --hl-3: var(--dark-hl-3);
+    --hl-4: var(--dark-hl-4);
+    --hl-5: var(--dark-hl-5);
+    --hl-6: var(--dark-hl-6);
+    --hl-7: var(--dark-hl-7);
+    --hl-8: var(--dark-hl-8);
+    --hl-9: var(--dark-hl-9);
+    --hl-10: var(--dark-hl-10);
+    --code-background: var(--dark-code-background);
+}
+
+.hl-0 { color: var(--hl-0); }
+.hl-1 { color: var(--hl-1); }
+.hl-2 { color: var(--hl-2); }
+.hl-3 { color: var(--hl-3); }
+.hl-4 { color: var(--hl-4); }
+.hl-5 { color: var(--hl-5); }
+.hl-6 { color: var(--hl-6); }
+.hl-7 { color: var(--hl-7); }
+.hl-8 { color: var(--hl-8); }
+.hl-9 { color: var(--hl-9); }
+.hl-10 { color: var(--hl-10); }
+pre, code { background: var(--code-background); }