docs: add **Debugging ts-jest** section (#2277)

kulshekhar · Jan 15, 2021 · d80be39 · d80be39
1 parent 067b653
commit d80be39
Show file tree

Hide file tree

Showing 9 changed files with 33 additions and 0 deletions.
diff --git a/website/docs/babel7-or-ts.md b/website/docs/babel7-or-ts.md
@@ -1,4 +1,5 @@
 ---
+id: babel7-or-ts
 title: Babel7 or TypeScript
 ---
 

diff --git a/website/docs/debugging.md b/website/docs/debugging.md
@@ -0,0 +1,22 @@
+---
+id: debugging
+title: Debugging ts-jest
+---
+
+You can activate the debug logger by setting the environment variable `TS_JEST_LOG` before running tests.
+The output of the logger will be in **ts-jest.log** in current working directory.
+
+The debug logger contains some useful information about how internal `ts-jest` works, including which files are processed,
+which Jest config or TypeScript config is used etc.
+
+**Linux/MacOS**
+
+```
+export TS_JEST_LOG=ts-jest.log
+```
+
+**Windows**
+
+```
+set TS_JEST_LOG=ts-jest.log
+```
diff --git a/website/docs/e2e-testing.md b/website/docs/e2e-testing.md
@@ -1,4 +1,5 @@
 ---
+id: e2e-testing
 title: E2E tests flow
 ---
 

diff --git a/website/docs/esm-support.md b/website/docs/esm-support.md
@@ -1,4 +1,5 @@
 ---
+id: esm-support
 title: ESM Support
 ---
 

diff --git a/website/docs/installation.md b/website/docs/installation.md
@@ -1,4 +1,5 @@
 ---
+id: installation
 title: Installation
 ---
 

diff --git a/website/docs/processing.md b/website/docs/processing.md
@@ -1,4 +1,5 @@
 ---
+id: processing
 title: Jest flow
 ---
 

diff --git a/website/docs/react-native.md b/website/docs/react-native.md
@@ -1,4 +1,5 @@
 ---
+id: react-native
 title: Using with React Native
 ---
 

diff --git a/website/docs/test-helpers.md b/website/docs/test-helpers.md
@@ -1,4 +1,5 @@
 ---
+id: test-helpers
 title: Test helpers
 ---
 

diff --git a/website/sidebars.js b/website/sidebars.js
@@ -22,6 +22,10 @@ module.exports = {
       type: 'doc',
       id: 'migration',
     },
+    {
+      type: 'doc',
+      id: 'debugging',
+    },
     {
       type: 'category',
       label: 'How it works',