From 827dbcd292abeff9320da46b231570b25253fc3d Mon Sep 17 00:00:00 2001 From: StringEpsilon Date: Thu, 23 Jan 2020 19:42:55 +0100 Subject: [PATCH] docs: Warn about node-notifier caveat on windows systems. fixes #9452 --- CHANGELOG.md | 1 + docs/Configuration.md | 2 ++ website/versioned_docs/version-25.1/CLI.md | 2 ++ 3 files changed, 5 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index db1c8cb3a2f4..13c4e6debbd6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,6 +9,7 @@ ### Chore & Maintenance - `[website]` Update pictures of reports when matchers fail ([#9214](https://github.com/facebook/jest/pull/9214)) +- `[docs]` Warn about unexpected behavior / bug of node-notifier when using the `notify` options. ### Performance diff --git a/docs/Configuration.md b/docs/Configuration.md index 75791757fc6c..b2a1251c8567 100644 --- a/docs/Configuration.md +++ b/docs/Configuration.md @@ -506,6 +506,8 @@ Default: `false` Activates notifications for test results. +**Beware:** Jest uses [node-notifier](https://github.com/mikaelbr/node-notifier) to display desktop notifications. On Windows, it creates a new start menu entry on the first use and not display the notification. Notifications will be properly displayed on subsequent runs + ### `notifyMode` [string] Default: `failure-change` diff --git a/website/versioned_docs/version-25.1/CLI.md b/website/versioned_docs/version-25.1/CLI.md index 4e2d93ef826a..731f4b81b1f2 100644 --- a/website/versioned_docs/version-25.1/CLI.md +++ b/website/versioned_docs/version-25.1/CLI.md @@ -237,6 +237,8 @@ Disables stack trace in test results output. Activates notifications for test results. Good for when you don't want your consciousness to be able to focus on anything except JavaScript testing. +**Beware:** Jest uses [node-notifier](https://github.com/mikaelbr/node-notifier) to display desktop notifications. On Windows, it creates a new start menu entry on the first use and not display the notification. Notifications will be properly displayed on subsequent runs + ### `--onlyChanged` Alias: `-o`. Attempts to identify which tests to run based on which files have changed in the current repository. Only works if you're running tests in a git/hg repository at the moment and requires a static dependency graph (ie. no dynamic requires).