Directory Watcher

디렉토리 내 변경 (생성, 수정, 삭제)이 발생 시 정해진 커맨드를 실행하게 하는 프로그램입니다. 이 도구를 사용하면 파일 시스템의 변경 사항에 대해 실시간으로 반응하고, 이러한 변경 사항에 따라 특정 작업을 자동화할 수 있습니다. 예를 들어, 특정 디렉토리에서 파일이 변경되면 자동으로 백업을 만들거나, 코드가 변경되면 테스트를 실행하는 등의 작업을 설정할 수 있습니다.

기능 및 특징

• 여러개의 디렉토리 감시 가능
• 각 디렉토리 별 변경 발생 시 실행되는 커맨드 개별 설정 가능
• 공통적으로 실행되어야 하는 커맨드 설정, 감시 시작 및 감시 종료 시 실행되어야 하는 커맨드 설정 가능
• 감시 대상 디렉토리 내 감시 제외 디렉토리 추가 가능
• 감시 대상 디렉토리 내 감시 제외 접미사 추가 가능

설치

Homebrew

$ brew install seungyeop-lee/tap/directory-watcher

go install

$ go install github.com/seungyeop-lee/directory-watcher/v2@latest

Releases

releases page에서 실행파일을 다운로드

사용법

다음의 커맨드를 통해 directory-watcher를 실행할 수 있습니다.

$ directory-watcher

이 커맨드는 다음과 같은 옵션을 제공합니다.

Usage:
  directory-watcher [flags]

Flags:
  -c, --config-path string   set config path (default "config.yml")
  -h, --help                 help for directory-watcher
  -l, --log-level string     set log level (default "ERROR")
  -v, --version              version for directory-watcher

config.yml

실제 파일은 config.example.yml 예제 참조. config.yml 파일은 감시할 디렉토리와 각 디렉토리에서 발생하는 변경에 대해 실행할 커맨드를 정의합니다. 또한, 감시를 시작하거나 종료할 때 실행할 커맨드를 정의할 수도 있습니다.

global:
  lifeCycle:
    onStartWatch: # global onStartWatch hook
      - '실행 커맨드'
      - dir: '실행 커맨드가 실행 될 디렉토리경로'
        cmd: '실행 커맨드'
      - dir: '실행 커맨드가 실행 될 디렉토리경로'
        cmd:
          - '실행 커맨드 1'
          - '실행 커맨드 2'
    onBeforeChange: # global onBeforeChange hook
      [ global onStartWatch hook의 사양과 동일 ]
    onAfterChange: # global onAfterChange hook
      [ global onStartWatch hook의 사양과 동일 ]
    onFinishWatch: # global onFinishWatch hook
      [ global onStartWatch hook의 사양과 동일 ]
watchTargets:
  - path: [ 감시대상 폴더 path ]
    lifeCycle:
      onStartWatch: # onStartWatch hook
        [ global onStartWatch hook의 사양과 동일 ]
      onChange: # onChange hook
        [ global onStartWatch hook의 사양과 동일 ]
      onFinishWatch: # onFinishWatch hook
        [ global onStartWatch hook의 사양과 동일 ]
    option:
      excludeDir:
        - [ 감시 제외대상 폴더 path ]
      excludeSuffix:
        - [ 감시 제외대상 파일 접미사 ]
      waitMillisecond: [ 이벤트 발생 후, hook을 실행하는 사이 대기시간, default는 100 ]
      watchSubDir: [ 하위 디렉토리 감시 여부, default는 true ]

cmd 실행 위치

다음은 각 hook에 대한 커맨드 실행 위치를 설명합니다.

dir	global onStartWatch, global onFinishWatch	그외 hook
O	dir 설정 위치	dir 설정 위치
X	프로그램 실행 위치	path 설정 위치

동작 다이어그램

다음 다이어그램은 Directory Watcher가 어떻게 동작하는지를 보여줍니다.

라이센스

이 프로젝트는 GPL-3.0 라이센스 하에 제공됩니다. 자세한 내용은 라이센스 파일을 참조해주세요.