From c2c07a1c0217070c9802f99fcfbb45a64d6ab9ee Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Wed, 6 Sep 2023 10:28:35 +0200 Subject: [PATCH] app-next-example-plugin: api report + fixes Signed-off-by: Patrik Oldsberg --- .../app-next-example-plugin/api-report.md | 20 +++++++++++++++++++ .../src/ExampleSidebarItem.tsx | 1 + .../app-next-example-plugin/src/plugin.tsx | 1 + 3 files changed, 22 insertions(+) create mode 100644 packages/app-next-example-plugin/api-report.md diff --git a/packages/app-next-example-plugin/api-report.md b/packages/app-next-example-plugin/api-report.md new file mode 100644 index 0000000000..1963e69be4 --- /dev/null +++ b/packages/app-next-example-plugin/api-report.md @@ -0,0 +1,20 @@ +## API Report File for "app-next-example-plugin" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts +import { BackstagePlugin } from '@backstage/frontend-plugin-api'; +import { default as React_2 } from 'react'; + +// Warning: (ae-missing-release-tag) "examplePlugin" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export const examplePlugin: BackstagePlugin; + +// Warning: (ae-missing-release-tag) "ExampleSidebarItem" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export const ExampleSidebarItem: () => React_2.JSX.Element; + +// (No @packageDocumentation comment for this package) +``` diff --git a/packages/app-next-example-plugin/src/ExampleSidebarItem.tsx b/packages/app-next-example-plugin/src/ExampleSidebarItem.tsx index 6d8bedc509..20e84f1933 100644 --- a/packages/app-next-example-plugin/src/ExampleSidebarItem.tsx +++ b/packages/app-next-example-plugin/src/ExampleSidebarItem.tsx @@ -18,6 +18,7 @@ import React from 'react'; import { SidebarItem } from '@backstage/core-components'; import SaveIcon from '@material-ui/icons/Save'; +/** @public */ export const ExampleSidebarItem = () => ( ); diff --git a/packages/app-next-example-plugin/src/plugin.tsx b/packages/app-next-example-plugin/src/plugin.tsx index 4112d1de4e..5b5adeab2f 100644 --- a/packages/app-next-example-plugin/src/plugin.tsx +++ b/packages/app-next-example-plugin/src/plugin.tsx @@ -26,6 +26,7 @@ export const ExamplePage = createPageExtension({ component: () => import('./Component').then(m => ), }); +/** @public */ export const examplePlugin = createPlugin({ id: 'example', extensions: [ExamplePage],