Files
flipper/desktop/flipper-plugin
Michel Weststrate 69de9bc92d Initial move to flipper-plugin
Summary:
This diff moves the core of ElementsInspector to flipper-plugin and decouples it from legacy design system and Electron, without any significant improvements or API changes yet, which will follow later.

Colors and docs will be added later in this stack.

Reviewed By: passy

Differential Revision: D27660300

fbshipit-source-id: 96abfa3b3174fa852cf04ae119c23c3d629fee74
2021-04-15 07:48:33 -07:00
..
2021-04-15 07:48:33 -07:00
2020-07-01 09:12:35 -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