Files
flipper/desktop/flipper-plugin
Andrey Goncharov 2854e75e9c Support exporting public API from a plugin
Reviewed By: passy

Differential Revision: D36098167

fbshipit-source-id: 90182248d0541a1d8eff92a391a56422537c0595
2022-05-10 05:13:24 -07:00
..
2020-07-01 09:12:35 -07:00
2022-03-31 04:01:33 -07:00

flipper-plugin

flipper-plugin is the dependency used by all modern Flipper plugins (project "Tommy").

For background: https://fb.quip.com/YHOGAnaPqAVJ

flipper-plugin is to be used as dev and peer dependency of all Flipper plugins. It provides:

  1. (TODO) Standard API's to interact with Flipper, such as the client connection.
  2. (TODO) Standard components to organize the UI
  3. (TODO) Testing utilities

API's provided by flipper-plugin are documented at fbflipper.com (TODO).

There should normally be no need to install flipper-plugin as dependency. Rather, plugins should be scaffolded using npx flipper-pkg init (TODO) as documented here