开源项目 `listen` 使用教程

开源项目 listen 使用教程

listenThe Listen gem listens to file modifications and notifies you about the changes.项目地址:https://gitcode.com/gh_mirrors/li/listen

1. 项目的目录结构及介绍

listen 项目的目录结构如下：

listen/
├── bin/
│   └── listen
├── lib/
│   └── listen
│       ├── adapter/
│       ├── event/
│       ├── fsevent/
│       ├──inotify/
│       ├── polling/
│       └── windows/
├── test/
│   ├── event/
│   ├── fsevent/
│   ├── inotify/
│   ├── polling/
│   └── windows/
├── Gemfile
├── Gemfile.lock
├── listen.gemspec
├── Rakefile
└── README.md

目录结构介绍

• bin/：包含可执行文件 listen。
• lib/：包含项目的核心代码，分为多个子目录，如 adapter、event、fsevent、inotify、polling 和 windows。
• test/：包含项目的测试代码，与 lib/ 中的目录结构相对应。
• Gemfile 和 Gemfile.lock：用于管理项目的依赖。
• listen.gemspec：项目的 gemspec 文件，用于定义 gem 的元数据。
• Rakefile：用于定义项目的任务。
• README.md：项目的说明文档。

2. 项目的启动文件介绍

项目的启动文件位于 bin/ 目录下，名为 listen。这个文件是项目的可执行文件，用于启动监听服务。

启动文件内容概览

#!/usr/bin/env ruby

require 'listen'

listener = Listen.to('dir_to_watch') do |modified, added, removed|
  puts "modified absolute path: #{modified}"
  puts "added absolute path: #{added}"
  puts "removed absolute path: #{removed}"
end

listener.start
sleep

启动文件介绍

• require 'listen'：引入 listen 库。
• Listen.to('dir_to_watch')：指定要监听的目录。
• do |modified, added, removed|：定义回调函数，当目录中的文件发生变化时，会执行这个回调函数。
• listener.start：启动监听服务。
• sleep：保持程序运行，以便持续监听。

3. 项目的配置文件介绍

listen 项目没有显式的配置文件，其配置主要通过代码中的参数和选项进行。例如，在启动文件中，可以通过传递参数来配置监听的目录、忽略的文件等。

配置示例

listener = Listen.to('dir_to_watch', ignore: /\.tmp$/, latency: 0.5) do |modified, added, removed|
  puts "modified absolute path: #{modified}"
  puts "added absolute path: #{added}"
  puts "removed absolute path: #{removed}"
end

配置选项介绍

• ignore: /\.tmp$/：忽略所有以 .tmp 结尾的文件。
• latency: 0.5：设置监听的延迟时间为 0.5 秒。

通过这些选项，可以灵活地配置 listen 项目的监听行为。

listenThe Listen gem listens to file modifications and notifies you about the changes.项目地址:https://gitcode.com/gh_mirrors/li/listen