Триггеры

file-watch

Реагирует на изменения файлов и каталогов.

Конфигурация триггера file-watch, соответствует конфигурации триггера и отличается только типом и опциями.

{
  "type": "file-watch",
  "options": {
    // опции триггера
  }
}

Свойства опций

Наименование	Тип	Обязательное
watch	WatchConfig | WatchConfig[]	Да

Описание свойств

watch

Тип: WatchConfig | WatchConfig[]

Обязательное: Да

Конфигурация отслеживания файлов. Может быть одним объектом или массивом объектов для отслеживания нескольких путей с разными настройками.

Пример (один объект):

{
  "watch": {
    "path": "./src",
    "events": ["change", "add"]
  }
}

Пример (массив объектов):

{
  "watch": [
    {
      "path": "./src",
      "events": ["change"]
    },
    {
      "path": ["./config", "./scripts"],
      "events": ["add", "unlink"]
    }
  ]
}

Типы

WatchConfig

Конфигурация для отслеживания файлов и каталогов.

Свойства WatchConfig

Наименование	Тип	Обязательное
path	string | string[]	Да
events	FileWatchEvent[]	Нет
ignored	string | string[]	Нет

Описание свойств WatchConfig

path

Тип: string | string[]

Обязательное: Да

Путь или массив путей к файлам/каталогам для отслеживания.

Пример (строка):

{
  "path": "./src"
}

Пример (массив):

{
  "path": ["./src", "./config", "./scripts"]
}

events

Тип: FileWatchEvent[]

Обязательное: Нет

Массив событий файловой системы, на которые должен реагировать триггер.

Пример:

{
  "events": ["change", "add"]
}

ignored

Тип: string | string[]

Обязательное: Нет

Glob-паттерн или массив glob-паттернов для определения файлов/каталогов, которые следует игнорировать.

Примеры

Игнорировать файлы с расширением .log непосредственно в каталоге отслеживания:

{
  "ignored": "*.log"
}

Игнорировать файлы с расширением .log в каталоге отслеживаия и подкаталогах:

{
  "ignored": ["**/*.log"]
}

Игнорировать все файлы, кроме файлов с расширениями .log и .txt непосредственно в каталоге отслеживания:

{
  "ignored": ["!*.{log,txt}"]
}

FileWatchEvent

Тип события файловой системы.

Тип: string

Допустимые значения:

Значение	Описание
add	Файл был добавлен
addDir	Каталог был добавлен
change	Файл был изменен
unlink	Файл был удален
unlinkDir	Каталог был удален

Пример:

{
  "events": ["add", "change", "unlink"]
}