diff --git a/README.md b/README.md index e8188f4f2882..bc014971c3ad 100644 --- a/README.md +++ b/README.md @@ -102,10 +102,10 @@ Jest can be used in projects that use [webpack](https://webpack.github.io/) to m ### Using TypeScript -To use TypeScript in your tests, install the `ts-jest` package: +To use TypeScript in your tests, install the `ts-jest` package and the types for Jest. ``` -npm install --save-dev ts-jest +npm install --save-dev ts-jest @types/jest ``` then modify your `package.json` so the `jest` section looks something like: diff --git a/docs/MigrationGuide.md b/docs/MigrationGuide.md index 26127a7aabd4..92cdb5db7047 100644 --- a/docs/MigrationGuide.md +++ b/docs/MigrationGuide.md @@ -5,7 +5,7 @@ layout: docs category: Guides permalink: docs/migration-guide.html previous: webpack -next: troubleshooting +next: testing-frameworks --- If you'd like to try out Jest with an existing codebase, there are a number of ways to convert to Jest: diff --git a/docs/TestingFrameworks.md b/docs/TestingFrameworks.md new file mode 100644 index 000000000000..4be354f37b72 --- /dev/null +++ b/docs/TestingFrameworks.md @@ -0,0 +1,31 @@ +--- +id: testing-frameworks +title: Testing other frameworks +layout: docs +category: Guides +permalink: docs/testing-frameworks.html +previous: migration-guide +next: troubleshooting +--- + +Although Jest may be considered React-specific test runner, in fact it is a universal testing platform, with the ability to adapt to any JavaScript library or framework. In this section we'd like to link to community posts and articles about integrating Jest into other popular JS libraries. + +## Vue.js + +* [Jest for all: Episode 1 — Vue.js](https://medium.com/@kentaromiura_the_js_guy/jest-for-all-episode-1-vue-js-d616bccbe186#.d573vrce2) by Cristian Carlesso ([@kentaromiura](https://twitter.com/kentaromiura)) + +## AngularJS + +* [Testing an AngularJS app with Jest](https://medium.com/aya-experience/testing-an-angularjs-app-with-jest-3029a613251) by Matthieu Lux ([@Swiip](https://twitter.com/Swiip)) + +## Angular + +* [Testing Angular faster with Jest](https://www.xfive.co/blog/testing-angular-faster-jest/) by Michał Pierzchała ([@thymikee](https://twitter.com/thymikee)) + +## MobX + +* [How to Test React and MobX with Jest](https://semaphoreci.com/community/tutorials/how-to-test-react-and-mobx-with-jest) by Will Stern ([@willsterndev](https://twitter.com/willsterndev)) + +## Redux + +* [Writing Tests](http://redux.js.org/docs/recipes/WritingTests.html) by Redux docs diff --git a/docs/Troubleshooting.md b/docs/Troubleshooting.md index 0880dd3ad00a..267b85dbbb24 100644 --- a/docs/Troubleshooting.md +++ b/docs/Troubleshooting.md @@ -4,7 +4,7 @@ title: Troubleshooting layout: docs category: Guides permalink: docs/troubleshooting.html -previous: migration-guide +previous: testing-frameworks --- Uh oh, something went wrong? Use this guide to resolve issues with Jest.