Files

Anton Nikolaev 5383017299 Separate interfaces for installed, bundled and downloadable plugins

Summary:
I've re-designed interfaces describing plugins as I found that mental overhead working with them became too expensive because of slightly flawed design. However this cascaded changes in many files so you can see how extensively these interfaces used in our codebase.

Before this change we had one interface PluginDetails which described three different entities: 1) plugins installed on the disk 2) plugins bundled into Flipper 3) plugins available on Marketplace. It's hard to use this "general" PluginDetails interface because of this as you always need to think about all three use cases everywhere.

After this change we have 3 separate interfaces: InstalledPluginDetails, BundledPluginDetails and DownloadablePluginDetails and things became much type-safer now.

Reviewed By: mweststrate

Differential Revision: D25530383

fbshipit-source-id: b93593916a980c04e36dc6ffa168797645a0ff9c

2020-12-15 09:31:57 -08:00

src

Separate interfaces for installed, bundled and downloadable plugins

2020-12-15 09:31:57 -08:00

package.json

Do not bump every package version for every release

2020-12-02 02:38:47 -08:00

README.md

Initialized flipper-plugin library

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

tsconfig.json

Allow plugins to send messages

2020-07-01 09:12:36 -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