@d-fischer/documen.ts 0.14.1 → 0.14.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/common/components/Badge.js +2 -2
- package/lib/common/components/Badge.js.map +1 -1
- package/lib/common/components/Button.js +2 -2
- package/lib/common/components/Button.js.map +1 -1
- package/lib/common/components/CodeBlock.js +6 -6
- package/lib/common/components/CodeBlock.js.map +1 -1
- package/lib/common/components/CodeLink.js +3 -3
- package/lib/common/components/CodeLink.js.map +1 -1
- package/lib/common/components/DeprecationNotice.js +1 -1
- package/lib/common/components/DeprecationNotice.js.map +1 -1
- package/lib/common/components/FunctionParamDesc.js +2 -2
- package/lib/common/components/FunctionParamDesc.js.map +1 -1
- package/lib/common/components/FunctionParamDescEntry.js +6 -6
- package/lib/common/components/FunctionParamDescEntry.js.map +1 -1
- package/lib/common/components/FunctionReturnType.js +2 -2
- package/lib/common/components/FunctionReturnType.js.map +1 -1
- package/lib/common/components/FunctionSignature.js +1 -1
- package/lib/common/components/FunctionSignature.js.map +1 -1
- package/lib/common/components/InterfaceDetail.js +2 -2
- package/lib/common/components/InterfaceDetail.js.map +1 -1
- package/lib/common/components/InterfaceRepresentation.js +3 -3
- package/lib/common/components/InterfaceRepresentation.js.map +1 -1
- package/lib/common/components/MainMenu.js +17 -12
- package/lib/common/components/MainMenu.js.map +1 -1
- package/lib/common/components/NavMenu.js +2 -2
- package/lib/common/components/NavMenu.js.map +1 -1
- package/lib/common/components/NavMenuGroup.js +1 -1
- package/lib/common/components/NavMenuGroup.js.map +1 -1
- package/lib/common/components/NavMenuItem.js +2 -2
- package/lib/common/components/NavMenuItem.js.map +1 -1
- package/lib/common/components/PageArticle.js +1 -1
- package/lib/common/components/PageArticle.js.map +1 -1
- package/lib/common/components/TypeAliasHint.js +3 -1
- package/lib/common/components/TypeAliasHint.js.map +1 -1
- package/lib/common/components/TypeLink.js +3 -3
- package/lib/common/components/TypeLink.js.map +1 -1
- package/lib/common/components/VersionMenu.js +11 -11
- package/lib/common/components/VersionMenu.js.map +1 -1
- package/lib/common/components/cards/CardToolbar.js +3 -3
- package/lib/common/components/cards/CardToolbar.js.map +1 -1
- package/lib/common/components/cards/EventCard.js +5 -5
- package/lib/common/components/cards/EventCard.js.map +1 -1
- package/lib/common/components/cards/FunctionCardHeader.js +4 -4
- package/lib/common/components/cards/FunctionCardHeader.js.map +1 -1
- package/lib/common/components/cards/MethodCard.js +2 -2
- package/lib/common/components/cards/MethodCard.js.map +1 -1
- package/lib/common/components/cards/PropertyCard.js +5 -5
- package/lib/common/components/cards/PropertyCard.js.map +1 -1
- package/lib/common/components/codeBuilders/Type.js +1 -1
- package/lib/common/components/codeBuilders/Type.js.map +1 -1
- package/lib/common/components/overviewTable/OverviewTable.js +1 -1
- package/lib/common/components/overviewTable/OverviewTable.js.map +1 -1
- package/lib/common/components/overviewTable/OverviewTableEntry.js +4 -4
- package/lib/common/components/overviewTable/OverviewTableEntry.js.map +1 -1
- package/lib/common/config/index.js +1 -1
- package/lib/common/config/index.js.map +1 -1
- package/lib/common/containers/App.js +1 -1
- package/lib/common/containers/App.js.map +1 -1
- package/lib/common/containers/Card.js +2 -2
- package/lib/common/containers/Card.js.map +1 -1
- package/lib/common/containers/PageContent.js +1 -1
- package/lib/common/containers/PageContent.js.map +1 -1
- package/lib/common/containers/PageHeader.js +1 -1
- package/lib/common/containers/PageHeader.js.map +1 -1
- package/lib/common/containers/ReferencePackageContainer.js +9 -9
- package/lib/common/containers/ReferencePackageContainer.js.map +1 -1
- package/lib/common/htmlRenderer/HtmlRenderer.js +1 -1
- package/lib/common/htmlRenderer/HtmlRenderer.js.map +1 -1
- package/lib/common/htmlRenderer/StaticRouterWithSuffix.js +2 -2
- package/lib/common/htmlRenderer/StaticRouterWithSuffix.js.map +1 -1
- package/lib/common/pages/ClassPage.js +9 -9
- package/lib/common/pages/ClassPage.js.map +1 -1
- package/lib/common/pages/DocPage.js +4 -4
- package/lib/common/pages/DocPage.js.map +1 -1
- package/lib/common/pages/EnumPage.js +5 -5
- package/lib/common/pages/EnumPage.js.map +1 -1
- package/lib/common/pages/FunctionPage.js +4 -4
- package/lib/common/pages/FunctionPage.js.map +1 -1
- package/lib/common/pages/InterfacePage.js +5 -5
- package/lib/common/pages/InterfacePage.js.map +1 -1
- package/lib/common/tools/CodeTools.js +1 -1
- package/lib/common/tools/CodeTools.js.map +1 -1
- package/lib/common/tools/FunctionTools.js +1 -1
- package/lib/common/tools/FunctionTools.js.map +1 -1
- package/lib/common/tools/NodeTools.js +3 -3
- package/lib/common/tools/NodeTools.js.map +1 -1
- package/lib/common/tools/ReferenceTools.js +8 -8
- package/lib/common/tools/ReferenceTools.js.map +1 -1
- package/lib/common/tools/markdown/MarkdownParser.js +4 -4
- package/lib/common/tools/markdown/MarkdownParser.js.map +1 -1
- package/lib/common/tools/markdown/plugins/customDirectives.js +2 -2
- package/lib/common/tools/markdown/plugins/customDirectives.js.map +1 -1
- package/lib/common/tools/markdown/plugins/gfmTables.js +1 -1
- package/lib/common/tools/markdown/plugins/gfmTables.js.map +1 -1
- package/lib/common/tools/markdown/plugins/symbolLinks.js +4 -4
- package/lib/common/tools/markdown/plugins/symbolLinks.js.map +1 -1
- package/lib/generator/analyzer/Project.js +9 -9
- package/lib/generator/analyzer/Project.js.map +1 -1
- package/lib/generator/analyzer/createReflection.js +12 -12
- package/lib/generator/analyzer/createReflection.js.map +1 -1
- package/lib/generator/analyzer/createType.js +3 -3
- package/lib/generator/analyzer/createType.js.map +1 -1
- package/lib/generator/analyzer/reflections/AccessorReflection.js +2 -2
- package/lib/generator/analyzer/reflections/AccessorReflection.js.map +1 -1
- package/lib/generator/analyzer/reflections/ClassReflection.js +9 -9
- package/lib/generator/analyzer/reflections/ClassReflection.js.map +1 -1
- package/lib/generator/analyzer/reflections/ConstructorReflection.js +2 -2
- package/lib/generator/analyzer/reflections/ConstructorReflection.js.map +1 -1
- package/lib/generator/analyzer/reflections/EnumReflection.js +1 -1
- package/lib/generator/analyzer/reflections/EnumReflection.js.map +1 -1
- package/lib/generator/analyzer/reflections/FunctionReflection.js +1 -1
- package/lib/generator/analyzer/reflections/FunctionReflection.js.map +1 -1
- package/lib/generator/analyzer/reflections/Heritage.js +1 -1
- package/lib/generator/analyzer/reflections/Heritage.js.map +1 -1
- package/lib/generator/analyzer/reflections/InterfaceReflection.js +7 -7
- package/lib/generator/analyzer/reflections/InterfaceReflection.js.map +1 -1
- package/lib/generator/analyzer/reflections/MethodReflection.js +4 -4
- package/lib/generator/analyzer/reflections/MethodReflection.js.map +1 -1
- package/lib/generator/analyzer/reflections/ParameterReflection.js +8 -8
- package/lib/generator/analyzer/reflections/ParameterReflection.js.map +1 -1
- package/lib/generator/analyzer/reflections/PropertyReflection.js +5 -5
- package/lib/generator/analyzer/reflections/PropertyReflection.js.map +1 -1
- package/lib/generator/analyzer/reflections/SignatureReflection.js +4 -4
- package/lib/generator/analyzer/reflections/SignatureReflection.js.map +1 -1
- package/lib/generator/analyzer/reflections/TypeAliasReflection.js +3 -3
- package/lib/generator/analyzer/reflections/TypeAliasReflection.js.map +1 -1
- package/lib/generator/analyzer/reflections/TypeLiteralReflection.js +2 -2
- package/lib/generator/analyzer/reflections/TypeLiteralReflection.js.map +1 -1
- package/lib/generator/analyzer/reflections/TypeParameterReflection.js +4 -4
- package/lib/generator/analyzer/reflections/TypeParameterReflection.js.map +1 -1
- package/lib/generator/analyzer/types/ArrayType.js +3 -3
- package/lib/generator/analyzer/types/ArrayType.js.map +1 -1
- package/lib/generator/analyzer/types/FunctionType.js +2 -2
- package/lib/generator/analyzer/types/FunctionType.js.map +1 -1
- package/lib/generator/analyzer/types/NamedTupleElementType.js +1 -1
- package/lib/generator/analyzer/types/NamedTupleElementType.js.map +1 -1
- package/lib/generator/analyzer/types/OptionalType.js +1 -1
- package/lib/generator/analyzer/types/OptionalType.js.map +1 -1
- package/lib/generator/analyzer/types/ReferenceType.js +15 -15
- package/lib/generator/analyzer/types/ReferenceType.js.map +1 -1
- package/lib/generator/analyzer/types/TupleType.js +3 -3
- package/lib/generator/analyzer/types/TupleType.js.map +1 -1
- package/lib/generator/analyzer/types/TypeOperatorType.js +5 -5
- package/lib/generator/analyzer/types/TypeOperatorType.js.map +1 -1
- package/lib/generator/analyzer/types/UnionType.js +3 -3
- package/lib/generator/analyzer/types/UnionType.js.map +1 -1
- package/lib/generator/analyzer/util/functions.js +2 -2
- package/lib/generator/analyzer/util/functions.js.map +1 -1
- package/lib/generator/analyzer/util/inheritance.js +2 -2
- package/lib/generator/analyzer/util/inheritance.js.map +1 -1
- package/lib/generator/analyzer/util/promises.js +1 -1
- package/lib/generator/analyzer/util/promises.js.map +1 -1
- package/lib/generator/commands/default.js +41 -41
- package/lib/generator/commands/default.js.map +1 -1
- package/lib/generator/modes/Generator.js +0 -1
- package/lib/generator/modes/Generator.js.map +1 -1
- package/lib/generator/modes/HtmlGenerator.js +12 -13
- package/lib/generator/modes/HtmlGenerator.js.map +1 -1
- package/lib/generator/modes/MonorepoGenerator.js +5 -5
- package/lib/generator/modes/MonorepoGenerator.js.map +1 -1
- package/lib/generator/modes/SpaGenerator.js +6 -6
- package/lib/generator/modes/SpaGenerator.js.map +1 -1
- package/package.json +11 -10
- package/src/common/components/Badge.tsx +1 -1
- package/src/common/components/DeprecationNotice.tsx +1 -1
- package/src/common/components/MainMenu.tsx +11 -3
- package/src/common/components/NavMenu.tsx +1 -1
- package/src/common/components/NavMenuGroup.tsx +1 -1
- package/src/common/components/NavMenuItem.tsx +1 -1
- package/src/common/components/TypeAliasHint.tsx +2 -0
- package/src/common/components/TypeLink.tsx +1 -1
- package/src/common/containers/Card.tsx +1 -1
- package/src/common/containers/PageContent.tsx +1 -1
- package/src/common/containers/PageHeader.tsx +1 -1
- package/src/common/htmlRenderer/StaticRouterWithSuffix.tsx +1 -1
- package/src/spa/registerServiceWorker.ts +3 -3
- package/tsconfig.json +1 -2
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
import { FontAwesomeIcon as Icon } from '@fortawesome/react-fontawesome';
|
|
2
|
+
import { faGithub } from '@fortawesome/free-brands-svg-icons';
|
|
1
3
|
import { makeStyles } from '@material-ui/styles';
|
|
2
4
|
import classNames from 'classnames';
|
|
3
5
|
import React, { useContext, useMemo } from 'react';
|
|
@@ -13,8 +15,8 @@ const useStyles = makeStyles(
|
|
|
13
15
|
display: 'flex'
|
|
14
16
|
},
|
|
15
17
|
entry: {
|
|
16
|
-
margin:
|
|
17
|
-
padding: theme.spacing.unit
|
|
18
|
+
margin: 0,
|
|
19
|
+
padding: `${theme.spacing.unit}px ${theme.spacing.unit * 2}px`,
|
|
18
20
|
cursor: 'pointer',
|
|
19
21
|
textDecoration: 'none',
|
|
20
22
|
userSelect: 'none',
|
|
@@ -66,6 +68,7 @@ const useStyles = makeStyles(
|
|
|
66
68
|
borderBottom: '0 none',
|
|
67
69
|
margin: 0,
|
|
68
70
|
borderLeft: '3px solid transparent',
|
|
71
|
+
whiteSpace: 'nowrap',
|
|
69
72
|
|
|
70
73
|
'&:first-child': {
|
|
71
74
|
borderTop: '0 none'
|
|
@@ -142,9 +145,14 @@ const MainMenu: React.FC = () => {
|
|
|
142
145
|
))}
|
|
143
146
|
</div>
|
|
144
147
|
</div>
|
|
148
|
+
<div className={classes.spacer} />
|
|
149
|
+
{config.repoUser && config.repoName ? (
|
|
150
|
+
<a href={`https://github.com/${config.repoUser}/${config.repoName}`} className={classes.entry}>
|
|
151
|
+
<Icon icon={faGithub} />
|
|
152
|
+
</a>
|
|
153
|
+
) : null}
|
|
145
154
|
{config.versionBranchPrefix ? (
|
|
146
155
|
<>
|
|
147
|
-
<div className={classes.spacer} />
|
|
148
156
|
<VersionMenu />
|
|
149
157
|
</>
|
|
150
158
|
) : null}
|
|
@@ -13,7 +13,7 @@ interface NavMenuProps {
|
|
|
13
13
|
className?: string;
|
|
14
14
|
}
|
|
15
15
|
|
|
16
|
-
const NavMenu: React.FC<NavMenuProps
|
|
16
|
+
const NavMenu: React.FC<React.PropsWithChildren<NavMenuProps>> = ({ children, className }) => {
|
|
17
17
|
const classes = useStyles();
|
|
18
18
|
return (
|
|
19
19
|
<div className={classNames(classes.root, className)}>
|
|
@@ -27,7 +27,7 @@ const useStyles = makeStyles(({ colors: { text: textColor }, spacing: { unit: sp
|
|
|
27
27
|
}
|
|
28
28
|
}), { name: 'NavMenuGroup' });
|
|
29
29
|
|
|
30
|
-
const NavMenuGroup: React.FC<NavMenuGroupProps
|
|
30
|
+
const NavMenuGroup: React.FC<React.PropsWithChildren<NavMenuGroupProps>> = ({ title, children }) => {
|
|
31
31
|
const classes = useStyles();
|
|
32
32
|
return (
|
|
33
33
|
<div className={classes.root}>
|
|
@@ -39,7 +39,7 @@ const useStyles = makeStyles(
|
|
|
39
39
|
{ name: 'NavMenuItem' }
|
|
40
40
|
);
|
|
41
41
|
|
|
42
|
-
const NavMenuItem: React.FC<NavMenuItemProps
|
|
42
|
+
const NavMenuItem: React.FC<React.PropsWithChildren<NavMenuItemProps>> = ({ path, external, title, children }) => {
|
|
43
43
|
const classes = useStyles();
|
|
44
44
|
if (external) {
|
|
45
45
|
return (
|
|
@@ -8,6 +8,7 @@ interface TypeAliasHintProps {
|
|
|
8
8
|
symbol: TypeAliasReferenceNode;
|
|
9
9
|
}
|
|
10
10
|
|
|
11
|
+
/* eslint-disable @typescript-eslint/naming-convention */
|
|
11
12
|
const useStyles = makeStyles(theme => ({
|
|
12
13
|
root: {
|
|
13
14
|
position: 'relative',
|
|
@@ -78,6 +79,7 @@ const useStyles = makeStyles(theme => ({
|
|
|
78
79
|
fontFamily: theme.fonts.code
|
|
79
80
|
}
|
|
80
81
|
}), { name: 'TypeAliasHint' });
|
|
82
|
+
/* eslint-enable @typescript-eslint/naming-convention */
|
|
81
83
|
|
|
82
84
|
const TypeAliasHint: React.FC<TypeAliasHintProps> = ({ symbol: { comment, name, type } }) => {
|
|
83
85
|
const classes = useStyles();
|
|
@@ -20,7 +20,7 @@ const useStyles = makeStyles(theme => ({
|
|
|
20
20
|
}
|
|
21
21
|
}), { name: 'TypeLink' });
|
|
22
22
|
|
|
23
|
-
const TypeLink: React.FC<TypeLinkProps
|
|
23
|
+
const TypeLink: React.FC<React.PropsWithChildren<TypeLinkProps>> = ({ id, name, children, symbol }) => {
|
|
24
24
|
const classes = useStyles();
|
|
25
25
|
|
|
26
26
|
let packageName: string | undefined = undefined;
|
|
@@ -28,7 +28,7 @@ const useStyles = makeStyles(theme => ({
|
|
|
28
28
|
}
|
|
29
29
|
}), { name: 'Card' });
|
|
30
30
|
|
|
31
|
-
const Card: React.FC<CardProps
|
|
31
|
+
const Card: React.FC<React.PropsWithChildren<CardProps>> = ({ className, id, children }) => {
|
|
32
32
|
const classes = useStyles();
|
|
33
33
|
return (
|
|
34
34
|
<div id={id} className={classNames(classes.root, className)}>
|
|
@@ -15,7 +15,7 @@ const useStyles = makeStyles(theme => ({
|
|
|
15
15
|
}
|
|
16
16
|
}), { name: 'PageContent' });
|
|
17
17
|
|
|
18
|
-
const PageContent: React.FC = ({ children }) => {
|
|
18
|
+
const PageContent: React.FC<React.PropsWithChildren<{}>> = ({ children }) => {
|
|
19
19
|
const classes = useStyles();
|
|
20
20
|
return (
|
|
21
21
|
<div className={classes.root}>
|
|
@@ -21,7 +21,7 @@ const useStyles = makeStyles(theme => ({
|
|
|
21
21
|
}
|
|
22
22
|
}), { name: 'PageHeader' });
|
|
23
23
|
|
|
24
|
-
const PageHeader: React.FC = ({ children }) => {
|
|
24
|
+
const PageHeader: React.FC<React.PropsWithChildren<{}>> = ({ children }) => {
|
|
25
25
|
const classes = useStyles();
|
|
26
26
|
return (
|
|
27
27
|
<div className={classes.root}>
|
|
@@ -34,7 +34,7 @@ const createUrl = (location: To, suffix?: string): string => {
|
|
|
34
34
|
return createPath(location);
|
|
35
35
|
};
|
|
36
36
|
|
|
37
|
-
const StaticRouterWithSuffix: React.FunctionComponent<StaticRouterWithSuffixProps
|
|
37
|
+
const StaticRouterWithSuffix: React.FunctionComponent<React.PropsWithChildren<StaticRouterWithSuffixProps>> = ({ children, location: loc, suffix, basename }) => {
|
|
38
38
|
if (typeof loc === 'string') {
|
|
39
39
|
loc = parsePath(loc);
|
|
40
40
|
}
|
|
@@ -18,7 +18,7 @@ const isLocalhost = Boolean(
|
|
|
18
18
|
);
|
|
19
19
|
|
|
20
20
|
async function registerValidServiceWorker(swUrl: string) {
|
|
21
|
-
|
|
21
|
+
await navigator.serviceWorker
|
|
22
22
|
.register(swUrl)
|
|
23
23
|
.then(registration => {
|
|
24
24
|
registration.onupdatefound = () => {
|
|
@@ -73,7 +73,7 @@ async function checkValidServiceWorker(swUrl: string) {
|
|
|
73
73
|
}
|
|
74
74
|
|
|
75
75
|
export default async function registerServiceWorker() {
|
|
76
|
-
|
|
76
|
+
await new Promise<void>((resolve, reject) => {
|
|
77
77
|
if (process.env.NODE_ENV === 'production' && 'serviceWorker' in navigator) {
|
|
78
78
|
// The URL constructor is available in all browsers that support SW.
|
|
79
79
|
const publicUrl = new URL(
|
|
@@ -110,7 +110,7 @@ export default async function registerServiceWorker() {
|
|
|
110
110
|
export async function unregister() {
|
|
111
111
|
if ('serviceWorker' in navigator) {
|
|
112
112
|
const registration = await navigator.serviceWorker.ready;
|
|
113
|
-
return registration.unregister();
|
|
113
|
+
return await registration.unregister();
|
|
114
114
|
}
|
|
115
115
|
return false;
|
|
116
116
|
}
|