weaveworks/watch

Watch Docker镜像文档

概述

Watch是一个轻量级命令行工具，能够监视文件系统的变化并自动执行指定命令。该Docker镜像封装了这一工具，使其可以轻松集成到Docker开发环境中，提高开发效率。

核心功能与特性

• 实时监视指定目录中的文件和目录变化
• 检测到文件更改时自动执行配置的命令
• 支持自定义监视路径和忽略规则
• 轻量级设计，资源占用低
• 易于集成到开发工作流中

使用场景

• 开发环境中的自动构建流程
• 代码更改后自动运行测试套件
• 前端开发中的自动编译(Sass, TypeScript等)
• 后端服务代码更改后自动重启应用
• 文档变更后自动生成或部署

快速开始

基本用法

使用以下命令运行Watch镜像，监视当前目录并在文件更改时执行命令：

bash
docker run --rm -v $(pwd):/watch docker.xuanyuan.run/weaveworks/watch [options] -- [command]

示例

监视当前目录并在文件更改时运行npm test：

bash
docker run --rm -v $(pwd):/watch docker.xuanyuan.run/weaveworks/watch -- npm test

监视src/目录并在更改时执行make build：

bash
docker run --rm -v $(pwd):/watch docker.xuanyuan.run/weaveworks/watch -d src -- make build

配置选项

命令行参数

• -d, --directory <path>: 指定要监视的目录，默认为当前目录
• -i, --ignore <pattern>: 添加要忽略的文件模式（可多次使用）
• -p, --poll: 使用轮询而非原生文件系统事件（适用于网络文件系统）
• -t, --interval <ms>: 轮询间隔（毫秒），默认100ms
• -v, --verbose: 启用详细输出
• -h, --help: 显示帮助信息
• --: 分隔符，之后的内容作为要执行的命令

环境变量

目前Watch镜像不使用环境变量进行配置，所有参数均通过命令行传递。

使用示例

前端开发自动构建

bash
docker run --rm -v $(pwd):/watch docker.xuanyuan.run/weaveworks/watch -i "node_modules/*" -- npm run build

后端服务自动重启

bash
docker run --rm -v $(pwd):/watch -p 3000:3000 docker.xuanyuan.run/weaveworks/watch -- node server.js

Docker Compose集成

yaml
version: '3'
services:
  watcher:
    image: docker.xuanyuan.run/weaveworks/watch
    volumes:
      - ./src:/watch/src
    command: -d src -- npm run dev

注意事项

• 确保正确挂载需要监视的目录到容器内的/watch目录或指定的其他路径
• 在使用网络文件系统(NFS)或共享文件夹时，可能需要使用--poll选项
• 对于大型项目，建议使用.watchignore文件排除不需要监视的目录（如node_modules、.git等）
• 容器内的文件权限可能需要调整以确保Watch可以访问和监视文件

相关资源

• https://github.com/weaveworks/Watch
• https://github.com/weaveworks/Watch/blob/master/README.md