@d-fischer/documen.ts 0.16.9 → 0.17.0

package/src/common/tools/markdown/plugins/customDirectives.ts

@@ -1,5 +1,5 @@
+import { type Nodes as MdastNodes } from 'mdast';
 import { toHast } from 'mdast-util-to-hast';
-import { type MdastNodes } from 'mdast-util-to-hast/lib';
 import remarkDirective from 'remark-directive';
 import type { Processor, Transformer } from 'unified';
 import type { Node } from 'unist';

package/src/common/tools/markdown/plugins/symbolLinks.ts

@@ -2,9 +2,9 @@ import type { Content, Link, Text } from 'mdast';
 import type { Transformer } from 'unified';
 import type { Parent } from 'unist';
 import { visit } from 'unist-util-visit';
-import { getPageType } from '../../CodeTools';
-import { findSymbolByMember } from '../../ReferenceTools';
-import { getPackagePath } from '../../StringTools';
+import { getPageType } from '../../CodeTools.js';
+import { findSymbolByMember } from '../../ReferenceTools.js';
+import { getPackagePath } from '../../StringTools.js';
 
 function insertAt(array: Parent['children'], index: number, ...items: Content[]): Parent['children'] {
 	return [...array.slice(0, index), ...items, ...array.slice(index)];

package/src/dev/index.tsx

@@ -3,14 +3,13 @@ import js from '@d-fischer/react-syntax-highlighter/dist/esm/languages/hljs/java
 import json from '@d-fischer/react-syntax-highlighter/dist/esm/languages/hljs/json';
 import ts from '@d-fischer/react-syntax-highlighter/dist/esm/languages/hljs/typescript';
 import { ThemeProvider } from '@mui/styles';
-import React from 'react';
-import ReactDOM from 'react-dom';
-import { BrowserRouter, HashRouter } from 'react-router-dom';
+import { createRoot } from 'react-dom/client';
+import { BrowserRouter, HashRouter } from 'react-router';
 
-import App from '../common/containers/App';
-import theme from '../common/theme';
+import App from '../common/containers/App.js';
+import theme from '../common/theme.js';
 
-import registerServiceWorker from './registerServiceWorker';
+import registerServiceWorker from './registerServiceWorker.js';
 
 const Router = process.env.SUPPORTS_DYNAMIC_ROUTING ? BrowserRouter : HashRouter;
 
@@ -20,13 +19,14 @@ SyntaxHighlighter.registerLanguage('json', json);
 SyntaxHighlighter.registerLanguage('typescript', ts);
 SyntaxHighlighter.registerLanguage('ts', ts);
 
-ReactDOM.render(
+const root = createRoot(document.getElementById('app-root'));
+
+root.render(
 	<ThemeProvider theme={theme}>
 		<Router>
 			<App />
 		</Router>
-	</ThemeProvider>,
-	document.getElementById('app-root')
+	</ThemeProvider>
 );
 
 // eslint-disable-next-line no-console

package/src/dev/registerServiceWorker.ts

@@ -1,4 +1,4 @@
-/* eslint-disable no-console,consistent-return */
+/* eslint-disable no-console */
 // In production, we register a service worker to serve assets from local cache.
 
 // This lets the app load faster on subsequent visits in production, and gives
@@ -11,10 +11,10 @@
 
 const isLocalhost = Boolean(
 	window.location.hostname === 'localhost' ||
-	// [::1] is the IPv6 localhost address.
-	window.location.hostname === '[::1]' ||
-	// 127.0.0.1/8 is considered localhost for IPv4.
-	/^127(?:\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}$/.exec(window.location.hostname)
+		// [::1] is the IPv6 localhost address.
+		window.location.hostname === '[::1]' ||
+		// 127.0.0.1/8 is considered localhost for IPv4.
+		/^127(?:\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}$/.exec(window.location.hostname)
 );
 
 async function registerValidServiceWorker(swUrl: string) {
@@ -53,10 +53,7 @@ async function checkValidServiceWorker(swUrl: string) {
 		// Check if the service worker can be found. If it can't, reload the page.
 		const response = await fetch(swUrl);
 		// Ensure service worker exists, and that we really are getting a JS file.
-		if (
-			response.status === 404 ||
-			!response.headers.get('content-type')!.includes('javascript')
-		) {
+		if (response.status === 404 || !response.headers.get('content-type')!.includes('javascript')) {
 			// No service worker found. Probably a different app. Reload the page.
 			const registration = await navigator.serviceWorker.ready;
 			await registration.unregister();
@@ -66,9 +63,7 @@ async function checkValidServiceWorker(swUrl: string) {
 			await registerValidServiceWorker(swUrl);
 		}
 	} catch (e) {
-		console.log(
-			'No internet connection found. App is running in offline mode.'
-		);
+		console.log('No internet connection found. App is running in offline mode.');
 	}
 }
 
@@ -76,10 +71,7 @@ export default async function registerServiceWorker() {
 	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(
-				process.env.PUBLIC_URL!,
-				window.location.toString()
-			);
+			const publicUrl = new URL(process.env.PUBLIC_URL!, window.location.toString());
 			if (publicUrl.origin !== window.location.origin) {
 				// Our service worker won't work if PUBLIC_URL is on a different origin
 				// from what our page is served on. This might happen if a CDN is used to

package/src/progressiveEnhancement/fsMap.ts

@@ -1,4 +1,3 @@
-// eslint-disable-next-line @typescript-eslint/naming-convention
 declare const __DOCTS_FSMAP: Array<[string, string]>;
 export const fsMap = new Map(__DOCTS_FSMAP);
 

package/src/progressiveEnhancement/index.tsx

@@ -1,15 +1,13 @@
 import { createGenerateClassName, StylesProvider, ThemeProvider } from '@mui/styles';
-import * as React from 'react';
-import * as ReactDOM from 'react-dom';
-import { CodeBlock } from '../common/components/CodeBlock';
-import VersionMenu from '../common/components/VersionMenu';
-import theme from '../common/theme';
+import { CodeBlock } from '../common/components/CodeBlock.js';
+import VersionMenu from '../common/components/VersionMenu.js';
+import theme from '../common/theme.js';
+import { type ComponentType } from 'react';
+import { createRoot } from 'react-dom/client';
 
 const registeredComponents = {
-	/* eslint-disable @typescript-eslint/naming-convention */
 	CodeBlock,
 	VersionMenu
-	/* eslint-enable @typescript-eslint/naming-convention */
 };
 
 const generateClassName = createGenerateClassName({
@@ -17,16 +15,16 @@ const generateClassName = createGenerateClassName({
 });
 
 for (const elem of document.querySelectorAll<HTMLElement>('[data-dynamic-component]')) {
-	const Component = registeredComponents[elem.dataset.dynamicComponent!] as React.ComponentType | undefined;
+	const Component = registeredComponents[elem.dataset.dynamicComponent!] as ComponentType | undefined;
 	if (Component) {
 		const props = JSON.parse(elem.dataset.componentProps ?? '{}') as JSX.IntrinsicAttributes;
-		ReactDOM.render(
+		const root = createRoot(elem);
+		root.render(
 			<StylesProvider generateClassName={generateClassName}>
 				<ThemeProvider theme={theme}>
 					<Component {...props} />
 				</ThemeProvider>
-			</StylesProvider>,
-			elem
+			</StylesProvider>
 		);
 	}
 }

package/tsconfig-dev.json

@@ -1,12 +1,7 @@
 {
 	"extends": "./tsconfig.json",
 	"outDir": "tmp",
-	"include": [
-		"types",
-		"src/common",
-		"src/dev",
-		"vite.config.dev.ts"
-	],
+	"include": ["types", "src/common", "src/dev", "vite.config.dev.ts"],
 	"compilerOptions": {
 		"importHelpers": false
 	}

package/tsconfig-enhance.json

@@ -1,10 +1,6 @@
 {
 	"extends": "./tsconfig.json",
-	"include": [
-		"types",
-		"src/common",
-		"src/progressiveEnhancement"
-	],
+	"include": ["types", "src/common", "src/progressiveEnhancement"],
 	"compilerOptions": {
 		"module": "esnext"
 	}

package/tsconfig-html.json

@@ -1,10 +1,6 @@
 {
 	"extends": "./tsconfig.json",
-	"include": [
-		"types",
-		"src/common",
-		"src/html"
-	],
+	"include": ["types", "src/common", "src/html"],
 	"compilerOptions": {
 		"importHelpers": false
 	}

package/tsconfig.json

@@ -1,17 +1,13 @@
 {
 	"compilerOptions": {
 		"outDir": "lib",
-		"module": "commonjs",
-		"target": "es6",
-		"lib": [
-			"dom",
-			"dom.iterable",
-			"es2019"
-		],
+		"module": "node16",
+		"moduleResolution": "node16",
+		"target": "es2022",
+		"lib": ["dom", "dom.iterable", "es2022"],
 		"sourceMap": true,
 		"allowJs": true,
-		"jsx": "react",
-		"moduleResolution": "node",
+		"jsx": "react-jsx",
 		"rootDir": "src",
 		"forceConsistentCasingInFileNames": true,
 		"strict": true,
@@ -22,16 +18,6 @@
 		"esModuleInterop": true,
 		"skipLibCheck": true
 	},
-	"include": [
-		"types",
-		"src/common",
-		"src/generator"
-	],
-	"exclude": [
-		"node_modules",
-		"build",
-		"scripts",
-		"config",
-		"vite.config.dev.ts"
-	]
+	"include": ["types", "src/common", "src/generator"],
+	"exclude": ["node_modules", "build", "scripts", "config", "vite.config.dev.ts"]
 }

package/types/globals.d.ts

@@ -1,2 +1 @@
-// eslint-disable-next-line @typescript-eslint/naming-convention
 declare const __DOCTS_COMPONENT_MODE: 'static' | 'dynamic';

package/types/react-router-hash-link.d.ts

@@ -1,8 +0,0 @@
-declare module 'react-router-hash-link' {
-	import type { LinkProps, NavLinkProps } from 'react-router-dom';
-
-	const HashLink: React.ComponentType<LinkProps>;
-	const NavHashLink: React.ComponentType<NavLinkProps>;
-
-	export { HashLink, NavHashLink };
-}