Turbowatch 项目教程

Turbowatch 项目教程

turbowatch Extremely fast file change detector and task orchestrator for Node.js. 项目地址: https://gitcode.com/gh_mirrors/tu/turbowatch

1. 项目介绍

Turbowatch 是一个极其快速的文件变更检测和任务编排工具，专为 Node.js 设计。如果你曾经想要一个比 Nodemon 更强大的工具，那么你来对地方了。Turbowatch 能够处理复杂的文件变更事件，并根据这些事件执行相应的任务，非常适合用于复杂的开发环境，如 monorepos。

主要特点

• 快速检测文件变更：Turbowatch 能够快速检测文件的变更，并触发相应的任务。
• 任务编排：支持复杂的任务编排，包括任务的重试、中断、并发执行等。
• 自定义后端：支持使用自定义的文件监视后端。
• 日志分组：支持日志分组，便于调试和监控。

2. 项目快速启动

安装

首先，你需要安装 Turbowatch：

npm install turbowatch

基本使用

以下是一个简单的示例，展示了如何使用 Turbowatch 监视文件变更并执行 TypeScript 编译任务：

import { defineConfig } from 'turbowatch';

export default defineConfig({
  project: __dirname,
  triggers: [
    {
      expression: ['match', '*.ts', 'basename'],
      name: 'build',
      onChange: async ({ spawn }) => {
        await spawn`tsc`;
      },
    },
  ],
});

运行

保存上述代码到 turbowatch.ts 文件中，然后运行以下命令启动 Turbowatch：

npm exec turbowatch ./turbowatch.ts

3. 应用案例和最佳实践

应用案例

• Monorepo 开发：在 monorepo 项目中，Turbowatch 可以监视多个子项目的文件变更，并自动执行相应的构建任务。
• 开发服务器重启：在开发过程中，Turbowatch 可以监视代码文件的变更，并在文件变更时自动重启开发服务器。

最佳实践

• 任务重试：在 onChange 任务中，如果任务失败，Turbowatch 会自动重试，确保任务最终能够成功执行。
• 中断任务：如果文件变更频繁，Turbowatch 可以配置为中断当前正在执行的任务，以确保最新的变更能够及时处理。

4. 典型生态项目

Turborepo

Turbowatch 与 Turborepo 配合使用，可以更好地管理复杂的 monorepo 项目。Turborepo 提供了项目结构的管理，而 Turbowatch 则负责文件变更的检测和任务的编排。

TypeScript

Turbowatch 可以与 TypeScript 配合使用，自动检测 TypeScript 文件的变更，并执行编译任务。

Docker

在开发过程中，Turbowatch 可以监视 Docker 配置文件的变更，并自动重新构建和启动 Docker 容器。

通过以上内容，你可以快速上手并深入了解 Turbowatch 的使用和最佳实践。

turbowatch Extremely fast file change detector and task orchestrator for Node.js. 项目地址: https://gitcode.com/gh_mirrors/tu/turbowatch