> ## 🛠Status: In Development
> Tsundere is currently under heavy development. Feedback is always welcome, but be careful with
using it in production. API is not ready yet and can receive large changes.
# Tsundere
[](https://www.npmjs.com/package/tsundere) [](https://bundlephobia.com/result?p=tsundere@latest) [](https://bundlephobia.com/result?p=tsundere@latest) [](https://www.jsdelivr.com/package/npm/tsundere) 
  
Tsundere is a modern, lightweight and type-safe task runner for the stubborn ones.
## Install
Install Tsundere for Node, using NPM or Yarn.
```bash
npm install --save-dev tsundere
```
Tsundere can also be used inside a browser, as an ES Module.
```html
```
#### Browser compatibility
| [
](http://godban.github.io/browsers-support-badges/)
IE / Edge | [
](http://godban.github.io/browsers-support-badges/)
Firefox | [
](http://godban.github.io/browsers-support-badges/)
Chrome | [
](http://godban.github.io/browsers-support-badges/)
Safari | [
](http://godban.github.io/browsers-support-badges/)
iOS Safari | [
](http://godban.github.io/browsers-support-badges/)
Opera |
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
| IE10+ / Edge 12 | Firefox 15 | Chrome 20 | Safari 8 | iOS Safari 9 | Opera 15 |
Tsundere is able to support up to Internet Explorer 10 and any browser with [High Resolution Time API](https://caniuse.com/high-resolution-time), using a few polyfills.
```html
```
## Usage
> The following section will soon provide the Tsundere CLI usage guide, once it's ready.
## API
A task is defined by a `callback` function. Nameless tasks an be constructed via `new TsundereTask(callback)` or `task(callback)`. A provided Jest-inspired `describe` function can help you label your tasks.
```js
import { describe } from 'tsundere'
const job = describe('my-task', async () => await somePromiseWhichReturn(true))
```
You can subscribe to task events, using `.on` or `.once`.
```javascript
job.once('start', () => console.log('it started.'))
job.once('end', () => console.log('it ended.'))
job.on('error', (e) => console.log(`Oops! Something went wrong..\n${e}`))
```
Using `.run` method, the task will run and return a report, including relevant data as well as the duration in milliseconds.
```javascript
job.run().then(report => { console.log(report); })
/**
* Output: {
* "label": "my-task",
* "result": true,
* "duration": 1.4819
* }
*/
```
Nameless or labelled tasks can be grouped and run concurrently, using `parallel` or in sequence, using `series` methods.
```js
import { parallel, series } from 'tsundere'
parallel([/* Insert your tasks here */]).run().then(report => { console.log(report); })
series([/* Insert your tasks here */]]).run().then(report => { console.log(report); })
```
Using `describeParallel` or `describeSeries` allows you to create and label your task group.
```js
import { describeParallel, describeSeries } from 'tsundere'
describeParallel('parallel-tasks', [/* Insert your tasks here */]).run()
describeSeries('sequence-tasks', [/* Insert your tasks here */]).run()
```
You can also set up a `TsundereRunner` task runner to run and chain tasks under a same context and reduce boilerplate code (_e.g._ events, formatting). Registered tasks will be run in parallel when using `.run`.
Under the hood, when relying on `.parallel`, `.series`, `.describeParallel` or `.describeSeries` methods, the task runner is explicitly aware of the related sub-tasks and will correctly format the final report.
```javascript
import { TsundereRunner, describe, task } from 'tsundere'
// Sample promise
function timeout(ms) {
return new Promise(resolve => setTimeout(resolve(true), ms));
}
// Let's setup our task runner
const tsundere = new TsundereRunner()
tsundere.task(async () => await timeout(300))
tsundere.describe('A', async () => await timeout(400))
tsundere.series([
describe('B', async () => await timeout(700)),
describe('C', async () => await timeout(450)),
])
tsundere.describeParallel('D', [
describe('E', async () => await timeout(750)),
task(async () => await timeout(600)),
])
tsundere.run().then(report => { console.log(report); })
/**
* Output: [
* { label: undefined, result: true, duration: 301.2114 },
* { label: "A", result: true, duration: 402.8211 },
* { label: undefined, result: true, duration: 603.0201 },
* { label: "B", result: true, duration: 702.3147 },
* { label: "E", result: true, duration: 753.3701 },
* { label: "D", result: [ [...], [...] ], duration: 754.0116 }
* { label: "C", result: true, duration: 450.1668 },
* { label: undefined, result: [ [...], [...] ], duration: 1152.0446 }
* ]
*/
```
## Contributing
```bash
npm install # Install dependencies
npm run build # Transpile, generate typings, bundle for production
npm run test # Run test(s)
```
## License
Tsundere is licensed under [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0).
© Copyright 2020 Tom Bazarnik.