tasuku 1.0.2 → 2.0.1

package/README.md

@@ -1,4 +1,3 @@
-
 <p align="center">
     <img src=".github/tasuku.svg">
     <br>
@@ -11,7 +10,7 @@
 - Unopinionated
 - Type-safe
 
-→ [Try it out online](https://stackblitz.com/edit/tasuku-demo?file=index.js)
+→ [Try it out online](https://stackblitz.com/edit/tasuku-demo?file=index.js&devtoolsheight=50&view=editor)
 
 <sub>Support this project by starring and sharing it. [Follow me](https://github.com/privatenumber) to see what other cool projects I'm working on.</sub>
 
@@ -20,6 +19,26 @@
 npm i tasuku
 ```
 
+## About
+タスク (Tasuku) is a minimal task runner for Node.js. You can use it to label any task/function so that its loading, success, and error states are rendered in the terminal.
+
+For example, here's a simple script that copies a file from path A to B.
+
+```ts
+import { copyFile } from 'fs/promises'
+import task from 'tasuku'
+
+task('Copying file from path A to B', async ({ setTitle }) => {
+    await copyFile('/path/A', '/path/B')
+
+    setTitle('Successfully copied file from path A to B!')
+})
+```
+
+Running the script will look like this in the terminal:
+
+<img src=".github/example-0.gif">
+
 ## Usage
 ### Task list
 Call `task(taskTitle, taskFunction)` to start a task and display it in a task list in the terminal.
@@ -64,11 +83,11 @@ task('Task 1', async () => {
     await someAsyncTask()
 })
 
-...
+// ...
 
 someOtherCode()
 
-...
+// ...
 
 task('Task 2', async ({ setTitle }) => {
     await someAsyncTask()
@@ -149,12 +168,12 @@ const groupedTasks = await task.group(task => [
         setTitle('Task 2 complete')
 
         return 'two'
-    }),
+    })
 
-    ...
+    // ...
 ])
 
-console.log(groupedTasks.results) // ['one', 'two']
+console.log(groupedTasks) // [{ result: 'one' }, { result: 'two' }]
 ```
 
 <img src=".github/example-5.gif">
@@ -166,14 +185,15 @@ You can run tasks in parallel by passing in `{ concurrency: n }` as the second a
 const api = await task.group(task => [
     task(
         'Task 1',
-        async () => await someAsyncTask(),
+        async () => await someAsyncTask()
     ),
-    
+
     task(
         'Task 2',
-        async () => await someAsyncTask(),
-    ),
-    ...
+        async () => await someAsyncTask()
+    )
+
+    // ...
 ], {
     concurrency: 2 // Number of tasks to run at a time
 })
@@ -190,14 +210,15 @@ Alternatively, you can also use the native `Promise.all()` if you prefer. The ad
 await Promise.all([
     task(
         'Task 1',
-        async () => await someAsyncTask(),
+        async () => await someAsyncTask()
     ),
 
     task(
         'Task 2',
-        async () => await someAsyncTask(),
-    ),
-    ...
+        async () => await someAsyncTask()
+    )
+
+    // ...
 ])
 ```
 
@@ -207,12 +228,15 @@ await Promise.all([
 
 Returns a Promise that resolves with object:
 ```ts
-{
-    // The result from taskFunction
-    result: any,
+type TaskAPI = {
+    // Result from taskFunction
+    result: any
+
+    // State of the task
+    state: 'error' | 'warning' | 'success'
 
     // Invoke to clear the results from the terminal
-    clear: () => void,
+    clear: () => void
 }
 ```
 
@@ -226,13 +250,13 @@ The name of the task displayed.
 #### taskFunction
 Type:
 ```ts
-({
-    task: taskFunction,
-    setTitle: (title: string) => void,
-    setStatus: (status: string) => void,
-    setOutput: (error: string | { message: string }) => void,
-    setWarning: (warning: Error | string) => void,
-    setError: (error: Error | string) => void,
+type TaskFunction = (taskInnerApi: {
+    task: createTask
+    setTitle(title: string): void
+    setStatus(status?: string): void
+    setOutput(output: string | { message: string }): void
+    setWarning(warning: Error | string): void
+    setError(error: Error | string): void
 }) => Promise<any>
 ```
 
@@ -265,12 +289,20 @@ Call with a string or Error instance to put the task in an error state. Tasks au
 ### task.group(createTaskFunctions, options)
 Returns a Promise that resolves with object:
 ```ts
-{
-    // The results from the taskFunctions
-    results: any[],
+// The results from the taskFunctions
+type TaskGroupAPI = {
+    // Result from taskFunction
+    result: any
 
-    // Invoke to clear the results from the terminal
-    clear: () => void,
+    // State of the task
+    state: 'error' | 'warning' | 'success'
+
+    // Invoke to clear the task result
+    clear: () => void
+}[] & {
+
+    // Invoke to clear ALL results
+    clear: () => void
 }
 ```