#147 create index.ts for components and hooks§ (#162)

src/App.tsx

@@ -3,11 +3,7 @@ import { useEffect } from 'react';
 import { Route, Routes } from 'react-router-dom';
 
 import * as config from '../environment.json';
-import { MainNav } from './components/MainNav/MainNav';
-import { LoadingSpinner } from './components/shared/LoadingSpinner/LoadingSpinner';
-import { MarkdownPage } from './components/shared/MarkdownPage';
-import { Message } from './components/shared/Message/Message';
-import { useGetSummary } from './Hooks/useGetSummary';
+
 import { Document } from './pages/Document';
 import buildingFromSource from './pages/GettingStarted/BuildingFromSource.md';
 import gswApacheMavenPath from './pages/GettingStarted/GettingStartedWithApacheMaven.md';
@@ -16,6 +12,8 @@ import gswGroovyGrape from './pages/GettingStarted/GettingStartedWithGroovyGrape
 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 { LoadingSpinner, MainNav, MarkdownPage, Message } from './components';
 
 export const App = (): JSX.Element => {
     const { data: summary, isLoading, isError } = useGetSummary();

src/Hooks/index.ts

@@ -0,0 +1,7 @@
+export * from './useActiveAnchor';
+export * from './useActiveLink';
+export * from './useGenerateSearchEntries';
+export * from './useGetSpec';
+export * from './useGetSummary';
+export * from './useMarkdown';
+export * from './useScrollUp';

src/components/Feature/Feature.tsx

@@ -5,9 +5,7 @@ import { Fragment } from 'react';
 
 import { faHashtag } from '@fortawesome/free-solid-svg-icons';
 import { FontAwesomeIcon } from '@fortawesome/react-fontawesome';
-
-import { SyntaxHighlighter } from '../shared/SyntaxHighlighter';
-import { IRow, ResponsiveTable } from '../shared/Table';
+import { IRow, ResponsiveTable, SyntaxHighlighter } from '../shared';
 
 /*
 className === unique key for spec

src/components/Feature/index.ts

@@ -0,0 +1 @@
+export * from './Feature';

src/components/MainNav/MainNav.tsx

@@ -8,10 +8,9 @@ import { FontAwesomeIcon } from '@fortawesome/react-fontawesome';
 
 import * as config from '../../../environment.json';
 import GithubLogo from '../../assets/img/github-mark-white.png';
-import { useActiveLink } from '../../Hooks/useActiveLink';
-import { ISummary } from '../../Hooks/useGetSummary';
-import { Search } from '../Search/Search';
-import { NavLink } from '../shared/NavLink/NavLink';
+import { Search } from '../Search';
+import { NavLink } from '../shared';
+import { ISummary, useActiveLink } from '../../Hooks';
 
 interface IMainNav {
     summary: ISummary;

src/components/MainNav/index.ts

@@ -0,0 +1 @@
+export * from './MainNav';

src/components/Search/Search.tsx

@@ -3,11 +3,11 @@ import './styles.css';
 import { useState } from 'react';
 import { Dialog, DialogBackdrop, Separator, useDialogState } from 'reakit';
 
-import { ISummary } from '../../Hooks/useGetSummary';
-import { SearchButton } from './SearchButton/SearchButton';
-import { SearchFooter } from './SearchFooter/SearchFooter';
-import { SearchHits } from './SearchHits/SearchHits';
-import { SearchInput } from './SearchInput/SearchInput';
+import { ISummary } from '../../Hooks';
+import { SearchButton } from './SearchButton';
+import { SearchFooter } from './SearchFooter';
+import { SearchHits } from './SearchHits';
+import { SearchInput } from './SearchInput';
 
 export interface ISearchHit {
     score: number;

src/components/Search/SearchButton/index.ts

@@ -0,0 +1 @@
+export * from './SearchButton';

src/components/Search/SearchFooter/index.ts

@@ -0,0 +1 @@
+export * from './SearchFooter';

src/components/Search/SearchHits/SearchCard/index.ts

@@ -0,0 +1 @@
+export * from './SearchCard';

src/components/Search/SearchHits/SearchHits.tsx

@@ -5,7 +5,7 @@ import { DialogStateReturn } from 'reakit/ts';
 
 import { ISummary } from '../../../Hooks/useGetSummary';
 import { ISearchHit } from '../Search';
-import { SearchCard } from './SearchCard/SearchCard';
+import { SearchCard } from './SearchCard';
 
 interface ISearchHits {
     searchHits: ISearchHit[] | null;

src/components/Search/SearchHits/index.ts

@@ -0,0 +1 @@
+export * from './SearchHits';

src/components/Search/SearchInput/index.ts

@@ -0,0 +1 @@
+export * from './SearchInput';

src/components/Search/index.ts

@@ -0,0 +1 @@
+export * from './Search';

src/components/index.ts

@@ -0,0 +1,4 @@
+export * from './Feature';
+export * from './MainNav';
+export * from './Search';
+export * from './shared';

src/components/shared/Divide/index.ts

@@ -0,0 +1 @@
+export * from './Divide';

src/components/shared/Layout/Layout.tsx

@@ -2,7 +2,7 @@ import './styles.css';
 
 import { PropsWithChildren } from 'react';
 
-import { IFeature } from '../../../Hooks/useGetSpec';
+import { IFeature } from '../../../Hooks';
 import { OnPageNav } from './OnPageNav';
 
 interface ILayout {

src/components/shared/Layout/OnPageNav.tsx

@@ -1,7 +1,7 @@
 import { nanoid } from 'nanoid';
 
-import { IFeature } from '../../../Hooks/useGetSpec';
-import { NavAnchor } from '../NavLink/NavAnchor';
+import { IFeature } from '../../../Hooks';
+import { NavAnchor } from '..';
 
 interface IOnPageNave {
     features: IFeature[];

src/components/shared/Layout/index.ts

@@ -0,0 +1,2 @@
+export * from './Layout';
+export * from './OnPageNav';

src/components/shared/LoadingSpinner/index.ts

@@ -0,0 +1 @@
+export * from './LoadingSpinner';

src/components/shared/MarkdownRenderer.tsx

@@ -1,16 +1,16 @@
 import Markdown from 'react-markdown';
 
-import { Divide } from './Divide/Divide';
-import { SyntaxHighlighter } from './SyntaxHighlighter';
+import remarkGfm from 'remark-gfm';
 import {
+    Divide,
     MdTable,
     MdTableBody,
     MdTableCell,
     MdTableHead,
     MdTableHeader,
     MdTableRow,
-} from './Table';
-import remarkGfm from 'remark-gfm';
+    SyntaxHighlighter,
+} from '..';
 
 interface IMarkdownRenderer {
     children: string;

src/components/shared/Message/index.ts

@@ -0,0 +1 @@
+export * from './Message';

src/components/shared/NavLink/NavAnchor.tsx

@@ -2,7 +2,7 @@ import './styles.css';
 
 import { ReactNode } from 'react';
 
-import { useActiveAnchor } from '../../../Hooks/useActiveAnchor';
+import { useActiveAnchor } from '../../../Hooks';
 
 interface INavAnchor {
     href: string;

src/components/shared/NavLink/NavLink.tsx

@@ -3,7 +3,7 @@ import './styles.css';
 import { ReactNode } from 'react';
 import { Link } from 'react-router-dom';
 
-import { useActiveLink } from '../../../Hooks/useActiveLink';
+import { useActiveLink } from '../../../Hooks';
 
 interface INavLink {
     href: string;

src/components/shared/NavLink/index.ts

@@ -0,0 +1,2 @@
+export * from './NavAnchor';
+export * from './NavLink';

src/components/shared/CustomPage.tsx → src/components/shared/PageTemplate/CustomPage.tsx

@@ -1,7 +1,7 @@
 import { PropsWithChildren } from 'react';
 
-import { useScrollUp } from '../../Hooks/useScrollUp';
-import { Layout } from './Layout/Layout';
+import { useScrollUp } from '../../../Hooks';
+import { Layout } from '..';
 
 export const CustomPage = (props: PropsWithChildren<unknown>): JSX.Element => {
     const { children } = props;

src/components/shared/MarkdownPage.tsx → src/components/shared/PageTemplate/MarkdownPage.tsx

@@ -1,10 +1,6 @@
-import * as config from '../../../environment.json';
-import { useMarkdown } from '../../Hooks/useMarkdown';
-import { useScrollUp } from '../../Hooks/useScrollUp';
-import { Layout } from './Layout/Layout';
-import { LoadingSpinner } from './LoadingSpinner/LoadingSpinner';
-import { MarkdownRenderer } from './MarkdownRenderer';
-import { Message } from './Message/Message';
+import { Layout, LoadingSpinner, MarkdownRenderer, Message } from '..';
+import * as config from '../../../../environment.json';
+import { useMarkdown, useScrollUp } from '../../../Hooks';
 
 interface IMarkdownPage {
     filePath: string;

src/components/shared/PageTemplate/index.ts

@@ -0,0 +1,2 @@
+export * from './CustomPage';
+export * from './MarkdownPage';

src/components/shared/Tab/index.ts

@@ -0,0 +1 @@
+export * from './CustomTab';

src/components/shared/Table/ResponsiveTable/index.ts

@@ -0,0 +1 @@
+export * from './ResponsiveTable';

src/components/shared/Table/index.ts

@@ -1,2 +1,2 @@
-export * from './ResponsiveTable/ResponsiveTable';
+export * from './ResponsiveTable';
 export * from './MarkdownTable';

src/components/shared/index.ts

@@ -0,0 +1,10 @@
+export * from './Divide';
+export * from './Layout';
+export * from './LoadingSpinner';
+export * from './MarkdownRenderer';
+export * from './Message';
+export * from './NavLink';
+export * from './PageTemplate';
+export * from './SyntaxHighlighter';
+export * from './Tab';
+export * from './Table';

src/main.tsx

@@ -8,7 +8,7 @@ import { BrowserRouter } from 'react-router-dom';
 import { QueryClient, QueryClientProvider } from '@tanstack/react-query';
 
 import { App } from './App';
-import { Message } from './components/shared/Message/Message';
+import { Message } from './components/shared';
 import * as config from '../environment.json';
 
 const queryClient = new QueryClient();

src/pages/Document.tsx

@@ -2,13 +2,14 @@ import { nanoid } from 'nanoid';
 import { Fragment } from 'react';
 
 import * as config from '../../environment.json';
-import { Feature } from '../components/Feature/Feature';
-import { Divide } from '../components/shared/Divide/Divide';
-import { Layout } from '../components/shared/Layout/Layout';
-import { LoadingSpinner } from '../components/shared/LoadingSpinner/LoadingSpinner';
-import { Message } from '../components/shared/Message/Message';
-import { useGetSpec } from '../Hooks/useGetSpec';
-import { useScrollUp } from '../Hooks/useScrollUp';
+import { useGetSpec, useScrollUp } from '../Hooks';
+import {
+    Divide,
+    Feature,
+    Layout,
+    LoadingSpinner,
+    Message,
+} from '../components';
 
 interface IExampleOne {
     fileName: string;

src/pages/GettingStarted/NeuralNetworksQuickstart/NeuralNetworksQuickstart.tsx

@@ -1,9 +1,6 @@
+import { CustomPage, CustomTab, SyntaxHighlighter } from '../../../components';
 import './styles.css';
 
-import { CustomPage } from '../../../components/shared/CustomPage';
-import { SyntaxHighlighter } from '../../../components/shared/SyntaxHighlighter';
-import { CustomTab } from '../../../components/shared/Tab/CustomTab';
-
 export const NeuralNetworksQuickstart = () => {
     return (
         <CustomPage>

src/pages/Home/Home.tsx

@@ -6,10 +6,7 @@ import {
     faWandSparkles,
 } from '@fortawesome/free-solid-svg-icons';
 import { FontAwesomeIcon } from '@fortawesome/react-fontawesome';
-
-import { CustomPage } from '../../components/shared/CustomPage';
-import { SyntaxHighlighter } from '../../components/shared/SyntaxHighlighter';
-import { CustomTab } from '../../components/shared/Tab/CustomTab';
+import { CustomPage, CustomTab, SyntaxHighlighter } from '../../components';
 
 const groovySnippet = {
     content: (

src/tests/example.test.tsx

@@ -4,7 +4,7 @@ import { describe, expect, test } from 'vitest';
 import { renderHook } from '@testing-library/react-hooks';
 
 import { App } from '../App';
-import { ISummary, useGetSummary } from '../Hooks/useGetSummary';
+import { ISummary, useGetSummary } from '../Hooks';
 import { HookProvider, render } from '../test-utils';
 
 describe('test', () => {