@d-fischer/documen.ts 0.14.0 → 0.14.3

package/src/common/components/DeprecationNotice.tsx

@@ -11,7 +11,7 @@ const useStyles = makeStyles(theme => ({
 	},
 }), { name: 'DeprecationNotice' });
 
-const DeprecationNotice: React.FC = ({ children }) => {
+const DeprecationNotice: React.FC<React.PropsWithChildren<{}>> = ({ children }) => {
 	const classes = useStyles();
 	return (
 		<div className={classes.root}>

package/src/common/components/MainMenu.tsx

@@ -1,3 +1,5 @@
+import { FontAwesomeIcon as Icon } from '@fortawesome/react-fontawesome';
+import { faGithub } from '@fortawesome/free-brands-svg-icons';
 import { makeStyles } from '@material-ui/styles';
 import classNames from 'classnames';
 import React, { useContext, useMemo } from 'react';
@@ -13,8 +15,8 @@ const useStyles = makeStyles(
 			display: 'flex'
 		},
 		entry: {
-			margin: `0 ${theme.spacing.unit}px`,
-			padding: theme.spacing.unit,
+			margin: 0,
+			padding: `${theme.spacing.unit}px ${theme.spacing.unit * 2}px`,
 			cursor: 'pointer',
 			textDecoration: 'none',
 			userSelect: 'none',
@@ -66,6 +68,7 @@ const useStyles = makeStyles(
 			borderBottom: '0 none',
 			margin: 0,
 			borderLeft: '3px solid transparent',
+			whiteSpace: 'nowrap',
 
 			'&:first-child': {
 				borderTop: '0 none'
@@ -142,9 +145,14 @@ const MainMenu: React.FC = () => {
 					))}
 				</div>
 			</div>
+			<div className={classes.spacer} />
+			{config.repoUser && config.repoName ? (
+				<a href={`https://github.com/${config.repoUser}/${config.repoName}`} className={classes.entry}>
+					<Icon icon={faGithub} />
+				</a>
+			) : null}
 			{config.versionBranchPrefix ? (
 				<>
-					<div className={classes.spacer} />
 					<VersionMenu />
 				</>
 			) : null}

package/src/common/components/NavMenu.tsx

@@ -13,7 +13,7 @@ interface NavMenuProps {
 	className?: string;
 }
 
-const NavMenu: React.FC<NavMenuProps> = ({ children, className }) => {
+const NavMenu: React.FC<React.PropsWithChildren<NavMenuProps>> = ({ children, className }) => {
 	const classes = useStyles();
 	return (
 		<div className={classNames(classes.root, className)}>

package/src/common/components/NavMenuGroup.tsx

@@ -27,7 +27,7 @@ const useStyles = makeStyles(({ colors: { text: textColor }, spacing: { unit: sp
 	}
 }), { name: 'NavMenuGroup' });
 
-const NavMenuGroup: React.FC<NavMenuGroupProps> = ({ title, children }) => {
+const NavMenuGroup: React.FC<React.PropsWithChildren<NavMenuGroupProps>> = ({ title, children }) => {
 	const classes = useStyles();
 	return (
 		<div className={classes.root}>

package/src/common/components/NavMenuItem.tsx

@@ -39,7 +39,7 @@ const useStyles = makeStyles(
 	{ name: 'NavMenuItem' }
 );
 
-const NavMenuItem: React.FC<NavMenuItemProps> = ({ path, external, title, children }) => {
+const NavMenuItem: React.FC<React.PropsWithChildren<NavMenuItemProps>> = ({ path, external, title, children }) => {
 	const classes = useStyles();
 	if (external) {
 		return (

package/src/common/components/TypeAliasHint.tsx

@@ -8,6 +8,7 @@ interface TypeAliasHintProps {
 	symbol: TypeAliasReferenceNode;
 }
 
+/* eslint-disable @typescript-eslint/naming-convention */
 const useStyles = makeStyles(theme => ({
 	root: {
 		position: 'relative',
@@ -78,6 +79,7 @@ const useStyles = makeStyles(theme => ({
 		fontFamily: theme.fonts.code
 	}
 }), { name: 'TypeAliasHint' });
+/* eslint-enable @typescript-eslint/naming-convention */
 
 const TypeAliasHint: React.FC<TypeAliasHintProps> = ({ symbol: { comment, name, type } }) => {
 	const classes = useStyles();

package/src/common/components/TypeLink.tsx

@@ -20,7 +20,7 @@ const useStyles = makeStyles(theme => ({
 	}
 }), { name: 'TypeLink' });
 
-const TypeLink: React.FC<TypeLinkProps> = ({ id, name, children, symbol }) => {
+const TypeLink: React.FC<React.PropsWithChildren<TypeLinkProps>> = ({ id, name, children, symbol }) => {
 	const classes = useStyles();
 
 	let packageName: string | undefined = undefined;

package/src/common/containers/App.tsx

@@ -7,11 +7,10 @@ import ReferencePackageContainer from './ReferencePackageContainer';
 
 const App: React.FunctionComponent = () => {
 	const config = useContext(ConfigContext);
-	const baseUrl = `/${(config.baseUrl || '').replace(/^\//, '')}`;
 	const isMono = !!config.monorepoRoot;
 	return (
 		<>
-			<Routes basename={baseUrl}>
+			<Routes>
 				<Route element={<AppLayout />}>
 					<Route path="" element={<DocPage/>}/>
 					<Route path={isMono ? 'reference/:packageName/*' : '/reference/*'} element={<ReferencePackageContainer/>}/>

package/src/common/containers/Card.tsx

@@ -28,7 +28,7 @@ const useStyles = makeStyles(theme => ({
 	}
 }), { name: 'Card' });
 
-const Card: React.FC<CardProps> = ({ className, id, children }) => {
+const Card: React.FC<React.PropsWithChildren<CardProps>> = ({ className, id, children }) => {
 	const classes = useStyles();
 	return (
 		<div id={id} className={classNames(classes.root, className)}>

package/src/common/containers/PageContent.tsx

@@ -15,7 +15,7 @@ const useStyles = makeStyles(theme => ({
 	}
 }), { name: 'PageContent' });
 
-const PageContent: React.FC = ({ children }) => {
+const PageContent: React.FC<React.PropsWithChildren<{}>> = ({ children }) => {
 	const classes = useStyles();
 	return (
 		<div className={classes.root}>

package/src/common/containers/PageHeader.tsx

@@ -21,7 +21,7 @@ const useStyles = makeStyles(theme => ({
 	}
 }), { name: 'PageHeader' });
 
-const PageHeader: React.FC = ({ children }) => {
+const PageHeader: React.FC<React.PropsWithChildren<{}>> = ({ children }) => {
 	const classes = useStyles();
 	return (
 		<div className={classes.root}>

package/src/common/htmlRenderer/HtmlRenderer.tsx

@@ -70,7 +70,7 @@ const render = (url: string, config: Config, article?: ArticleContent) => {
 				<ConfigContext.Provider value={config}>
 					<PageArticleContext.Provider value={article}>
 						<ThemeProvider theme={theme}>
-							<StaticRouterWithSuffix location={joinedUrl} suffix=".html">
+							<StaticRouterWithSuffix basename={baseUrl} location={joinedUrl} suffix=".html">
 								<App/>
 							</StaticRouterWithSuffix>
 						</ThemeProvider>

package/src/common/htmlRenderer/StaticRouterWithSuffix.tsx

@@ -1,10 +1,11 @@
-import type { Location, PartialLocation, To } from 'history';
-import { Action, createPath, parsePath } from 'history';
+import type { Location, To } from 'history';
+import { createPath, parsePath } from 'history';
 import React from 'react';
 import { Router } from 'react-router';
 
 interface StaticRouterWithSuffixProps {
-	location: string | PartialLocation;
+	basename?: string;
+	location: string | Partial<Location>;
 	suffix?: string;
 }
 
@@ -33,12 +34,11 @@ const createUrl = (location: To, suffix?: string): string => {
 	return createPath(location);
 };
 
-const StaticRouterWithSuffix: React.FunctionComponent<StaticRouterWithSuffixProps> = ({ children, location: loc, suffix }) => {
+const StaticRouterWithSuffix: React.FunctionComponent<React.PropsWithChildren<StaticRouterWithSuffixProps>> = ({ children, location: loc, suffix, basename }) => {
 	if (typeof loc === 'string') {
 		loc = parsePath(loc);
 	}
 
-	const action = Action.Pop;
 	let location: Location = {
 		pathname: loc.pathname ?? '/',
 		search: loc.search ?? '',
@@ -99,7 +99,7 @@ const StaticRouterWithSuffix: React.FunctionComponent<StaticRouterWithSuffixProp
 
 	return (
 		<Router
-			action={action}
+			basename={basename}
 			location={location}
 			navigator={staticNavigator}
 			static={true}

package/src/spa/registerServiceWorker.ts

@@ -18,7 +18,7 @@ const isLocalhost = Boolean(
 );
 
 async function registerValidServiceWorker(swUrl: string) {
-	return navigator.serviceWorker
+	await navigator.serviceWorker
 		.register(swUrl)
 		.then(registration => {
 			registration.onupdatefound = () => {
@@ -73,7 +73,7 @@ async function checkValidServiceWorker(swUrl: string) {
 }
 
 export default async function registerServiceWorker() {
-	return new Promise<void>((resolve, reject) => {
+	await new Promise<void>((resolve, reject) => {
 		if (process.env.NODE_ENV === 'production' && 'serviceWorker' in navigator) {
 			// The URL constructor is available in all browsers that support SW.
 			const publicUrl = new URL(
@@ -110,7 +110,7 @@ export default async function registerServiceWorker() {
 export async function unregister() {
 	if ('serviceWorker' in navigator) {
 		const registration = await navigator.serviceWorker.ready;
-		return registration.unregister();
+		return await registration.unregister();
 	}
 	return false;
 }

package/tsconfig.json

@@ -6,8 +6,7 @@
 		"lib": [
 			"dom",
 			"dom.iterable",
-			"es2017",
-			"esnext.array"
+			"es2019"
 		],
 		"sourceMap": true,
 		"allowJs": true,