enhance doc for v6 (#1066)

Author: connectdotz

README.md

@@ -63,6 +63,7 @@ Content
         - [monitorLongRun](#monitorlongrun)
         - [autoRevealOutput](#autorevealoutput)
         - [parserPluginOptions](#parserpluginoptions)
+        - [useDashedArgs](#usedashedargs)
         - [virtualFolders](#virtualfolders)
     - [Debug Config](#debug-config)
       - [Debug Config v2](#debug-config-v2)
@@ -252,19 +253,19 @@ Users can use the following settings to tailor the extension for their environme
 - settings marked with 💼 apply to the whole project, otherwise per workspace.
 
 
-|setting|description|default|example/notes|
-|---|---|---|---|
+|setting|description|default|example/notes|available since|
+|---|---|---|---|---|
 |**Process**|
-|enable|Enable/disable jest extension for the given workspace folder/virtual-folder|true|`"jest.enable": false`|
+|enable|Enable/disable jest extension for the given workspace folder/virtual-folder|true|`"jest.enable": false`| >= v6.0.0|
 |[jestCommandLine](#jestcommandline)|The command line to start jest tests|undefined|`"jest.jestCommandLine": "npm test --"` or `"jest.jestCommandLine": "yarn test"` or `"jest.jestCommandLine": "node_modules/.bin/jest --config custom-config.js"`|
 |nodeEnv|Add additional env variables to spawned jest process|null|`"jest.nodeEnv": {"PORT": "9800", "BAR":"true"}` |
-|[shell](#shell)|shell (path or LoginShell) for executing jest|null|`"jest.shell": "/bin/bash"` or `"jest.shell": "powershell"` or `"jest.shell": {"path": "/bin/bash"; args: ["--login"]}`  |
-|[autoRun](#autorun)|Controls when and what tests should be run|undefined|`"jest.autoRun": "off"` or `"jest.autoRun": "watch"` or `"jest.autoRun": {"watch": false, "onSave":"test-only"}`|
-|[rootPath](#rootPath)|The path to your frontend src folder|""|`"jest.rootPath":"packages/app"` or `"jest.rootPath":"/apps/my-app"`|
-useDashedArgs| Determine if to use dashed arguments for jest processes |undefined|`"jest.useDashedArgs":true`|
-|[monitorLongRun](#monitorlongrun)| monitor long running tests based on given threshold in ms|60000|`"jest.monitorLongRun": 120000`|
-|[parserPluginOptions](#parserpluginoptions)|Configure babel parser plugins|null|`"jest.parserPluginOptions": {decorators: 'legacy'}`|
-|[virtualFolders](#virtual-folders)|defines multiple jest runs in a given vscode workspace folder|undefined|`"jest.virtualFolders": "[{"name": "front-end", "rootPath': "packages/front-end"}, {"name": "back-end", "rootPath': "packages/back-end"} ]"`|
+|[shell](#shell)|shell (path or LoginShell) for executing jest|null|`"jest.shell": "/bin/bash"` or `"jest.shell": "powershell"` or `"jest.shell": {"path": "/bin/bash"; args: ["--login"]}`  ||
+|[autoRun](#autorun)|Controls when and what tests should be run|undefined|`"jest.autoRun": "off"` or `"jest.autoRun": "watch"` or `"jest.autoRun": {"watch": false, "onSave":"test-only"}`||
+|[rootPath](#rootPath)|The path to your frontend src folder|""|`"jest.rootPath":"packages/app"` or `"jest.rootPath":"/apps/my-app"`||
+[useDashedArgs](#usedashedargs)| Determine if to use dashed arguments for jest processes |undefined|`"jest.useDashedArgs":true`| >= v6.0.0 |
+|[monitorLongRun](#monitorlongrun)| monitor long running tests based on given threshold in ms|60000|`"jest.monitorLongRun": 120000`||
+|[parserPluginOptions](#parserpluginoptions)|Configure babel parser plugins|null|`"jest.parserPluginOptions": {decorators: 'legacy'}`||
+|[virtualFolders](#virtual-folders)|defines multiple jest runs in a given vscode workspace folder|undefined|`"jest.virtualFolders": "[{"name": "front-end", "rootPath': "packages/front-end"}, {"name": "back-end", "rootPath': "packages/back-end"} ]"`| >= v6.0.0|
 |**Editor**|
 |[testExplorer](#testexplorer) |Configure jest test explorer|null|`{"showInlineError": "true"}`|
 |**Coverage**|
@@ -275,7 +276,7 @@ useDashedArgs| Determine if to use dashed arguments for jest processes |undefine
 |debugMode|Enable debug mode to diagnose plugin issues. (see developer console)|false|`"jest.debugMode": true`|
 |disabledWorkspaceFolders 💼|Disabled workspace folders names in multi-root environment|[]|`"jest.disabledWorkspaceFolders": ["package-a", "package-b"]`|
 |[autoRevealOutput](#autoRevealOutput)|Determine when to show test output|"on-run"|`"jest.autoRevealOutput": "on-exec-error"`|
-|autoClearTerminal|Clear the terminal output at the start of any new test run.|false|`"jest.autoClearTerminal": true`|
+|autoClearTerminal|Clear the terminal output at the start of any new test run.|false|`"jest.autoClearTerminal": true`| >= v6.0.0 |
 
 #### Details
 ##### jestCommandLine
@@ -469,6 +470,14 @@ This extension uses babel to parse the test files. For decorators [plugin option
 
 "jest.parserPluginOptions": {"decorators": {"decoratorsBeforeExport": false}}
 ```
+
+##### useDashedArgs
+If true, use dashed arguments for spawned jest processes.
+
+Please bear in mind that you might encounter compatibility issue with other tools/systems. For instance, we've identified an issue in react-script where `"watch-all"=false` (an argument the extension appended) isn't recognized (see [facebook/react-script#12801](https://github.com/facebook/create-react-app/issues/12801) for more details). Please report them if you encounter any.
+
+Also note this flag does not apply to debug config, which can be changed manually since the [debug config v2](#debug-config-v2) was introduced a while back. 
+
 ##### virtualFolders
 
 Much like a vscode workspace folder, which manages a runtime environment for a specific folder, a virtualFolder manages a custom Jest runtime environment. Each virtualFolder can have its own resource-level [settings](#settings), such as `jestCommandLine` and `rootPath`.
@@ -531,6 +540,7 @@ However, there are some key differences between virtual folders and multi-root w
 5. virtualFolders only contains jest settings. If your project require non-jest settings from the package's own `.vscode/settings.json` (like in a multi-root workspace), then you are probably better off continue with multi-root workspace.
 
 
+
 ### Debug Config
 
 This extension looks for jest specific debug config (`"vscode-jest-tests.[folder-name]"` or `"vscode-jest-tests.v2.[folder-name]"`) in the following order:

release-notes/release-note-v6.md

@@ -21,7 +21,7 @@ This major release introduces the 'Virtual Folders' feature. Much like a VSCode
 ### Main Features
 #### 1. Virtual Folders 
 
-Supporting multiple jest configs is a common use cases for monorepo projects and projects with multiple test environments, such as unit and integration tests. We introduced monorepo support with vscode multi-root workspaces a few years ago. While it works well for most use cases, it fell short for multi-test-environment that share the same code base (folder). This version will close this gap with the [Virtual Folders](README.md#virtualfolders).
+Supporting multiple jest configs is a common use cases for monorepo projects and projects with multiple test environments, such as unit and integration tests. We introduced monorepo support with vscode multi-root workspaces a few years ago. While it works well for most use cases, it fell short for multi-test-environment that share the same code base (folder). This version will close this gap with the [Virtual Folders](https://github.com/jest-community/vscode-jest#virtualfolders).
 
 For example, the unit vs. integration tests can now be set up as the following:
 ```json
@@ -53,7 +53,7 @@ And yes you can indeed use virtual folders with monorepo projects. For example,
 }
 ```
 
-So when to use multi-root workspaces vs. virtual folders? In short, if you created a multi-root workspace simply for running different jest config - you could probably just use `"jest.virtualFolders"` instead. If you do require different non-jest vscode settings for each folder, continue to use multi-root workspace. More details in [Virtual Folders](README.md#virtualfolders).
+So when to use multi-root workspaces vs. virtual folders? In short, if you created a multi-root workspace simply for running different jest config - you could probably just use `"jest.virtualFolders"` instead. If you do require different non-jest vscode settings for each folder, continue to use multi-root workspace. More details in [Virtual Folders](https://github.com/jest-community/vscode-jest#virtualfolders).
 
 
 - [#1035](https://github.com/jest-community/vscode-jest/pull/1035) - @connectdotz
@@ -64,7 +64,7 @@ In light of Angular's decision to drop support for CamelCase arguments, we've be
 
 However, bear in mind that you might encounter compatibility issue with other tools/systems. For instance, we've identified an issue in react-script where `"watch-all"=false` (an argument the extension appended) isn't recognized (see facebook/react-script#12801 for more details). Please report them if you encounter any.
 
-See [Customization](README.md#customization) for more details.
+See [useDashedArgs](https://github.com/jest-community/vscode-jest#usedashedargs) for more details.
 
 
 <!-- cSpell:ignore mjamin -->
@@ -76,15 +76,15 @@ A new setting`"jest.enable"` is added as a quick way to turn off the extension f
 
 This is indeed similar to `"jest.disabledWorkspaceFolders"`, which is a "window" level setting (on the root of the workspace). Given the target is the folder itself, we believe it makes more sense to put the control `"jest.enable"` in folder level instead. It could also provide better extensibility down the road, such as "deferred-activation". We hope `"jest.enable"` will eventually replace `"jest.disabledWorkspaceFolders"`.
 
-See [Customization](README.md#customization) for more details.
+See [Customization](https://github.com/jest-community/vscode-jest#customization) for more details.
 
 - [#1009](https://github.com/jest-community/vscode-jest/pull/1009) - @connectdotz
 
 #### 4. Auto clear output upon test run
 
 Introduced a new setting - `"jest.autoClearOutput"` - to clear the output terminal before each test run. Default is false for backward compatibility. This is useful when you want to see only the last run output. 
 
-See [Customization](README.md#customization) for more details.
+See [Customization](https://github.com/jest-community/vscode-jest#customization) for more details.
 
 <!-- cSpell:ignore jgillick -->
 - [#1014](https://github.com/jest-community/vscode-jest/pull/1014) - @jgillick