mon-entreprise/site/source/App.tsx

189 lines
5.1 KiB
TypeScript
Raw Normal View History

2022-11-03 16:32:04 +00:00
import { ErrorBoundary } from '@sentry/react'
import { FallbackRender } from '@sentry/react/types/errorboundary'
import rules from 'modele-social'
import { ComponentProps, StrictMode, useMemo } from 'react'
import { useTranslation } from 'react-i18next'
2022-11-03 16:32:04 +00:00
import { Route, Routes } from 'react-router-dom'
import styled, { css } from 'styled-components'
import Route404 from '@/components/Route404'
import Footer from '@/components/layout/Footer/Footer'
import Header from '@/components/layout/Header'
import {
EngineProvider,
Rules,
2022-11-03 16:32:04 +00:00
engineFactory,
2022-09-06 16:02:50 +00:00
useEngine,
useSetupSafeSituation,
} from '@/components/utils/EngineContext'
2022-11-03 16:32:04 +00:00
import { useIsEmbedded } from '@/components/utils/useIsEmbedded'
import { Container, Spacing } from '@/design-system/layout'
2022-11-03 16:32:04 +00:00
import Provider, { ProviderProps } from './Provider'
import { useAxeCoreAnalysis } from './hooks/useAxeCoreAnalysis'
import { useGetFullURL } from './hooks/useGetFullURL'
2022-11-03 16:32:04 +00:00
import { useSaveAndRestoreScrollPosition } from './hooks/useSaveAndRestoreScrollPosition'
import Accessibilité from './pages/Accessibilité'
2020-02-27 08:32:40 +00:00
import Budget from './pages/Budget/Budget'
import Créer from './pages/Creer'
import IntegrationTest from './pages/Dev/IntegrationTest'
import Personas from './pages/Dev/Personas'
import Documentation from './pages/Documentation'
import Iframes from './pages/Iframes'
import Landing from './pages/Landing/Landing'
import Nouveautés from './pages/Nouveautes/Nouveautes'
2022-08-03 15:00:50 +00:00
import Offline from './pages/Offline'
2022-11-03 16:32:04 +00:00
import Plan from './pages/Plan'
import Simulateurs from './pages/Simulateurs'
import Stats from './pages/Stats/LazyStats'
2022-11-03 16:32:04 +00:00
import Gérer from './pages/gerer'
import Integration from './pages/integration/index'
2022-07-28 18:04:44 +00:00
import { useSitePaths } from './sitePaths'
2020-04-23 13:59:43 +00:00
type RootProps = {
basename: ProviderProps['basename']
2022-01-04 10:11:31 +00:00
rulesPreTransform?: (rules: Rules) => Rules
}
2022-01-04 10:11:31 +00:00
export default function Root({
basename,
rulesPreTransform = (r) => r,
}: RootProps) {
const engine = useMemo(
() => engineFactory(rulesPreTransform(rules)),
// We need to keep [rules] in the dependency list for hot reload of the rules
// in dev mode, even if ESLint think it is unnecessary since `rules` isn't
// defined in the component scope.
//
// eslint-disable-next-line react-hooks/exhaustive-deps
[rules]
)
2022-03-28 12:57:11 +00:00
return (
<StrictMode>
2022-07-28 18:04:44 +00:00
<Provider basename={basename}>
<EngineProvider value={engine}>
<Router />
</EngineProvider>
</Provider>
</StrictMode>
)
2018-07-12 08:09:41 +00:00
}
const Router = () => {
2022-09-06 16:02:50 +00:00
const engine = useEngine()
2022-09-06 16:02:50 +00:00
useSetupSafeSituation(engine)
2022-03-28 12:57:11 +00:00
return (
2022-09-06 16:02:50 +00:00
<Routes>
<Route index element={<Landing />} />
<Route path="/iframes/*" element={<Iframes />} />
<Route path="*" element={<App />} />
</Routes>
)
}
2018-11-06 13:29:16 +00:00
2022-08-03 15:00:50 +00:00
const CatchOffline = ({ error }: ComponentProps<FallbackRender>) => {
if (error.message.includes('dynamically imported module')) {
2022-08-03 15:00:50 +00:00
return <Offline />
} else {
throw error
}
}
🔥 Migration vers TypeScript Outils ====== Ce commit retire le tooling de Flow, et ajoute le support de TypeScript pour les fichiers .ts et .tsx. Il n'est pas nécessaire de tout migrer d'un coup ce qui facilite la transition. On garde en effet le compilateur Babel avec un preset TypeScript (ce qui permet donc de retirer à la fois les types Flow et TypeScript) plutôt que d'utiliser le compilateur standard pour la conversion du code. Cela permet aussi de mieux s'intégrer avec d'autres outils, notamment les test-runners. Ajout d'une nouvelle commande `yarn run type-check`, intégrée dans CircleCI. Par ailleurs ajout du support de l'opérateur ?? pour donner des valeurs par défaut (nullish-coalescing-operator). Typage des libraires tierces ============================ Les principales libraires que nous utilisons ont un typage TypeScript de bon niveau, ce qui facilite l'intégration. J'ai mis à jour react-i18next et i18next afin de corriger un problème de typage. Typage du code ============== Le typage est loin d'être complet dans ce commit, en particulier il manque les types relatifs au state Redux, ainsi qu'au moteur (règle, explication). Néanmoins le typage des contextes fonctionne, en particulier sitePaths (avec un type récursif non trivial !) qui a déjà permis de détecter un lien mort. Le typage des "paths" (Components/, Règles/, etc.) fonctionne bien, y compris avec l'auto-complétion automatique des import par Typescript. TypeScript se révèle déjà bien agréable dans VSCode (auto-complétion, refacto, etc.) ! Reste à migrer progressivement le reste du code !
2019-10-26 16:21:09 +00:00
const App = () => {
2022-07-28 18:04:44 +00:00
const { relativeSitePaths } = useSitePaths()
2022-03-28 12:57:11 +00:00
const { t } = useTranslation()
const fullURL = useGetFullURL()
useSaveAndRestoreScrollPosition()
const isEmbedded = useIsEmbedded()
if (!import.meta.env.PROD && import.meta.env.VITE_AXE_CORE_ENABLED) {
// eslint-disable-next-line react-hooks/rules-of-hooks
useAxeCoreAnalysis()
}
const documentationPath = useSitePaths().absoluteSitePaths.documentation.index
const engine = useEngine()
return (
<StyledLayout isEmbedded={isEmbedded}>
{!isEmbedded && <Header />}
<a href={`${fullURL}#footer`} className="skip-link print-hidden">
{t('Passer le contenu')}
</a>
<main role="main" id="main">
<Container>
<ErrorBoundary fallback={CatchOffline}>
<Routes>
<Route
path={relativeSitePaths.créer.index + '/*'}
element={<Créer />}
/>
<Route
path={relativeSitePaths.gérer.index + '/*'}
element={<Gérer />}
/>
<Route
path={relativeSitePaths.simulateurs.index + '/*'}
element={<Simulateurs />}
/>
<Route
path={relativeSitePaths.documentation.index + '/*'}
element={
<Documentation
documentationPath={documentationPath}
engine={engine}
/>
}
/>
<Route
path={relativeSitePaths.développeur.index + '/*'}
element={<Integration />}
/>
<Route
path={relativeSitePaths.nouveautés + '/*'}
element={<Nouveautés />}
/>
<Route path={relativeSitePaths.stats} element={<Stats />} />
<Route path={relativeSitePaths.budget} element={<Budget />} />
<Route
path={relativeSitePaths.accessibilité}
element={<Accessibilité />}
/>
<Route
path="/dev/integration-test"
element={<IntegrationTest />}
/>
<Route path="/dev/personas" element={<Personas />} />
<Route path={relativeSitePaths.plan} element={<Plan />} />
<Route path="*" element={<Route404 />} />
</Routes>
<Spacing xxl />
</ErrorBoundary>
</Container>
</main>
2022-08-03 15:00:50 +00:00
{!isEmbedded && <Footer />}
</StyledLayout>
)
🔥 Migration vers TypeScript Outils ====== Ce commit retire le tooling de Flow, et ajoute le support de TypeScript pour les fichiers .ts et .tsx. Il n'est pas nécessaire de tout migrer d'un coup ce qui facilite la transition. On garde en effet le compilateur Babel avec un preset TypeScript (ce qui permet donc de retirer à la fois les types Flow et TypeScript) plutôt que d'utiliser le compilateur standard pour la conversion du code. Cela permet aussi de mieux s'intégrer avec d'autres outils, notamment les test-runners. Ajout d'une nouvelle commande `yarn run type-check`, intégrée dans CircleCI. Par ailleurs ajout du support de l'opérateur ?? pour donner des valeurs par défaut (nullish-coalescing-operator). Typage des libraires tierces ============================ Les principales libraires que nous utilisons ont un typage TypeScript de bon niveau, ce qui facilite l'intégration. J'ai mis à jour react-i18next et i18next afin de corriger un problème de typage. Typage du code ============== Le typage est loin d'être complet dans ce commit, en particulier il manque les types relatifs au state Redux, ainsi qu'au moteur (règle, explication). Néanmoins le typage des contextes fonctionne, en particulier sitePaths (avec un type récursif non trivial !) qui a déjà permis de détecter un lien mort. Le typage des "paths" (Components/, Règles/, etc.) fonctionne bien, y compris avec l'auto-complétion automatique des import par Typescript. TypeScript se révèle déjà bien agréable dans VSCode (auto-complétion, refacto, etc.) ! Reste à migrer progressivement le reste du code !
2019-10-26 16:21:09 +00:00
}
const StyledLayout = styled.div<{
isEmbedded: boolean
}>`
${({ isEmbedded }) =>
!isEmbedded &&
css`
flex-direction: column;
display: flex;
height: 100%;
`}
`