From 1bbb8cee46f69ae25f184bfe889bf6c3919f98f1 Mon Sep 17 00:00:00 2001 From: Oliver Sand Date: Wed, 18 Aug 2021 09:37:06 +0200 Subject: [PATCH] Rename ImportComponentPage to ImportPage as it can import all kinds of entities Signed-off-by: Oliver Sand --- plugins/catalog-import/api-report.md | 4 ++-- plugins/catalog-import/dev/index.tsx | 4 ++-- .../DefaultImportPage.test.tsx} | 17 ++++++++--------- .../DefaultImportPage.tsx} | 2 +- .../index.ts | 2 +- .../ImportPage.test.tsx} | 6 +++--- .../ImportPage.tsx} | 6 +++--- .../index.ts | 2 +- .../catalog-import/src/components/Router.tsx | 6 +++--- plugins/catalog-import/src/components/index.ts | 2 +- plugins/catalog-import/src/plugin.ts | 5 +---- 11 files changed, 26 insertions(+), 30 deletions(-) rename plugins/catalog-import/src/components/{ImportComponentPage/ImportComponentPage.test.tsx => DefaultImportPage/DefaultImportPage.test.tsx} (94%) rename plugins/catalog-import/src/components/{DefaultImportComponentPage/DefaultImportComponentPage.tsx => DefaultImportPage/DefaultImportPage.tsx} (97%) rename plugins/catalog-import/src/components/{ImportComponentPage => DefaultImportPage}/index.ts (90%) rename plugins/catalog-import/src/components/{DefaultImportComponentPage/DefaultImportComponentPage.test.tsx => ImportPage/ImportPage.test.tsx} (92%) rename plugins/catalog-import/src/components/{ImportComponentPage/ImportComponentPage.tsx => ImportPage/ImportPage.tsx} (83%) rename plugins/catalog-import/src/components/{DefaultImportComponentPage => ImportPage}/index.ts (88%) diff --git a/plugins/catalog-import/api-report.md b/plugins/catalog-import/api-report.md index 9462894f61..a89654a56e 100644 --- a/plugins/catalog-import/api-report.md +++ b/plugins/catalog-import/api-report.md @@ -145,10 +145,10 @@ export function defaultGenerateStepper( defaults: StepperProvider, ): StepperProvider; -// Warning: (ae-missing-release-tag) "DefaultImportComponentPage" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// Warning: (ae-missing-release-tag) "DefaultImportPage" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) -export const DefaultImportComponentPage: () => JSX.Element; +export const DefaultImportPage: () => JSX.Element; // Warning: (ae-forgotten-export) The symbol "Props" needs to be exported by the entry point index.d.ts // Warning: (ae-missing-release-tag) "EntityListComponent" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) diff --git a/plugins/catalog-import/dev/index.tsx b/plugins/catalog-import/dev/index.tsx index 48d9320ca9..a0cf034782 100644 --- a/plugins/catalog-import/dev/index.tsx +++ b/plugins/catalog-import/dev/index.tsx @@ -29,7 +29,7 @@ import { EntityListComponent, ImportStepper, } from '../src'; -import { ImportComponentPage } from '../src/components/ImportComponentPage'; +import { ImportPage } from '../src/components/ImportPage'; import { Content, Header, InfoCard, Page } from '@backstage/core-components'; const getEntityNames = (url: string): EntityName[] => [ @@ -252,7 +252,7 @@ createDevApp() }) .addPage({ title: 'Catalog Import', - element: , + element: , }) .addPage({ title: 'Catalog Import 2', diff --git a/plugins/catalog-import/src/components/ImportComponentPage/ImportComponentPage.test.tsx b/plugins/catalog-import/src/components/DefaultImportPage/DefaultImportPage.test.tsx similarity index 94% rename from plugins/catalog-import/src/components/ImportComponentPage/ImportComponentPage.test.tsx rename to plugins/catalog-import/src/components/DefaultImportPage/DefaultImportPage.test.tsx index 4177a6ae64..3a66c11dde 100644 --- a/plugins/catalog-import/src/components/ImportComponentPage/ImportComponentPage.test.tsx +++ b/plugins/catalog-import/src/components/DefaultImportPage/DefaultImportPage.test.tsx @@ -15,21 +15,20 @@ */ import { CatalogClient } from '@backstage/catalog-client'; -import { catalogApiRef } from '@backstage/plugin-catalog-react'; -import { wrapInTestApp } from '@backstage/test-utils'; -import { act, render } from '@testing-library/react'; -import React from 'react'; -import { catalogImportApiRef, CatalogImportClient } from '../../api'; -import { ImportComponentPage } from './ImportComponentPage'; - import { ApiProvider, ApiRegistry, ConfigReader, } from '@backstage/core-app-api'; import { configApiRef } from '@backstage/core-plugin-api'; +import { catalogApiRef } from '@backstage/plugin-catalog-react'; +import { wrapInTestApp } from '@backstage/test-utils'; +import { act, render } from '@testing-library/react'; +import React from 'react'; +import { catalogImportApiRef, CatalogImportClient } from '../../api'; +import { DefaultImportPage } from './DefaultImportPage'; -describe('', () => { +describe('', () => { const identityApi = { getUserId: () => { return 'user'; @@ -72,7 +71,7 @@ describe('', () => { const { getByText } = render( wrapInTestApp( - + , ), ); diff --git a/plugins/catalog-import/src/components/DefaultImportComponentPage/DefaultImportComponentPage.tsx b/plugins/catalog-import/src/components/DefaultImportPage/DefaultImportPage.tsx similarity index 97% rename from plugins/catalog-import/src/components/DefaultImportComponentPage/DefaultImportComponentPage.tsx rename to plugins/catalog-import/src/components/DefaultImportPage/DefaultImportPage.tsx index d9e9e09335..8693895ec0 100644 --- a/plugins/catalog-import/src/components/DefaultImportComponentPage/DefaultImportComponentPage.tsx +++ b/plugins/catalog-import/src/components/DefaultImportPage/DefaultImportPage.tsx @@ -27,7 +27,7 @@ import React from 'react'; import { ImportInfoCard } from '../ImportInfoCard'; import { ImportStepper } from '../ImportStepper'; -export const DefaultImportComponentPage = () => { +export const DefaultImportPage = () => { const configApi = useApi(configApiRef); const appTitle = configApi.getOptional('app.title') || 'Backstage'; diff --git a/plugins/catalog-import/src/components/ImportComponentPage/index.ts b/plugins/catalog-import/src/components/DefaultImportPage/index.ts similarity index 90% rename from plugins/catalog-import/src/components/ImportComponentPage/index.ts rename to plugins/catalog-import/src/components/DefaultImportPage/index.ts index 263ba51a23..5a4d4907e3 100644 --- a/plugins/catalog-import/src/components/ImportComponentPage/index.ts +++ b/plugins/catalog-import/src/components/DefaultImportPage/index.ts @@ -14,4 +14,4 @@ * limitations under the License. */ -export { ImportComponentPage } from './ImportComponentPage'; +export { DefaultImportPage } from './DefaultImportPage'; diff --git a/plugins/catalog-import/src/components/DefaultImportComponentPage/DefaultImportComponentPage.test.tsx b/plugins/catalog-import/src/components/ImportPage/ImportPage.test.tsx similarity index 92% rename from plugins/catalog-import/src/components/DefaultImportComponentPage/DefaultImportComponentPage.test.tsx rename to plugins/catalog-import/src/components/ImportPage/ImportPage.test.tsx index e807559cbf..8a481d74c9 100644 --- a/plugins/catalog-import/src/components/DefaultImportComponentPage/DefaultImportComponentPage.test.tsx +++ b/plugins/catalog-import/src/components/ImportPage/ImportPage.test.tsx @@ -26,9 +26,9 @@ import { wrapInTestApp } from '@backstage/test-utils'; import { act, render } from '@testing-library/react'; import React from 'react'; import { catalogImportApiRef, CatalogImportClient } from '../../api'; -import { DefaultImportComponentPage } from './DefaultImportComponentPage'; +import { ImportPage } from './ImportPage'; -describe('', () => { +describe('', () => { const identityApi = { getUserId: () => { return 'user'; @@ -71,7 +71,7 @@ describe('', () => { const { getByText } = render( wrapInTestApp( - + , ), ); diff --git a/plugins/catalog-import/src/components/ImportComponentPage/ImportComponentPage.tsx b/plugins/catalog-import/src/components/ImportPage/ImportPage.tsx similarity index 83% rename from plugins/catalog-import/src/components/ImportComponentPage/ImportComponentPage.tsx rename to plugins/catalog-import/src/components/ImportPage/ImportPage.tsx index 3a89705493..507ea0c5df 100644 --- a/plugins/catalog-import/src/components/ImportComponentPage/ImportComponentPage.tsx +++ b/plugins/catalog-import/src/components/ImportPage/ImportPage.tsx @@ -16,16 +16,16 @@ import React from 'react'; import { useOutlet } from 'react-router'; -import { DefaultImportComponentPage } from '../DefaultImportComponentPage'; +import { DefaultImportPage } from '../DefaultImportPage'; import { ImportOptionsContext } from '../ImportOptionsContext'; import { ImportOptions } from '../types'; -export const ImportComponentPage = (opts: ImportOptions) => { +export const ImportPage = (opts: ImportOptions) => { const outlet = useOutlet(); return ( - {outlet || } + {outlet || } ); }; diff --git a/plugins/catalog-import/src/components/DefaultImportComponentPage/index.ts b/plugins/catalog-import/src/components/ImportPage/index.ts similarity index 88% rename from plugins/catalog-import/src/components/DefaultImportComponentPage/index.ts rename to plugins/catalog-import/src/components/ImportPage/index.ts index f3450413a6..891c5302db 100644 --- a/plugins/catalog-import/src/components/DefaultImportComponentPage/index.ts +++ b/plugins/catalog-import/src/components/ImportPage/index.ts @@ -14,4 +14,4 @@ * limitations under the License. */ -export { DefaultImportComponentPage } from './DefaultImportComponentPage'; +export { ImportPage } from './ImportPage'; diff --git a/plugins/catalog-import/src/components/Router.tsx b/plugins/catalog-import/src/components/Router.tsx index 05ae51ca01..3fc9896800 100644 --- a/plugins/catalog-import/src/components/Router.tsx +++ b/plugins/catalog-import/src/components/Router.tsx @@ -16,12 +16,12 @@ import React from 'react'; import { Route, Routes } from 'react-router-dom'; -import { ImportComponentPage } from './ImportComponentPage'; +import { ImportPage } from './ImportPage'; import { ImportOptions } from './types'; -/// @deprecated, use ImportComponentPage instead. +/// @deprecated, use ImportPage instead. export const Router = (opts: ImportOptions) => ( - } /> + } /> ); diff --git a/plugins/catalog-import/src/components/index.ts b/plugins/catalog-import/src/components/index.ts index 81056274f0..d34ecf3bcc 100644 --- a/plugins/catalog-import/src/components/index.ts +++ b/plugins/catalog-import/src/components/index.ts @@ -14,7 +14,7 @@ * limitations under the License. */ -export * from './DefaultImportComponentPage'; +export * from './DefaultImportPage'; export * from './EntityListComponent'; export * from './ImportInfoCard'; export * from './ImportOptionsContext'; diff --git a/plugins/catalog-import/src/plugin.ts b/plugins/catalog-import/src/plugin.ts index 075d8a2084..2aa4d78f2d 100644 --- a/plugins/catalog-import/src/plugin.ts +++ b/plugins/catalog-import/src/plugin.ts @@ -67,10 +67,7 @@ export const catalogImportPlugin = createPlugin({ export const CatalogImportPage = catalogImportPlugin.provide( createRoutableExtension({ - component: () => - import('./components/ImportComponentPage').then( - m => m.ImportComponentPage, - ), + component: () => import('./components/ImportPage').then(m => m.ImportPage), mountPoint: rootRouteRef, }), );