Files

Michel Weststrate 12ac29685d make sure plugins can be loaded into Flipper

Summary: Make sure Sandy plugins are loaded properly from disk

Reviewed By: jknoxville

Differential Revision: D22186275

fbshipit-source-id: fd2f560a7bed959b18e05db2a087909ad876ab9d

2020-07-01 09:12:35 -07:00

src

make sure plugins can be loaded into Flipper

2020-07-01 09:12:35 -07:00

package.json

Initialized flipper-plugin library

2020-07-01 09:12:35 -07:00

README.md

Initialized flipper-plugin library

2020-07-01 09:12:35 -07:00

tsconfig.json

Introduce types for Sandy plugins through code base

2020-07-01 09:12:35 -07:00

yarn.lock

Initialized flipper-plugin library

2020-07-01 09:12:35 -07:00

README.md

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:

(TODO) Standard API's to interact with Flipper, such as the client connection.
(TODO) Standard components to organize the UI
(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