# chronologically

> A task runner. Do not use. Yet.

Latest version **1.1.2** (published 2023-05-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install chronologically
pnpm add chronologically
yarn add chronologically
bun add chronologically
```

Provides the command `chronologically`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.2 |
| Published | 2023-05-17 |
| First published | 2023-05-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 43 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Ezell Frazier |
| Maintainers | lynellf |
| Keywords | chronologically, task runner |

## Links

- npm: https://www.npmjs.com/package/chronologically
- npm.io page: https://npm.io/package/chronologically

## Dependencies (7)

- [open](https://npm.io/package/open.md) ^9.1.0
- [serve](https://npm.io/package/serve.md) ^14.2.0
- [xstate](https://npm.io/package/xstate.md) ^4.37.1
- [wait-on](https://npm.io/package/wait-on.md) ^7.0.1
- [uniqueid](https://npm.io/package/uniqueid.md) ^1.0.0
- [typescript](https://npm.io/package/typescript.md) ^5.0.3
- [@types/wait-on](https://npm.io/package/@types/wait-on.md) ^5.3.1

## Alternatives

- [cli-color](https://npm.io/package/cli-color.md) — 3.4M weekly downloads
- [log](https://npm.io/package/log.md) — 1.3M weekly downloads
- [logstash-client](https://npm.io/package/logstash-client.md) — 4.5K weekly downloads
- [@nocobase/plugin-logger](https://npm.io/package/@nocobase/plugin-logger.md) — 2.0K weekly downloads
- [child-process-debug](https://npm.io/package/child-process-debug.md) — 695 weekly downloads

## Recent versions

- 1.1.2 (latest) — 2023-05-17
- 1.1.1 — 2023-05-17
- 1.1.0 — 2023-05-17
- 1.0.3 — 2023-05-17
- 1.0.2 — 2023-05-17
- 1.0.1 — 2023-05-17
- 1.0.0 — 2023-05-17

## README

## Chronologically

### What is this?

`chronologically` is a task/process runner. A config file is interpreted as a series of jobs to perform. If a job needs to poll a server before starting, it will do that. 

### Motivation

Ran into a situation at work in which our development tooling doesn't behave as intended. 

`<script-name> run dev`

This command should:
- Start my development server
- Launch an Electron-based container

But instead it only performs the first job with no word as to what's happening with the second.

`chronologically` isn't meant to be a package for widespread use, but for personal use in places where I need to ensure tasks that impact my day-to-day development are in my control. 


### How to use

`npm install chronologically`

`chronologically <path-to-config-file>.json`

### Config

```typescript

type Message = 'default'|'warning'|'error'

type Job = {
  id?: string; // shall be autogenerated
  name: string; // name of the job
  command: string; // command of the job
  args?: string[]; // command args
  message?: string; // message emitted before running job
  options?: SpawnOptions; // options reference: https://nodejs.org/api/child_process.html#child_processspawncommand-args-options
  // see options here: https://github.com/jeffbski/wait-on
  waitOn?: WaitOnOptions; // should the job wait for other dependencies before running?
  messageForwarding?: MessageType[]; // what messages shall emit to the user's console?
  saveLog?: boolean; // write log to disk?
};

type Config = {
  logOutDir?: string;
  jobs: Job[];
};
```

---
_Source: https://npm.io/package/chronologically · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
