From 9b356dcaacc9192f10886d4bf254305aa56e3827 Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Wed, 14 Aug 2024 16:01:25 +0200 Subject: [PATCH] frontend-plugin-api: renamed createPlugin to createFrontendPlugin Signed-off-by: Patrik Oldsberg --- .changeset/chilly-numbers-chew.md | 5 +++ .../architecture/15-plugins.md | 10 ++--- .../frontend-system/architecture/36-routes.md | 12 +++--- .../architecture/50-naming-patterns.md | 4 +- .../building-apps/08-migrating.md | 2 +- .../building-plugins/01-index.md | 14 +++---- .../building-plugins/05-migrating.md | 20 +++++----- .../utility-apis/02-creating.md | 4 +- .../app-next-example-plugin/src/plugin.tsx | 4 +- .../app-next/src/examples/pagesPlugin.tsx | 4 +- .../src/collectLegacyRoutes.test.tsx | 2 +- .../src/collectLegacyRoutes.tsx | 4 +- .../compatWrapper/BackwardsCompatProvider.tsx | 2 +- .../src/routing/collectRouteIds.test.ts | 8 +++- .../extractRouteInfoFromAppNode.test.ts | 4 +- .../src/tree/createAppTree.test.ts | 4 +- .../src/tree/resolveAppNodeSpecs.test.ts | 22 +++++++---- .../src/tree/resolveAppNodeSpecs.ts | 2 +- .../src/wiring/createApp.test.tsx | 14 +++---- .../frontend-app-api/src/wiring/createApp.tsx | 2 +- .../src/wiring/discovery.test.ts | 10 ++--- packages/frontend-plugin-api/api-report.md | 39 ++++++++++--------- ...n.test.ts => createFrontendPlugin.test.ts} | 20 +++++----- ...reatePlugin.ts => createFrontendPlugin.ts} | 10 ++++- .../frontend-plugin-api/src/wiring/index.ts | 6 ++- plugins/api-docs/src/alpha.tsx | 4 +- plugins/app-visualizer/src/plugin.tsx | 4 +- plugins/catalog-graph/src/alpha.tsx | 4 +- plugins/catalog-import/src/alpha.tsx | 4 +- plugins/catalog/src/alpha/plugin.tsx | 4 +- plugins/devtools/src/alpha/plugin.tsx | 4 +- plugins/home/src/alpha.tsx | 4 +- plugins/kubernetes/src/alpha/plugin.tsx | 4 +- plugins/org/src/alpha.tsx | 4 +- plugins/scaffolder/src/alpha.tsx | 4 +- plugins/search/src/alpha.tsx | 4 +- plugins/techdocs/src/alpha.tsx | 4 +- plugins/user-settings/src/alpha.tsx | 4 +- 38 files changed, 154 insertions(+), 126 deletions(-) create mode 100644 .changeset/chilly-numbers-chew.md rename packages/frontend-plugin-api/src/wiring/{createPlugin.test.ts => createFrontendPlugin.test.ts} (95%) rename packages/frontend-plugin-api/src/wiring/{createPlugin.ts => createFrontendPlugin.ts} (95%) diff --git a/.changeset/chilly-numbers-chew.md b/.changeset/chilly-numbers-chew.md new file mode 100644 index 0000000000..3ee9e7837f --- /dev/null +++ b/.changeset/chilly-numbers-chew.md @@ -0,0 +1,5 @@ +--- +'@backstage/frontend-plugin-api': patch +--- + +Renamed `createPlugin` to `createFrontendPlugin`. The old symbol is still exported but deprecated. diff --git a/docs/frontend-system/architecture/15-plugins.md b/docs/frontend-system/architecture/15-plugins.md index 042d4fbc36..c1539f0309 100644 --- a/docs/frontend-system/architecture/15-plugins.md +++ b/docs/frontend-system/architecture/15-plugins.md @@ -25,7 +25,7 @@ How to create a simple plugin --> ```ts -export const myPlugin = createPlugin({ +export const myPlugin = createFrontendPlugin({ id: 'my-plugin', }); ``` @@ -48,7 +48,7 @@ link to relevant docs