From 6d8e3a96513bcf231f5087c3ba8c1f67bcc852ab Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fredrik=20Adel=C3=B6w?= Date: Wed, 22 Dec 2021 12:35:23 +0100 Subject: [PATCH] Internal cleanup of the exports structure in the search plugin MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Fredrik Adelöw --- .changeset/four-waves-tan.md | 5 +++ .../DefaultResultListItem.stories.tsx | 6 +-- .../LegacySearchPage/LegacySearchPage.tsx | 1 + .../SearchBar/SearchBar.stories.tsx | 5 ++- .../SearchFilter/SearchFilter.stories.tsx | 5 ++- .../SearchModal/SearchModal.stories.tsx | 8 ++-- .../SearchModal/SearchModal.test.tsx | 1 + .../components/SearchModal/SearchModal.tsx | 1 + .../components/SearchPage/SearchPage.test.tsx | 2 +- .../SearchResult/SearchResult.stories.tsx | 10 +++-- .../SearchType/SearchType.stories.tsx | 4 +- plugins/search/src/components/index.tsx | 29 -------------- plugins/search/src/index.ts | 40 +++++++++---------- 13 files changed, 48 insertions(+), 69 deletions(-) create mode 100644 .changeset/four-waves-tan.md delete mode 100644 plugins/search/src/components/index.tsx diff --git a/.changeset/four-waves-tan.md b/.changeset/four-waves-tan.md new file mode 100644 index 0000000000..444891d31b --- /dev/null +++ b/.changeset/four-waves-tan.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-search': patch +--- + +Internal cleanup of the exports structure diff --git a/plugins/search/src/components/DefaultResultListItem/DefaultResultListItem.stories.tsx b/plugins/search/src/components/DefaultResultListItem/DefaultResultListItem.stories.tsx index 0445a35943..baf00767db 100644 --- a/plugins/search/src/components/DefaultResultListItem/DefaultResultListItem.stories.tsx +++ b/plugins/search/src/components/DefaultResultListItem/DefaultResultListItem.stories.tsx @@ -14,13 +14,13 @@ * limitations under the License. */ -import React from 'react'; +import { Button } from '@backstage/core-components'; import { Grid } from '@material-ui/core'; import FindInPageIcon from '@material-ui/icons/FindInPage'; import GroupIcon from '@material-ui/icons/Group'; -import { Button } from '@backstage/core-components'; -import { DefaultResultListItem } from '../index'; +import React from 'react'; import { MemoryRouter } from 'react-router'; +import { DefaultResultListItem } from './DefaultResultListItem'; export default { title: 'Plugins/Search/DefaultResultListItem', diff --git a/plugins/search/src/components/LegacySearchPage/LegacySearchPage.tsx b/plugins/search/src/components/LegacySearchPage/LegacySearchPage.tsx index c8f2e538cb..ec0fc3acb9 100644 --- a/plugins/search/src/components/LegacySearchPage/LegacySearchPage.tsx +++ b/plugins/search/src/components/LegacySearchPage/LegacySearchPage.tsx @@ -13,6 +13,7 @@ * See the License for the specific language governing permissions and * limitations under the License. */ + import { Grid } from '@material-ui/core'; import React, { useEffect, useState } from 'react'; import { useDebounce } from 'react-use'; diff --git a/plugins/search/src/components/SearchBar/SearchBar.stories.tsx b/plugins/search/src/components/SearchBar/SearchBar.stories.tsx index d00f391bc7..8d81e15e56 100644 --- a/plugins/search/src/components/SearchBar/SearchBar.stories.tsx +++ b/plugins/search/src/components/SearchBar/SearchBar.stories.tsx @@ -14,10 +14,11 @@ * limitations under the License. */ +import { Grid, makeStyles, Paper } from '@material-ui/core'; import React from 'react'; -import { Paper, Grid, makeStyles } from '@material-ui/core'; -import { SearchBar, SearchContext } from '../index'; import { MemoryRouter } from 'react-router'; +import { SearchContext } from '../SearchContext'; +import { SearchBar } from './SearchBar'; export default { title: 'Plugins/Search/SearchBar', diff --git a/plugins/search/src/components/SearchFilter/SearchFilter.stories.tsx b/plugins/search/src/components/SearchFilter/SearchFilter.stories.tsx index 190856fca8..c98c1106e6 100644 --- a/plugins/search/src/components/SearchFilter/SearchFilter.stories.tsx +++ b/plugins/search/src/components/SearchFilter/SearchFilter.stories.tsx @@ -14,10 +14,11 @@ * limitations under the License. */ -import React from 'react'; import { Grid, Paper } from '@material-ui/core'; -import { SearchFilter, SearchContext } from '../index'; +import React from 'react'; import { MemoryRouter } from 'react-router'; +import { SearchContext } from '../SearchContext'; +import { SearchFilter } from './SearchFilter'; export default { title: 'Plugins/Search/SearchFilter', diff --git a/plugins/search/src/components/SearchModal/SearchModal.stories.tsx b/plugins/search/src/components/SearchModal/SearchModal.stories.tsx index 6fa93c6588..c0a774ab46 100644 --- a/plugins/search/src/components/SearchModal/SearchModal.stories.tsx +++ b/plugins/search/src/components/SearchModal/SearchModal.stories.tsx @@ -14,14 +14,14 @@ * limitations under the License. */ -import React, { ComponentType } from 'react'; -import { Button } from '@material-ui/core'; import { ApiProvider, ApiRegistry } from '@backstage/core-app-api'; import { wrapInTestApp } from '@backstage/test-utils'; -import { SearchModal } from '../index'; -import { useSearch, SearchContextProvider } from '../SearchContext'; +import { Button } from '@material-ui/core'; +import React, { ComponentType } from 'react'; import { searchApiRef } from '../../apis'; import { rootRouteRef } from '../../plugin'; +import { SearchContextProvider, useSearch } from '../SearchContext'; +import { SearchModal } from './SearchModal'; const mockSearchApi = { query: () => diff --git a/plugins/search/src/components/SearchModal/SearchModal.test.tsx b/plugins/search/src/components/SearchModal/SearchModal.test.tsx index ff9622dfb9..d3209f9a9b 100644 --- a/plugins/search/src/components/SearchModal/SearchModal.test.tsx +++ b/plugins/search/src/components/SearchModal/SearchModal.test.tsx @@ -13,6 +13,7 @@ * See the License for the specific language governing permissions and * limitations under the License. */ + import React from 'react'; import { screen } from '@testing-library/react'; import { renderInTestApp, TestApiRegistry } from '@backstage/test-utils'; diff --git a/plugins/search/src/components/SearchModal/SearchModal.tsx b/plugins/search/src/components/SearchModal/SearchModal.tsx index ef1eaf650a..8b4da51592 100644 --- a/plugins/search/src/components/SearchModal/SearchModal.tsx +++ b/plugins/search/src/components/SearchModal/SearchModal.tsx @@ -13,6 +13,7 @@ * See the License for the specific language governing permissions and * limitations under the License. */ + import React from 'react'; import { Dialog, diff --git a/plugins/search/src/components/SearchPage/SearchPage.test.tsx b/plugins/search/src/components/SearchPage/SearchPage.test.tsx index c9980b3bf7..9486196584 100644 --- a/plugins/search/src/components/SearchPage/SearchPage.test.tsx +++ b/plugins/search/src/components/SearchPage/SearchPage.test.tsx @@ -18,7 +18,7 @@ import { renderInTestApp } from '@backstage/test-utils'; import React from 'react'; import { useLocation, useOutlet } from 'react-router'; import { useSearch } from '../SearchContext'; -import { SearchPage } from './'; +import { SearchPage } from './SearchPage'; jest.mock('react-router', () => ({ ...jest.requireActual('react-router'), diff --git a/plugins/search/src/components/SearchResult/SearchResult.stories.tsx b/plugins/search/src/components/SearchResult/SearchResult.stories.tsx index aebaecb8b4..82e4fc2916 100644 --- a/plugins/search/src/components/SearchResult/SearchResult.stories.tsx +++ b/plugins/search/src/components/SearchResult/SearchResult.stories.tsx @@ -14,11 +14,13 @@ * limitations under the License. */ -import React from 'react'; -import { List, ListItem } from '@material-ui/core'; -import { SearchResult, SearchContext, DefaultResultListItem } from '../index'; -import { MemoryRouter } from 'react-router'; import { Link } from '@backstage/core-components'; +import { List, ListItem } from '@material-ui/core'; +import React from 'react'; +import { MemoryRouter } from 'react-router'; +import { DefaultResultListItem } from '../DefaultResultListItem'; +import { SearchContext } from '../SearchContext'; +import { SearchResult } from './SearchResult'; export default { title: 'Plugins/Search/SearchResult', diff --git a/plugins/search/src/components/SearchType/SearchType.stories.tsx b/plugins/search/src/components/SearchType/SearchType.stories.tsx index da662d8fef..29dd66a3a6 100644 --- a/plugins/search/src/components/SearchType/SearchType.stories.tsx +++ b/plugins/search/src/components/SearchType/SearchType.stories.tsx @@ -13,10 +13,10 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -import React, { useState } from 'react'; -import { SearchType } from '../index'; +import React, { useState } from 'react'; import { SearchContext } from '../SearchContext'; +import { SearchType } from './SearchType'; export default { title: 'Plugins/Search/SearchType', diff --git a/plugins/search/src/components/index.tsx b/plugins/search/src/components/index.tsx deleted file mode 100644 index e413e9505d..0000000000 --- a/plugins/search/src/components/index.tsx +++ /dev/null @@ -1,29 +0,0 @@ -/* - * Copyright 2020 The Backstage Authors - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -export * from './DefaultResultListItem'; -export * from './Filters'; -export * from './SearchBar'; -export * from './SearchContext'; -export * from './SearchFilter'; -export * from './SearchModal'; -export * from './SearchPage'; -export * from './SearchResult'; -export * from './SearchResultPager'; -export * from './SearchType'; -export * from './SidebarSearch'; -export * from './SidebarSearchModal'; -export * from './HomePageComponent'; diff --git a/plugins/search/src/index.ts b/plugins/search/src/index.ts index 5bfdcf4318..fc0a149c88 100644 --- a/plugins/search/src/index.ts +++ b/plugins/search/src/index.ts @@ -22,30 +22,26 @@ export { searchApiRef } from './apis'; export type { SearchApi } from './apis'; -export { - Filters, - FiltersButton, - SearchBar, - SearchBarBase, - SearchContextProvider, - SearchFilter, - SearchFilterNext, - SearchModal, - SearchPage as Router, - SearchResultPager, - SearchType, - SidebarSearch, - useSearch, -} from './components'; + +export { Filters, FiltersButton } from './components/Filters'; +export type { FiltersState } from './components/Filters'; +export type { HomePageSearchBarProps } from './components/HomePageComponent'; +export { SearchBar, SearchBarBase } from './components/SearchBar'; export type { - SearchModalProps, - SidebarSearchModalProps, - HomePageSearchBarProps, - SidebarSearchProps, - FiltersState, - SearchBarProps, SearchBarBaseProps, -} from './components'; + SearchBarProps, +} from './components/SearchBar'; +export { SearchContextProvider, useSearch } from './components/SearchContext'; +export { SearchFilter, SearchFilterNext } from './components/SearchFilter'; +export { SearchModal } from './components/SearchModal'; +export type { SearchModalProps } from './components/SearchModal'; +export { SearchPage as Router } from './components/SearchPage'; +export { SearchResultPager } from './components/SearchResultPager'; +export { SearchType } from './components/SearchType'; +export { SidebarSearch } from './components/SidebarSearch'; +export type { SidebarSearchProps } from './components/SidebarSearch'; +export type { SidebarSearchModalProps } from './components/SidebarSearchModal'; + export { DefaultResultListItem, HomePageSearchBar,