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

loading-custom-plugins.mdx (Creating Plugins - Dynamically Loading Plugins)

Browse Source 
Summary: Restyle of page, including changes to spelling, grammar, links, and structure (where relevant).

Reviewed By: nikoant

Differential Revision: D36445433

fbshipit-source-id: 6e0033607cf58d5da51dd9910b40f158ceed84cf
This commit is contained in:
Kevin Strider
2022-05-17 10:03:37 -07:00
committed by Facebook GitHub Bot
parent f31011fd6c
commit 78d395ad51
1 changed files with 16 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
docs/extending/loading-custom-plugins.mdx
View File

@@ -5,27 +5,29 @@ title: Dynamically Loading Plugins
<FbInternalOnly> <FbInternalOnly>
<div class="warning"> :::caution
Within Meta, plugins sources are stored and loaded from `~/fbsource/xplat/sonar/desktop/plugins`, in which case no further configuration is needed.
Inside Facebook, plugins sources are stored and loaded from `~/fbsource/xplat/sonar/desktop/plugins`,
in which case no further configuration is needed.
If your team uses Flipper plugins that are stored outside `fbsource`, please follow your team specific instructions. If your team uses Flipper plugins that are stored outside `fbsource`, please follow your team specific instructions.
::::
</div>
</FbInternalOnly> </FbInternalOnly>
Flipper loads and runs plugins it finds in a configurable location. The paths searched are specified in `~/.flipper/config.json`. These paths, `pluginPaths`, should contain one folder for each of the plugins it stores. An example config setting and plugin file structure is shown below: Flipper loads and runs plugins it finds in a configurable location. The paths searched are specified in `~/.flipper/config.json`. These `pluginPaths` should contain one folder for each of the plugins it stores.
An example config setting and plugin file structure is shown below:
`~/.flipper/config.json`: `~/.flipper/config.json`:
```
```bash
{ {
..., ...,
"pluginPaths": ["~/flipper-plugins"] "pluginPaths": ["~/flipper-plugins"]
} }
``` ```
Plugin File example structure: Plugin File example structure:
``` ```
~ flipper-plugins/ ~ flipper-plugins/
my-plugin/ my-plugin/
@@ -36,9 +38,12 @@ Plugin File example structure:
<OssOnly> <OssOnly>
Note: when using `npx flipper-pkg init` for scaffolding, as explained in the [tutorial](../tutorial/intro.mdx) or on the next page, the path should be configured automatically for you in most cases. :::note
When using `npx flipper-pkg init` for scaffolding, as explained in the [tutorial](../tutorial/intro.mdx) or on the next page, the path should be configured automatically for you in most cases.
:::
</OssOnly> </OssOnly>
Typically, the above setup is only needed if you are developing plugins. Typically, the above setup is only needed if you are developing plugins.
To consume plugins, it is recommended to use one of the existing [distribution mechanisms](plugin-distribution.mdx) instead.
To consume plugins, it is recommended to use one of the existing [distribution mechanisms](plugin-distribution.mdx)