什么是 Listr?
Listr 是一个 Node.js 模块,可以帮助你在终端中以统一的格式展示多个任务(tasks)的状态和进度。它提供了多种内置的样式和选项,也支持自定义样式和事件处理。
如果你曾经使用过 Gulp、Grunt 或 Webpack 等构建工具,那么对于 Listr 的使用应该很容易理解。Listr 可以让你方便地将多个任务组合在一起,并按照特定顺序执行这些任务,同时在终端中实时展示每个任务的完成情况。
安装 Listr
首先,我们需要在项目中安装 Listr:
npm install --save-dev listr
使用 Listr
创建任务
下面是一个简单的例子,展示如何创建一个 Listr 实例并添加一些任务:
-- -------------------- ---- ------- ----- ----- - ----------------- -- ---- ----- -- ----- ----- - --- ------- - ------ ----- --- ----- -- -- - ------ --- ----------------- ------- -- - ------------- -- - ----------------- - ------- ---------- -- ------ --- -- -- - ------ ----- --- ----- -- -- - ------ --- ----------------- ------- -- - ------------- -- - ----------------- - ------- ---------- -- ------ --- -- -- --- -- ---- ----------------------- -- - ------------------- ---
在这个例子中,我们创建了一个 Listr 实例,并添加了两个任务 Task 1
和 Task 2
。每个任务都是一个对象,包括一个 title
属性和一个 task
方法。title
表示任务的名称,task
是一个返回 Promise 的方法,用来执行任务的具体逻辑。
添加子任务
Listr 还支持给任务添加子任务:
-- -------------------- ---- ------- ----- ----- - --- ------- - ------ ----- ------ ----- ----- ----- -- - ------ --------------- - ------ -------- --- ----- -- -- - ------ --- ----------------- ------- -- - ------------- -- - -------------------- - ------- ---------- -- ------ --- -- -- - ------ -------- --- ----- -- -- - ------ --- ----------------- ------- -- - ------------- -- - -------------------- - ------- ---------- -- ------ --- -- -- --- -- -- ---
在上面的例子中,我们在主任务中添加了两个子任务。注意到子任务的定义方式和主任务是一样的,只不过是通过 task.newListr()
方法添加的。
自定义任务状态
Listr 内置了多种任务状态,比如成功、失败、跳过等等。你也可以自定义任务的状态:
-- -------------------- ---- ------- ----- ----- - --- ------- - ------ ------- ---- -------- ----- ----- ----- -- - -- ----- ----- ------------ - - ---- - ------ ------ ------ --------- -- ---- - ------ ------ ------ ------ -- -- -- ---- ------ -------------- - - ------ ----- ---- ------ ------- ----- -- -- - -- -------------- ----------- - ------ ------ --- ----------------- ------- -- - ------------- -- - ----------------- ------- ---------- -- ------ --- -- -- -- - ---------------- - -- ------- ------------- -- - -- -- -- ---
在这个例子中,我们创建了两种自定义状态 `foo
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/44777