@tsed/cli-tasks

Terminal-friendly task runner shared by every Ts.ED CLI command. Tasks return ordered steps, receive a TaskLogger, and can stream child-process output without depending on Listr/Listr2.

Documentation

• CLI task guide – explains lifecycle, progress tips, and cancellation patterns.

Quick example

import type {Task} from "@tsed/cli-tasks";
import {execa} from "execa";

export interface DeployContext {
  projectDir: string;
  install: boolean;
  onCancel(handler: () => void): void;
}

export const deployTasks: Task<DeployContext>[] = [
  {
    title: "Install dependencies",
    skip: (ctx) => (!ctx.install ? "Skipped with --no-install" : false),
    async task(ctx, logger) {
      const subprocess = execa("npm", ["install"], {cwd: ctx.projectDir});
      ctx.onCancel(() => subprocess.kill("SIGINT"));
      subprocess.stdout?.on("data", (chunk) => logger.info(chunk.toString().trim()));
      await subprocess;
    }
  }
];

The snippet is lifted from the docs example above; update one file and both locations stay in sync.

Contributors

Please read contributing guidelines here

Backers

Thank you to all our backers! 🙏 [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

License

The MIT License (MIT)

Copyright (c) 2016 - Today Romain Lenzotti

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.