jens/flipper
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update public docs to use Sandy

Browse Source 
Summary: This updates the docs of Flipper to use Sandy, rather than `FlipperPlugin` class. Restructured the docs a bit as a result.

Reviewed By: passy

Differential Revision: D24991285

fbshipit-source-id: 66d5760c25cf9cf3983515433dfd64348d51db3d
This commit is contained in:
Michel Weststrate
2020-11-16 13:08:05 -08:00
committed by Facebook GitHub Bot
parent da6d6593a5
commit cc438e60ad
12 changed files with 418 additions and 592 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docs/extending/testing.mdx
View File

@@ -96,17 +96,4 @@ TEST(MyFlipperPluginTests, testDummy) {
## Testing the Flipper Desktop Plugin
Tests should be put in the `__tests__` directory of your plugin sources, and be created using Jest.
An example test suite can be found [here](https://github.com/facebook/flipper/blob/master/desktop/plugins/layout/__tests__/ProxyArchiveClient.node.tsx).
Flipper exposes an API to generate unit tests that can verify _regressions_ and real life scenarios.
To generate a unit test:
1. Start flipper.
2. Open your plugin.
3. Open the Developer Tools (`View > Open Developer Tools`).
4. In the console, call the function `flipperStartPluginRecording()`.
5. Interact with your application, in such a way that new events are created for your plugin.
6. Once you generated an interesting amount and diversity of events, call `flipperStopPluginRecording()` from the Flipper console.
7. This process will have generated a unit test and a snapshot file with the data (the console will report where). Move those files to your `__tests__` directory.
8. The unit test should succeed if it is run using Jest. Feel free to modify the unit test to your needs. In the future you might want to record new snapshot data files if the plugin changes.
See the [tutorial](../tutorial/js-custom#testing-plugin-logic)