logo

Function watchexec::ignore::from_environment

source · [−]
pub async fn from_environment() -> (Vec<IgnoreFile>, Vec<Error>)
Expand description

Finds all ignore files that apply to the current runtime.

This considers:

  • User-specific git ignore files (e.g. ~/.gitignore)
  • Git configurable ignore files (e.g. with core.excludesFile in system or user config)
  • $XDG_CONFIG_HOME/watchexec/ignore, as well as other locations (APPDATA on Windows…)
  • Files from the WATCHEXEC_IGNORE_FILES environment variable (separated the same was as PATH)

All errors (permissions, etc) are collected and returned alongside the ignore files: you may want to show them to the user while still using whatever ignores were successfully found. Errors from files not being found are silently ignored (the files are just not returned).