Skip to content

Commit df71945

Browse files
committedJul 29, 2018
doc: adds troubleshooting wiki page links
1 parent fb5cd12 commit df71945

File tree

4 files changed

+27
-35
lines changed

4 files changed

+27
-35
lines changed
 

‎.github/ISSUE_TEMPLATE

-24
This file was deleted.

‎.github/ISSUE_TEMPLATE.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
<!-- First of all, check the troubleshooting wiki page for common issues at:
2+
https://github.com/kulshekhar/ts-jest/wiki/Troubleshooting -->
3+
4+
## Issue <!-- describe the issue below -->:
5+
6+
7+
## Expected behavior <!-- describe the expected behavior below -->:
8+
9+
10+
## Output from debug log <!-- You can activate the debug logger by setting the environment variable TS_JEST_DEBUG="true" before running yarn test. The output of the logger will be in **<your_project_dir>/node_modules/ts-jest/debug.txt**, paste it below -->:
11+
```bash
12+
# content of debug.txt :
13+
14+
```
15+
16+
17+
## Minimal repo <!-- If you haven't already, create the smallest possible repo that reproduces this issue by running `npm install` and `npm test`. This will speed up any fixes that this issue might need. Paste the minimal repo URL below -->:
18+
19+
20+
<!-- Optional (but highly recommended): Configure Travis (or your favorite system) with the minimal repo. This allows potential solutions to be tested against the minimal repo. This saves everyone time and avoids a lot of back and forth. -->

‎COLLABORATORS.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
11
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
22
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
3-
**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)*
3+
**Table of Contents**
44

55
- [Collaborator Guidelines](#collaborator-guidelines)
66
- [Installing and building the project](#installing-and-building-the-project)
77
- [Merging PRs](#merging-prs)
88
- [Versioning](#versioning)
9+
- [Tests](#tests)
10+
- [How to add tests](#how-to-add-tests)
11+
- [How to run tests](#how-to-run-tests)
912

1013
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
1114

‎README.md

+3-10
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,11 @@
1-
# ts-jest
1+
# ts-jest [![npm version](https://badge.fury.io/js/ts-jest.svg)](https://badge.fury.io/js/ts-jest) [![NPM downloads](https://img.shields.io/npm/dm/ts-jest.svg?style=flat)](https://npmjs.org/package/ts-jest) [![Greenkeeper badge](https://badges.greenkeeper.io/kulshekhar/ts-jest.svg)](https://greenkeeper.io/) [![Build Status for linux](https://travis-ci.org/kulshekhar/ts-jest.svg?branch=master)](https://travis-ci.org/kulshekhar/ts-jest) [![Build Status for Windows](https://ci.appveyor.com/api/projects/status/g8tt9qd7usv0tolb/branch/master?svg=true)](https://ci.appveyor.com/project/kulshekhar/ts-jest/branch/master)
22

3-
[![npm version](https://badge.fury.io/js/ts-jest.svg)](https://badge.fury.io/js/ts-jest)
4-
[![NPM downloads](https://img.shields.io/npm/dm/ts-jest.svg?style=flat)](https://npmjs.org/package/ts-jest)
5-
[![Greenkeeper badge](https://badges.greenkeeper.io/kulshekhar/ts-jest.svg)](https://greenkeeper.io/)
3+
**Important note**: Before reporting any issue, be sure to check the [troubleshooting page](https://github.com/kulshekhar/ts-jest/wiki/Troubleshooting).
64

7-
[![Build Status for linux](https://travis-ci.org/kulshekhar/ts-jest.svg?branch=master)](https://travis-ci.org/kulshekhar/ts-jest)
8-
[![Build Status for Windows](https://ci.appveyor.com/api/projects/status/g8tt9qd7usv0tolb/branch/master?svg=true)](https://ci.appveyor.com/project/kulshekhar/ts-jest/branch/master)
9-
10-
**Important note: When using React 16 with Node version 8, you might see wrong line numbers for errors originating from tsx files. There's [an issue with more details on this](https://github.com/kulshekhar/ts-jest/issues/334)**
115

126
> Note: Looking for collaborators. [Want to help improve ts-jest?](https://github.com/kulshekhar/ts-jest/issues/223)
137
14-
ts-jest is a TypeScript preprocessor with source map support for Jest that lets you use Jest to test projects written in TypeScript.
8+
**ts-jest** is a TypeScript preprocessor with source map support for Jest that lets you use Jest to test projects written in TypeScript.
159

1610
## Table of Contents
1711
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
@@ -383,7 +377,6 @@ By default Jest ignores everything in `node_modules`. This setting prevents Jest
383377
## Known Limitations
384378
### Known limitations for TS compiler options
385379
- You can't use `"target": "ES6"` while using `node v4` in your test environment;
386-
- You can't use `"jsx": "preserve"` for now (see [progress of this issue](https://github.com/kulshekhar/ts-jest/issues/63));
387380
- If you use `"baseUrl": "<path_to_your_sources>"`, you also have to change `jest config` a little bit (also check [Module path mapping](#module-path-mapping) section):
388381
```json
389382
"jest": {

0 commit comments

Comments
 (0)
Please sign in to comment.