Skip to content

Commit 62b459d

Browse files
Damian SznajderDanielMSchmidt
Damian Sznajder
authored andcommitted
Add note in GettingStarted for Jest docs
1 parent 0a4e0d3 commit 62b459d

File tree

1 file changed

+13
-11
lines changed

1 file changed

+13
-11
lines changed

docs/Introduction.GettingStarted.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -30,16 +30,16 @@ Homebrew is a package manager for macOS, we'll need it to install other command
3030
#### 2. Install [Node.js](https://nodejs.org/en/)
3131

3232
Node is the JavaScript runtime Detox will run on. **Install Node 7.6.0 or above for native async-await support**
33-
33+
3434
```sh
35-
brew update && brew install node
35+
brew update && brew install node
3636
```
3737

3838
> TIP: Verify it works by typing in terminal `node -v` to output current node version, should be higher than 7.6.0
39-
39+
4040
#### 3. Install [appleSimUtils](https://github.com/wix/AppleSimulatorUtils)
41-
42-
A collection of utils for Apple simulators, Detox uses it communicate with the simulator.
41+
42+
A collection of utils for Apple simulators, Detox uses it communicate with the simulator.
4343

4444
```sh
4545
brew tap wix/brew
@@ -71,16 +71,18 @@ npm install detox --save-dev
7171

7272
#### 2. Install mocha
7373

74-
You can use any JavaScript test runner, [Mocha](https://mochajs.org/) is a good one we recommend:
74+
You can use any JavaScript test runner
75+
- [Jest](Guide.Jest.md)
76+
- [Mocha](https://mochajs.org/) is a good one we recommend:
7577

7678
```sh
7779
npm install mocha --save-dev
78-
```
80+
```
7981

8082
#### 3. Add Detox config to package.json
8183

8284
The basic configuration for Detox should be in your `package.json` file under the `detox` property:
83-
85+
8486
```json
8587
"detox": {
8688
"configurations": {
@@ -90,10 +92,10 @@ The basic configuration for Detox should be in your `package.json` file under th
9092
"type": "ios.simulator",
9193
"name": "iPhone 7"
9294
}
93-
}
95+
}
9496
}
9597
```
96-
98+
9799
In the above configuration example, change `example` to your actual project name. Under the key `"binaryPath"`, `example.app` should be `<your_project_name>.app`. Under the key `"build"`, `example.xcodeproj` should be `<your_project_name>.xcodeproj` and `-scheme example` should be `-scheme <your_project_name>`.
98100

99101
For iOS apps in a workspace (eg: Cocoapods) use `-workspace ios/example.xcworkspace` instead of `-project`.
@@ -143,6 +145,6 @@ Use the Detox command line tools to test your project easily:
143145
detox test
144146
```
145147

146-
That's it. Your first failing Detox test is running!
148+
That's it. Your first failing Detox test is running!
147149

148150
Next, we'll go over usage and how to make this test [actually pass](Introduction.WritingFirstTest.md).

0 commit comments

Comments
 (0)