prettier

jestjs · SimenB · Jul 13, 2022 · Jul 8, 2022 · Jul 8, 2022 · Jul 8, 2022
commit ba2a62f06d3b800ddaaf2607d2482d2e22375bf9
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -14,7 +14,7 @@
 ### Chore & Maintenance
 
 - `[*]` Replace internal usage of `pretty-format/ConvertAnsi` with `jest-serializer-ansi-escapes` ([#12935](https://github.com/facebook/jest/pull/12935), [#13004](https://github.com/facebook/jest/pull/13004))
-- `[docs]` Update spyOn docs  ([#13000](https://github.com/facebook/jest/pull/13000))
+- `[docs]` Update spyOn docs ([#13000](https://github.com/facebook/jest/pull/13000))
 
 ### Performance
 

diff --git a/docs/JestObjectAPI.md b/docs/JestObjectAPI.md
@@ -482,11 +482,15 @@ Determines if the given function is a mocked function.
 Creates a mock function similar to `jest.fn` but also tracks calls to `object[methodName]`. Returns a Jest [mock function](MockFunctionAPI.md).
 
 :::note
- By default, `jest.spyOn` also calls the **spied** method. This is different behavior from most other test libraries. If you want to overwrite the original function, you can use `jest.spyOn(object, methodName).mockImplementation(() => customImplementation)` or `object[methodName] = jest.fn(() => customImplementation);`
+
+By default, `jest.spyOn` also calls the **spied** method. This is different behavior from most other test libraries. If you want to overwrite the original function, you can use `jest.spyOn(object, methodName).mockImplementation(() => customImplementation)` or `object[methodName] = jest.fn(() => customImplementation);`
+
 :::
 
 :::tip
-Since `jest.spyOn` is a mock.  You could restore the initial state calling [jest.restoreAllMocks](#jestrestoreallmocks) on [afterEach](GlobalAPI.md#aftereachfn-timeout) method. 
+
+Since `jest.spyOn` is a mock. You could restore the initial state calling [jest.restoreAllMocks](#jestrestoreallmocks) on [afterEach](GlobalAPI.md#aftereachfn-timeout) method.
+
 :::
 
 Example:
@@ -516,7 +520,7 @@ test('plays video', () => {
   const isPlaying = video.play();
 
   expect(spy).toHaveBeenCalled();
-  expect(isPlaying).toBe(true);    
+  expect(isPlaying).toBe(true);
 });
 ```
 
@@ -566,15 +570,15 @@ test('plays video', () => {
   const isPlaying = video.play;
 
   expect(spy).toHaveBeenCalled();
-  expect(isPlaying).toBe(true);    
+  expect(isPlaying).toBe(true);
 });
 
 test('plays audio', () => {
   const spy = jest.spyOn(audio, 'volume', 'set'); // we pass 'set'
   audio.volume = 100;
 
   expect(spy).toHaveBeenCalled();
-  expect(audio.volume).toBe(100);    
+  expect(audio.volume).toBe(100);
 });
 ```
 

diff --git a/website/versioned_docs/version-25.x/JestObjectAPI.md b/website/versioned_docs/version-25.x/JestObjectAPI.md
@@ -469,13 +469,18 @@ Determines if the given function is a mocked function.
 
 ### `jest.spyOn(object, methodName)`
 
-Creates a mock function similar to `jest.fn` but also tracks calls to `object[methodName]`. Returns a Jest [mock function](MockFunctionAPI.md).
+Creates a mock function similar to `jest.fn` but also tracks calls to `object[methodName]`. Returns a Jest [mock function](MockFunctionAPI.md). 
+
 :::note
+
 By default, `jest.spyOn` also calls the **spied** method. This is different behavior from most other test libraries. If you want to overwrite the original function, you can use `jest.spyOn(object, methodName).mockImplementation(() => customImplementation)` or `object[methodName] = jest.fn(() => customImplementation);`
+
 :::
 
 :::tip
-Since `jest.spyOn` is a mock.  You could restore the initial state calling [jest.restoreAllMocks](#jestrestoreallmocks) on [afterEach](GlobalAPI.md#aftereachfn-timeout) method. 
+
+Since `jest.spyOn` is a mock. You could restore the initial state calling [jest.restoreAllMocks](#jestrestoreallmocks) on [afterEach](GlobalAPI.md#aftereachfn-timeout) method.
+
 :::
 
 Example:
@@ -506,7 +511,6 @@ test('plays video', () => {
 
   expect(spy).toHaveBeenCalled();
   expect(isPlaying).toBe(true);
-
 });
 ```
 
@@ -547,7 +551,7 @@ const audio = require('./audio');
 const video = require('./video');
 
 afterEach(() => {
-// restore the spy created with spyOn
+  // restore the spy created with spyOn
   jest.restoreAllMocks();
 });
 
@@ -557,7 +561,6 @@ test('plays video', () => {
 
   expect(spy).toHaveBeenCalled();
   expect(isPlaying).toBe(true);
-
 });
 
 test('plays audio', () => {
@@ -566,7 +569,6 @@ test('plays audio', () => {
 
   expect(spy).toHaveBeenCalled();
   expect(audio.volume).toBe(100);
-
 });
 ```
 

diff --git a/website/versioned_docs/version-26.x/JestObjectAPI.md b/website/versioned_docs/version-26.x/JestObjectAPI.md
@@ -476,11 +476,15 @@ Determines if the given function is a mocked function.
 Creates a mock function similar to `jest.fn` but also tracks calls to `object[methodName]`. Returns a Jest [mock function](MockFunctionAPI.md).
 
 :::note
+
 By default, `jest.spyOn` also calls the **spied** method. This is different behavior from most other test libraries. If you want to overwrite the original function, you can use `jest.spyOn(object, methodName).mockImplementation(() => customImplementation)` or `object[methodName] = jest.fn(() => customImplementation);`
+
 :::
 
 :::tip
-Since `jest.spyOn` is a mock.  You could restore the initial state calling [jest.restoreAllMocks](#jestrestoreallmocks) on [afterEach](GlobalAPI.md#aftereachfn-timeout) method. 
+
+Since `jest.spyOn` is a mock. You could restore the initial state calling [jest.restoreAllMocks](#jestrestoreallmocks) on [afterEach](GlobalAPI.md#aftereachfn-timeout) method.
+
 :::
 
 Example:
@@ -511,7 +515,6 @@ test('plays video', () => {
 
   expect(spy).toHaveBeenCalled();
   expect(isPlaying).toBe(true);
-
 });
 ```
 
@@ -562,7 +565,6 @@ test('plays video', () => {
 
   expect(spy).toHaveBeenCalled();
   expect(isPlaying).toBe(true);
-
 });
 
 test('plays audio', () => {
@@ -571,7 +573,6 @@ test('plays audio', () => {
 
   expect(spy).toHaveBeenCalled();
   expect(audio.volume).toBe(100);
-
 });
 ```
 

diff --git a/website/versioned_docs/version-27.x/JestObjectAPI.md b/website/versioned_docs/version-27.x/JestObjectAPI.md
@@ -476,11 +476,15 @@ Determines if the given function is a mocked function.
 Creates a mock function similar to `jest.fn` but also tracks calls to `object[methodName]`. Returns a Jest [mock function](MockFunctionAPI.md).
 
 :::note
+
 By default, `jest.spyOn` also calls the **spied** method. This is different behavior from most other test libraries. If you want to overwrite the original function, you can use `jest.spyOn(object, methodName).mockImplementation(() => customImplementation)` or `object[methodName] = jest.fn(() => customImplementation);`
+
 :::
 
 :::tip
-Since `jest.spyOn` is a mock.  You could restore the initial state calling [jest.restoreAllMocks](#jestrestoreallmocks) on [afterEach](GlobalAPI.md#aftereachfn-timeout) method. 
+
+Since `jest.spyOn` is a mock. You could restore the initial state calling [jest.restoreAllMocks](#jestrestoreallmocks) on [afterEach](GlobalAPI.md#aftereachfn-timeout) method.
+
 :::
 
 Example:
@@ -511,7 +515,6 @@ test('plays video', () => {
 
   expect(spy).toHaveBeenCalled();
   expect(isPlaying).toBe(true);
-
 });
 ```
 
@@ -562,7 +565,6 @@ test('plays video', () => {
 
   expect(spy).toHaveBeenCalled();
   expect(isPlaying).toBe(true);
-
 });
 
 test('plays audio', () => {
@@ -571,7 +573,6 @@ test('plays audio', () => {
 
   expect(spy).toHaveBeenCalled();
   expect(audio.volume).toBe(100);
-
 });
 ```
 

diff --git a/website/versioned_docs/version-28.0/JestObjectAPI.md b/website/versioned_docs/version-28.0/JestObjectAPI.md
@@ -482,11 +482,15 @@ Determines if the given function is a mocked function.
 Creates a mock function similar to `jest.fn` but also tracks calls to `object[methodName]`. Returns a Jest [mock function](MockFunctionAPI.md).
 
 :::note
+
 By default, `jest.spyOn` also calls the **spied** method. This is different behavior from most other test libraries. If you want to overwrite the original function, you can use `jest.spyOn(object, methodName).mockImplementation(() => customImplementation)` or `object[methodName] = jest.fn(() => customImplementation);`
+
 :::
 
 :::tip
-Since `jest.spyOn` is a mock.  You could restore the initial state calling [jest.restoreAllMocks](#jestrestoreallmocks) on [afterEach](GlobalAPI.md#aftereachfn-timeout) method. 
+
+Since `jest.spyOn` is a mock. You could restore the initial state calling [jest.restoreAllMocks](#jestrestoreallmocks) on [afterEach](GlobalAPI.md#aftereachfn-timeout) method.
+
 :::
 
 Example:
@@ -517,7 +521,6 @@ test('plays video', () => {
 
   expect(spy).toHaveBeenCalled();
   expect(isPlaying).toBe(true);
-
 });
 ```
 
@@ -568,7 +571,6 @@ test('plays video', () => {
 
   expect(spy).toHaveBeenCalled();
   expect(isPlaying).toBe(true);
-
 });
 
 test('plays audio', () => {
@@ -577,7 +579,6 @@ test('plays audio', () => {
 
   expect(spy).toHaveBeenCalled();
   expect(audio.volume).toBe(100);
-
 });
 ```
 

diff --git a/website/versioned_docs/version-28.1/JestObjectAPI.md b/website/versioned_docs/version-28.1/JestObjectAPI.md
@@ -482,11 +482,15 @@ Determines if the given function is a mocked function.
 Creates a mock function similar to `jest.fn` but also tracks calls to `object[methodName]`. Returns a Jest [mock function](MockFunctionAPI.md).
 
 :::note
+
 By default, `jest.spyOn` also calls the **spied** method. This is different behavior from most other test libraries. If you want to overwrite the original function, you can use `jest.spyOn(object, methodName).mockImplementation(() => customImplementation)` or `object[methodName] = jest.fn(() => customImplementation);`
+
 :::
 
 :::tip
-Since `jest.spyOn` is a mock.  You could restore the initial state calling [jest.restoreAllMocks](#jestrestoreallmocks) on [afterEach](GlobalAPI.md#aftereachfn-timeout) method. 
+
+Since `jest.spyOn` is a mock. You could restore the initial state calling [jest.restoreAllMocks](#jestrestoreallmocks) on [afterEach](GlobalAPI.md#aftereachfn-timeout) method.
+
 :::
 
 Example:
@@ -511,14 +515,12 @@ afterEach(() => {
   jest.restoreAllMocks();
 });
 
-
 test('plays video', () => {
   const spy = jest.spyOn(video, 'play');
   const isPlaying = video.play();
 
   expect(spy).toHaveBeenCalled();
   expect(isPlaying).toBe(true);
-
 });
 ```
 
@@ -563,14 +565,12 @@ afterEach(() => {
   jest.restoreAllMocks();
 });
 
-
 test('plays video', () => {
   const spy = jest.spyOn(video, 'play', 'get'); // we pass 'get'
   const isPlaying = video.play;
 
   expect(spy).toHaveBeenCalled();
   expect(isPlaying).toBe(true);
-
 });
 
 test('plays audio', () => {
@@ -579,7 +579,6 @@ test('plays audio', () => {
 
   expect(spy).toHaveBeenCalled();
   expect(audio.volume).toBe(100);
-
 });
 ```