diff --git a/src/App.tsx b/src/App.tsx index f216958..7a369b3 100644 --- a/src/App.tsx +++ b/src/App.tsx @@ -3,16 +3,6 @@ import { useEffect } from 'react'; import { Route, Routes } from 'react-router-dom'; import * as config from '../environment.json'; - -import { Document } from './pages/Document/Document'; -import buildingFromSource from './pages/GettingStarted/BuildingFromSource.md'; -import gswApacheMavenPath from './pages/GettingStarted/GettingStartedWithApacheMaven.md'; -import gswGradlePath from './pages/GettingStarted/GettingStartedWithGradle.md'; -import gswGroovyGrape from './pages/GettingStarted/GettingStartedWithGroovyGrape.md'; -import gswJitpack from './pages/GettingStarted/GettingStartedWithJitpack.md'; -import { NeuralNetworksQuickstart } from './pages/GettingStarted/NeuralNetworksQuickstart/NeuralNetworksQuickstart'; -import { Home } from './pages/Home/Home'; -import { useGetSummary } from './Hooks'; import { CustomPage, LoadingSpinner, @@ -21,7 +11,16 @@ import { MarkdownRenderer, Message, } from './components'; +import { useGetSummary } from './Hooks'; +import { Document } from './pages/Document/Document'; import example from './pages/example.json'; +import buildingFromSource from './pages/GettingStarted/BuildingFromSource.md'; +import gswApacheMavenPath from './pages/GettingStarted/GettingStartedWithApacheMaven.md'; +import gswGradlePath from './pages/GettingStarted/GettingStartedWithGradle.md'; +import gswGroovyGrape from './pages/GettingStarted/GettingStartedWithGroovyGrape.md'; +import gswJitpack from './pages/GettingStarted/GettingStartedWithJitpack.md'; +import { NeuralNetworksQuickstart } from './pages/GettingStarted/NeuralNetworksQuickstart/NeuralNetworksQuickstart'; +import { Home } from './pages/Home/Home'; export const App = (): JSX.Element => { const { data: summary, isLoading, isError } = useGetSummary(); diff --git a/src/Hooks/useActiveLink.ts b/src/Hooks/useActiveLink.ts index eceb24e..6bbb25c 100644 --- a/src/Hooks/useActiveLink.ts +++ b/src/Hooks/useActiveLink.ts @@ -1,6 +1,7 @@ +import { IActiveLink } from 'spock-react/hooks-types'; import { create } from 'zustand'; + import * as config from '../../environment.json'; -import { IActiveLink } from 'spock-react/hooks-types'; const getInitialState = () => { const pageAndAnchor = window.location.pathname.split('#'); diff --git a/src/Hooks/useGenerateSearchEntries.ts b/src/Hooks/useGenerateSearchEntries.ts index 3c6f27c..9a08e18 100644 --- a/src/Hooks/useGenerateSearchEntries.ts +++ b/src/Hooks/useGenerateSearchEntries.ts @@ -1,12 +1,12 @@ import { useEffect, useState } from 'react'; - -import { cleanedSearchData } from '../components/Search/generateSearchEntries'; import { ISpecification } from 'spock-react-types'; -import { IGenerateSearchEntries } from 'spock-react/hooks-types'; import { IMinimizedSummaryEntry, ISearchEntry, } from 'spock-react/components/search-types'; +import { IGenerateSearchEntries } from 'spock-react/hooks-types'; + +import { cleanedSearchData } from '../components/Search/generateSearchEntries'; export const useGenerateSearchEntries = ( props: IGenerateSearchEntries diff --git a/src/Hooks/useGetSpec.ts b/src/Hooks/useGetSpec.ts index 5215bfd..9f08a72 100644 --- a/src/Hooks/useGetSpec.ts +++ b/src/Hooks/useGetSpec.ts @@ -1,9 +1,9 @@ import axios from 'axios'; +import { IGetSpec, ISpec } from 'spock-react/hooks-types'; import { useQuery, UseQueryResult } from '@tanstack/react-query'; import config from '../../environment.json'; -import { IGetSpec, ISpec } from 'spock-react/hooks-types'; const getSpec = async (file: string): Promise => { const data = await axios.get(`${config.specUrl}/${file}.json`); diff --git a/src/Hooks/useGetSummary.ts b/src/Hooks/useGetSummary.ts index 006617b..4850341 100644 --- a/src/Hooks/useGetSummary.ts +++ b/src/Hooks/useGetSummary.ts @@ -1,9 +1,9 @@ import axios from 'axios'; +import { ISummary } from 'spock-react-types'; import { useQuery, UseQueryResult } from '@tanstack/react-query'; import config from '../../environment.json'; -import { ISummary } from 'spock-react-types'; const getSummary = async (): Promise => { const data = await axios.get(config.summaryUrl); diff --git a/src/Hooks/useMarkdown.ts b/src/Hooks/useMarkdown.ts index 62ed3c2..5dc3f2d 100644 --- a/src/Hooks/useMarkdown.ts +++ b/src/Hooks/useMarkdown.ts @@ -1,6 +1,7 @@ -import { useQuery } from '@tanstack/react-query'; import { IMarkdown } from 'spock-react/hooks-types'; +import { useQuery } from '@tanstack/react-query'; + const getMarkdown = async (mdFile: string) => { const data = await fetch(mdFile); return await data.text(); diff --git a/src/components/Feature/Feature.tsx b/src/components/Feature/Feature.tsx index 65a12f2..969c09b 100644 --- a/src/components/Feature/Feature.tsx +++ b/src/components/Feature/Feature.tsx @@ -2,13 +2,14 @@ import './styles.css'; import { nanoid } from 'nanoid'; import { Fragment } from 'react'; +import { IMinimalFeature } from 'spock-react-types'; +import { IWhereTable } from 'spock-react/components/feature-types'; +import { IRow } from 'spock-react/shared/responsive-table-types'; import { faHashtag } from '@fortawesome/free-solid-svg-icons'; import { FontAwesomeIcon } from '@fortawesome/react-fontawesome'; + import { ResponsiveTable, SyntaxHighlighter } from '../shared'; -import { IMinimalFeature } from 'spock-react-types'; -import { IWhereTable } from 'spock-react/components/feature-types'; -import { IRow } from 'spock-react/shared/responsive-table-types'; /* className === unique key for spec diff --git a/src/components/MainNav/MainNav.tsx b/src/components/MainNav/MainNav.tsx index 8986b2c..c2f0797 100644 --- a/src/components/MainNav/MainNav.tsx +++ b/src/components/MainNav/MainNav.tsx @@ -2,14 +2,14 @@ import './styles.css'; import { nanoid } from 'nanoid'; import { Link } from 'react-router-dom'; +import { IMainNav } from 'spock-react/components/main-nav-types'; import { faBook, faHouseChimney } from '@fortawesome/free-solid-svg-icons'; import { FontAwesomeIcon } from '@fortawesome/react-fontawesome'; -import { IMainNav } from 'spock-react/components/main-nav-types'; import * as config from '../../../environment.json'; -import { useActiveLink } from '../../Hooks'; import GithubLogo from '../../assets/img/github-mark-white.png'; +import { useActiveLink } from '../../Hooks'; import { Search } from '../Search'; import { NavLink } from '../shared'; diff --git a/src/components/Search/Search.tsx b/src/components/Search/Search.tsx index 7d96eea..39367e5 100644 --- a/src/components/Search/Search.tsx +++ b/src/components/Search/Search.tsx @@ -2,12 +2,12 @@ import './styles.css'; import { useState } from 'react'; import { Dialog, DialogBackdrop, Separator, useDialogState } from 'reakit'; +import { ISearch, ISearchHit } from 'spock-react/components/search-types'; import { SearchButton } from './SearchButton'; import { SearchFooter } from './SearchFooter'; import { SearchHits } from './SearchHits'; import { SearchInput } from './SearchInput'; -import { ISearch, ISearchHit } from 'spock-react/components/search-types'; export const Search = (props: ISearch): JSX.Element => { const { summary } = props; diff --git a/src/components/Search/SearchButton/SearchButton.tsx b/src/components/Search/SearchButton/SearchButton.tsx index 83374f0..a6090ab 100644 --- a/src/components/Search/SearchButton/SearchButton.tsx +++ b/src/components/Search/SearchButton/SearchButton.tsx @@ -1,10 +1,10 @@ import './styles.css'; import { DialogDisclosure } from 'reakit'; +import { ISearchButton } from 'spock-react/components/search-button-types'; import { faMagnifyingGlass } from '@fortawesome/free-solid-svg-icons'; import { FontAwesomeIcon } from '@fortawesome/react-fontawesome'; -import { ISearchButton } from 'spock-react/components/search-button-types'; export const SearchButton = (props: ISearchButton): JSX.Element => { const { dialog } = props; diff --git a/src/components/Search/SearchHits/SearchHits.tsx b/src/components/Search/SearchHits/SearchHits.tsx index e0a88db..dedf054 100644 --- a/src/components/Search/SearchHits/SearchHits.tsx +++ b/src/components/Search/SearchHits/SearchHits.tsx @@ -1,9 +1,9 @@ import './styles.css'; import { nanoid } from 'nanoid'; +import { ISearchHits } from 'spock-react/components/search-hits-types'; import { SearchCard } from './SearchCard'; -import { ISearchHits } from 'spock-react/components/search-hits-types'; export const SearchHits = (props: ISearchHits): JSX.Element => { const { searchHits, summary, setSearchHits, setSearchInput, dialog } = diff --git a/src/components/Search/SearchHits/types.d.ts b/src/components/Search/SearchHits/types.d.ts index af07ad8..3c63edf 100644 --- a/src/components/Search/SearchHits/types.d.ts +++ b/src/components/Search/SearchHits/types.d.ts @@ -1,7 +1,7 @@ declare module 'spock-react/components/search-hits-types' { + import { DialogStateReturn } from 'reakit/ts'; import { ISummary } from 'spock-react-types'; import { ISearchHit } from 'spock-react/components/search-types'; - import { DialogStateReturn } from 'reakit/ts'; interface ISearchHits { searchHits: ISearchHit[] | null; diff --git a/src/components/Search/SearchInput/SearchInput.tsx b/src/components/Search/SearchInput/SearchInput.tsx index 9406568..0faa442 100644 --- a/src/components/Search/SearchInput/SearchInput.tsx +++ b/src/components/Search/SearchInput/SearchInput.tsx @@ -1,12 +1,12 @@ import './styles.css'; import { Input } from 'reakit'; +import { ISearchInput } from 'spock-react/components/search-input-types'; +import { ISearchHit } from 'spock-react/components/search-types'; import { faMagnifyingGlass } from '@fortawesome/free-solid-svg-icons'; import { FontAwesomeIcon } from '@fortawesome/react-fontawesome'; -import { ISearchInput } from 'spock-react/components/search-input-types'; -import { ISearchHit } from 'spock-react/components/search-types'; import { useGenerateSearchEntries } from '../../../Hooks/useGenerateSearchEntries'; import { getSearchScore } from '../getSearchScore'; diff --git a/src/components/shared/Layout/Layout.tsx b/src/components/shared/Layout/Layout.tsx index 8dfa412..0e65eb2 100644 --- a/src/components/shared/Layout/Layout.tsx +++ b/src/components/shared/Layout/Layout.tsx @@ -1,9 +1,9 @@ import './styles.css'; import { PropsWithChildren } from 'react'; +import { ILayout } from 'spock-react/shared/layout-types'; import { OnPageNav } from './OnPageNav'; -import { ILayout } from 'spock-react/shared/layout-types'; export const Layout = (props: PropsWithChildren): JSX.Element => { const { hasOnPageNav, children, features } = props; diff --git a/src/components/shared/Layout/OnPageNav.tsx b/src/components/shared/Layout/OnPageNav.tsx index de6950c..70516ad 100644 --- a/src/components/shared/Layout/OnPageNav.tsx +++ b/src/components/shared/Layout/OnPageNav.tsx @@ -1,8 +1,8 @@ import { nanoid } from 'nanoid'; - -import { NavAnchor } from '..'; -import { IOnPageNave } from 'spock-react/shared/layout-types'; import { IMinimalFeature } from 'spock-react-types'; +import { IOnPageNave } from 'spock-react/shared/layout-types'; + +import { NavAnchor } from '../'; export const OnPageNav = (props: IOnPageNave): JSX.Element => { const { features } = props; diff --git a/src/components/shared/LoadingSpinner/LoadingSpinner.tsx b/src/components/shared/LoadingSpinner/LoadingSpinner.tsx index c00d8a8..ed5efda 100644 --- a/src/components/shared/LoadingSpinner/LoadingSpinner.tsx +++ b/src/components/shared/LoadingSpinner/LoadingSpinner.tsx @@ -1,8 +1,9 @@ import './styles.css'; +import { ILoadingSpinner } from 'spock-react/shared/loading-spinner-types'; + import { faSpinner } from '@fortawesome/free-solid-svg-icons'; import { FontAwesomeIcon } from '@fortawesome/react-fontawesome'; -import { ILoadingSpinner } from 'spock-react/shared/loading-spinner-types'; export const LoadingSpinner = (props: ILoadingSpinner): JSX.Element => { const { isLoading } = props; diff --git a/src/components/shared/MarkdownRenderer/MarkdownRenderer.tsx b/src/components/shared/MarkdownRenderer/MarkdownRenderer.tsx index 5690eb5..9961101 100644 --- a/src/components/shared/MarkdownRenderer/MarkdownRenderer.tsx +++ b/src/components/shared/MarkdownRenderer/MarkdownRenderer.tsx @@ -1,6 +1,7 @@ import Markdown from 'react-markdown'; - import remarkGfm from 'remark-gfm'; +import { IMarkdownRenderer } from 'spock-react/shared/markdown-renderer-types'; + import { Divide, MdTable, @@ -11,7 +12,6 @@ import { MdTableRow, SyntaxHighlighter, } from '../..'; -import { IMarkdownRenderer } from 'spock-react/shared/markdown-renderer-types'; export const MarkdownRenderer = (props: IMarkdownRenderer) => { const { children: content } = props; diff --git a/src/components/shared/Message/Message.tsx b/src/components/shared/Message/Message.tsx index 3680fe7..b51ce1c 100644 --- a/src/components/shared/Message/Message.tsx +++ b/src/components/shared/Message/Message.tsx @@ -1,5 +1,7 @@ import './styles.css'; +import { IErrorMessage, TLevel } from 'spock-react/shared/message-types'; + import { faCircleCheck, faCircleInfo, @@ -7,7 +9,6 @@ import { faTriangleExclamation, } from '@fortawesome/free-solid-svg-icons'; import { FontAwesomeIcon } from '@fortawesome/react-fontawesome'; -import { IErrorMessage, TLevel } from 'spock-react/shared/message-types'; export const Message = (props: IErrorMessage): JSX.Element => { const { headline, level, children } = props; diff --git a/src/components/shared/NavLink/NavAnchor.tsx b/src/components/shared/NavLink/NavAnchor.tsx index 3e30738..7dad12f 100644 --- a/src/components/shared/NavLink/NavAnchor.tsx +++ b/src/components/shared/NavLink/NavAnchor.tsx @@ -1,6 +1,7 @@ import './styles.css'; import { INavLink } from 'spock-react/shared/nav-link-types'; + import { useActiveAnchor } from '../../../Hooks'; export const NavAnchor = (props: INavLink) => { diff --git a/src/components/shared/NavLink/NavLink.tsx b/src/components/shared/NavLink/NavLink.tsx index a45c24f..aff0f75 100644 --- a/src/components/shared/NavLink/NavLink.tsx +++ b/src/components/shared/NavLink/NavLink.tsx @@ -1,8 +1,8 @@ import './styles.css'; import { Link } from 'react-router-dom'; - import { INavLink } from 'spock-react/shared/nav-link-types'; + import { useActiveLink } from '../../../Hooks'; export const NavLink = (props: INavLink): JSX.Element => { diff --git a/src/components/shared/PageTemplate/CustomPage.tsx b/src/components/shared/PageTemplate/CustomPage.tsx index b39596b..7476722 100644 --- a/src/components/shared/PageTemplate/CustomPage.tsx +++ b/src/components/shared/PageTemplate/CustomPage.tsx @@ -1,7 +1,7 @@ import { PropsWithChildren } from 'react'; +import { Layout } from '../'; import { useScrollUp } from '../../../Hooks'; -import { Layout } from '..'; export const CustomPage = (props: PropsWithChildren): JSX.Element => { const { children } = props; diff --git a/src/components/shared/PageTemplate/MarkdownPage.tsx b/src/components/shared/PageTemplate/MarkdownPage.tsx index 13570d8..c503e38 100644 --- a/src/components/shared/PageTemplate/MarkdownPage.tsx +++ b/src/components/shared/PageTemplate/MarkdownPage.tsx @@ -1,5 +1,6 @@ import { IMarkdownPage } from 'spock-react/shared/page-template-types'; -import { Layout, LoadingSpinner, MarkdownRenderer, Message } from '..'; + +import { Layout, LoadingSpinner, MarkdownRenderer, Message } from '../'; import * as config from '../../../../environment.json'; import { useMarkdown, useScrollUp } from '../../../Hooks'; diff --git a/src/components/shared/Table/index.ts b/src/components/shared/Table/index.ts index e907525..ddf86be 100644 --- a/src/components/shared/Table/index.ts +++ b/src/components/shared/Table/index.ts @@ -1,2 +1,2 @@ -export * from './ResponsiveTable'; export * from './MarkdownTable'; +export * from './ResponsiveTable'; diff --git a/src/main.tsx b/src/main.tsx index 94f0b05..049822b 100644 --- a/src/main.tsx +++ b/src/main.tsx @@ -7,9 +7,9 @@ import { BrowserRouter } from 'react-router-dom'; import { QueryClient, QueryClientProvider } from '@tanstack/react-query'; +import * as config from '../environment.json'; import { App } from './App'; import { Message } from './components/shared'; -import * as config from '../environment.json'; const queryClient = new QueryClient(); diff --git a/src/pages/Document/Document.tsx b/src/pages/Document/Document.tsx index 2b06feb..28c565c 100644 --- a/src/pages/Document/Document.tsx +++ b/src/pages/Document/Document.tsx @@ -1,8 +1,8 @@ import { nanoid } from 'nanoid'; import { Fragment } from 'react'; +import { IDocument } from 'spock-react/pages/document-types'; import * as config from '../../../environment.json'; -import { useGetSpec, useScrollUp } from '../../Hooks'; import { Divide, Feature, @@ -11,7 +11,7 @@ import { MarkdownRenderer, Message, } from '../../components'; -import { IDocument } from 'spock-react/pages/document-types'; +import { useGetSpec, useScrollUp } from '../../Hooks'; export const Document = (props: IDocument): JSX.Element => { const { fileName } = props; diff --git a/src/pages/GettingStarted/NeuralNetworksQuickstart/NeuralNetworksQuickstart.tsx b/src/pages/GettingStarted/NeuralNetworksQuickstart/NeuralNetworksQuickstart.tsx index c1eb98b..d6ab83e 100644 --- a/src/pages/GettingStarted/NeuralNetworksQuickstart/NeuralNetworksQuickstart.tsx +++ b/src/pages/GettingStarted/NeuralNetworksQuickstart/NeuralNetworksQuickstart.tsx @@ -1,6 +1,7 @@ -import { CustomPage, CustomTab, SyntaxHighlighter } from '../../../components'; import './styles.css'; +import { CustomPage, CustomTab, SyntaxHighlighter } from '../../../components'; + export const NeuralNetworksQuickstart = () => { return ( diff --git a/src/pages/Home/Home.tsx b/src/pages/Home/Home.tsx index 5e69907..89e0a5e 100644 --- a/src/pages/Home/Home.tsx +++ b/src/pages/Home/Home.tsx @@ -6,6 +6,7 @@ import { faWandSparkles, } from '@fortawesome/free-solid-svg-icons'; import { FontAwesomeIcon } from '@fortawesome/react-fontawesome'; + import { CustomPage, CustomTab, SyntaxHighlighter } from '../../components'; const groovySnippet = { diff --git a/src/test-utils.tsx b/src/test-utils.tsx index dc7ded5..8f855f5 100644 --- a/src/test-utils.tsx +++ b/src/test-utils.tsx @@ -46,4 +46,4 @@ const customRender = ( options?: Omit ) => render(ui, { wrapper: AllTheProviders, ...options }); -export { testingStuff as testing, customRender as render }; +export { customRender as render, testingStuff as testing }; diff --git a/src/tests/example.test.tsx b/src/tests/example.test.tsx index 7adddc5..5b83f22 100644 --- a/src/tests/example.test.tsx +++ b/src/tests/example.test.tsx @@ -1,4 +1,5 @@ import axios from 'axios'; +import { ISummary } from 'spock-react-types'; import { describe, expect, test } from 'vitest'; import { renderHook } from '@testing-library/react-hooks'; @@ -6,7 +7,6 @@ import { renderHook } from '@testing-library/react-hooks'; import { App } from '../App'; import { useGetSummary } from '../Hooks'; import { HookProvider, render } from '../test-utils'; -import { ISummary } from 'spock-react-types'; describe('test', () => { test('component example', () => {