From 3844b55fee1ffb596096ebd906aa89f147255256 Mon Sep 17 00:00:00 2001 From: Jonathan Soifer Date: Wed, 4 Jul 2018 17:42:45 +0200 Subject: [PATCH] Add reference to in setupTestFrameworkScriptFile docs (#6615) --- docs/Configuration.md | 2 ++ website/versioned_docs/version-23.0/Configuration.md | 2 ++ 2 files changed, 4 insertions(+) diff --git a/docs/Configuration.md b/docs/Configuration.md index 08fcd491e419..ad0f522aa56f 100644 --- a/docs/Configuration.md +++ b/docs/Configuration.md @@ -612,6 +612,8 @@ Default: `undefined` The path to a module that runs some code to configure or set up the testing framework before each test. Since [`setupFiles`](#setupfiles-array) executes before the test framework is installed in the environment, this script file presents you the opportunity of running some code immediately after the test framework has been installed in the environment. +If you want this path to be [relative to the root directory of your project](#rootdir-string), please include `` inside the path string, like `"/a-configs-folder"`. + For example, Jest ships with several plug-ins to `jasmine` that work by monkey-patching the jasmine API. If you wanted to add even more jasmine plugins to the mix (or if you wanted some custom, project-wide matchers for example), you could do so in this module. ### `snapshotSerializers` [array] diff --git a/website/versioned_docs/version-23.0/Configuration.md b/website/versioned_docs/version-23.0/Configuration.md index 0ebcc6db9293..7316927af602 100644 --- a/website/versioned_docs/version-23.0/Configuration.md +++ b/website/versioned_docs/version-23.0/Configuration.md @@ -601,6 +601,8 @@ Default: `undefined` The path to a module that runs some code to configure or set up the testing framework before each test. Since [`setupFiles`](#setupfiles-array) executes before the test framework is installed in the environment, this script file presents you the opportunity of running some code immediately after the test framework has been installed in the environment. +If you want this path to be [relative to the root directory of your project](#rootdir-string), please include `` inside the path string, like `"/a-configs-folder"`. + For example, Jest ships with several plug-ins to `jasmine` that work by monkey-patching the jasmine API. If you wanted to add even more jasmine plugins to the mix (or if you wanted some custom, project-wide matchers for example), you could do so in this module. ### `snapshotSerializers` [array]