watchexec

• #99 #185 #171 Experimental: new spinoff crate clearscreen which is a comprehensive terminal/console screen clearing library. Eventually this will be used here, for now it needs a little time to settle and get properly tested around a bunch of terminals and setups (and you can help!). However, its API is stable and it is fully documented, so please consider it for new projects!
• New: a cute logo for the project! 🐚🦀 This is used in the repo metadata and the API documentation. For now!
• On Windows, the application manifest has been added to, which opts us into a few modern settings, adds some metadata, and declares compatibility to Windows 8, 8.1, and 10.

• #168 Decreasing debounce interval further to 150ms.
• #181 Fix --shell to support (very simply) options passed to the shell.
• #189 Fix algorithm to find the root of a git repo.
• Manpage is built in HTML as well as Roff and included in releases (more useful than roff on windows).
• Notify updated to latest patch in lockfile.
• #82 Command/arguments processing is documented clearly in the manpage.

• CI and releases switch from Travis to Github Actions.
• #178 Add arm-unknown-linux-gnueabihf and aarch64-unknown-linux-gnu builds.
• #180 Add --changes-only option to print what changes (for debugging purposes, not for consuming).
• Add --shell=SHELL and deprecate --no-shell.
• The above allows to use powershell instead of cmd (--shell=powershell), which solves #80. On Windows, powershell will become the CLI default in v2.0, and is the new default right now in the library.
• Undocument --kill from the man page, help, and completion. It will be removed in v2.0.
• In the library, Args is renamed to Config and the old name deprecated.
• In the library, get_args is deprecated in the view to be removed at some point (and only exist in the CLI).
• In the builder, durations are now Durations instead of integers of milliseconds.
• In the builder, restart and watch_when_idle are deprecated and replaced with on_busy_update which clarifies the behaviour when receiving updates while a command is running.
• Add --on-busy-update= option to expose that builder option.
• Deprecate --watch-when-idle (ref #123) in favour of --on-busy-update=do-nothing.
• Add binstall metadata.
• Add DEB packages for every linux build.
• Increase MSRV to 1.43.0.

• fdb0cfb Soft-deprecate (in documentation only) Args.debug as it's not used any more.
• #163 Add a manifest on Windows to transparently opt-in to long path support when supported. This is a cli change only and is not present in downstream executables (see associated commits for how to do it for your application).
• #165 Fix help text and documentation to mention that -w can be used to watch files as well as folders.
• #168 Drop default debounce time to 300ms. This is an experiment to gain testing on a lower value! Please report any issues. If it goes well the default will be dropped again later on.

• #157 Error and exit gracefully when the subprocess's environment would be too large (as a result of too many changes being added to the WATCHEXEC_* environment variables instead of throwing a cryptic message ("Argument list too long")
• #157 Add --no-environment to disable the WATCHEXEC_* variables being set, to avoid the above situation completely.
• #157 Add --no-meta to disable only "metadata" events from being reported as above, which mitigates the above situation.
• #160 ⚠️ Stop initialising the logger in the library code. Downstream users will need to initialise their own logger if they want debug/warn output. As a reminder, the library API is not considered in semver here, and downstream users are encouraged to specify exact versions: watchexec = "=1.14.0".

• passcod/cargo-watch#149: if watched directory didn't contain a .git folder, thread would block (infinite loop)

• #147: .gitignore files are now looked at in children as well as parents, the latter being very much not what should happen, but I'm kinda stuck with it at the moment to avoid breaking behaviour, eeech
• #150: clarity around time units in the interface
• Deps: notify (patch), globset (patch), clap (patch), nix (major: 0.15 → 0.17)

• #142: Change ignore globbing to behave as the readme documents: -i foo now matches the foo folder and descendants, instead of having to specify -i foo/**
• #141, #123: Introduce a --watch-when-idle option that ignores events emitted while the command is running. This may help ignore changes made by the command itself (#40), though it of course also ignores all other changes during that time.

• Revert a change that made a type borrowed instead of the more sane (and more flexible) owned

• Support for .ignore files (#127)
• zsh completions in tree and releases (#130)
• Semver policy for library written down (#135)
• A new builder for Args (#135)
• More flexible Handler trait (#133)
• Rust Edition 2018
• MSRV bumped to 1.38
• Builds done with --locked for reproducibility (#131)
• Windows builds moved to Travis
• MSVC release builds are back
• Linux and macOS builds use xz compression
• Lots of lints enabled
• Some typos fixed (#128, #129)

• The man page was brought up-to-date to new options and a hint to use -- (#125)

• Always canonicalise paths, fixing a bug where some ignores would sometimes fail to apply (#113)
• Some dependency updates (#115, #116, 7ed5ea577793d44be574031ba8a408acba8b0699)
• Crate is somewhat smaller (#117)

• Fix crash on some error conditions. (#111)
• Clear the screen on initial run again (4918b12)

New API features

The API now enables:

• parsing a command line string into watchexec Args
• writing one's own handler to react to changes
• a lot more errors to be caught instead of panicking

This also has creates two minor breaking changes:

• Args's paths field is now a Vec<PathBuf> rather than a Vec<String>
• cli::get_args() returns a Result rather than nothing

This was done in #105, prompted by #104 and #103.

Clap update

This formalises the fix to #76.

Support commands that allocate their own TTY

Through setsid, thanks to @Mange (#102).

Fixes #47 and some other issues downstream.

An attempt to fix some issues clearing screens under some Windows configurations

These are hard to guess at / repro. Maybe it helped #99.

Dependency upgrades

• Notify 4.0.7 brings in some fixes, notably a performance/battery-saving optimisation on Linux.
• Regex 1.1.0 brings in some performance improvements for (git)ignore patterns

Some progress towards manual restarts

As part of the API changes, file-triggered runs and manual runs are now explicitly differentiated, which will help when eventually implementing #67.

My bad. My changes related to whitespace handling completely broke several use cases, e.g.:

• watchexec -- 'echo foo; echo bar'

See discussion on #82.

This release reverts (comments out) those parts, but keeps everything else.

• #74 — Watchexec no longer panics on missing folders — patch1, 2
• #95 — Fix issues with whitespace in commands — patch2
• #96 — Add install instructions for Arch Linux — docs
• Create a Debian package on release — releng
• Add install instructions for Debian — docs

1: Other changes were added following this to convert more panics into normal errors: some glob parsing errors, and file watcher initialisation errors.

2: These changes also cause a breaking changes to the library interface, but this is not considered in the version numbers (i.e. if you use it, pin it). From cursory investigation only cargo-watch is a consumer and changes there in consequence are coordinated.

First release by @passcod! This release is merging in a variety of long-waiting improvements, but is otherwise fairly conservative.

• #77 — Better default ignore patterns for Python, Emacs, and Vim — patch
• #89 — On Linux, statically-compiled musl builds are now provided — releng
• #90 — WATCHEXEC_*_PATH environment variables are now accurately documented — docs
• #91 — On Windows, watchexec can now be installed using scoop.sh — docs
• #92 — Support OpenBSD 6.3+ — patch
• #93 — On Linux, fallback to polling if inotify limit is reached — minor