2.0.3 new logger, robots.txt, experimental html-export

wendevlin · Jun 3, 2024 · feebbd8 · feebbd8
1 parent 5e3135f
commit feebbd8
Show file tree

Hide file tree

Showing 16 changed files with 162 additions and 14 deletions.
diff --git a/homedocs/CHANGELOG.md b/homedocs/CHANGELOG.md
@@ -1,5 +1,11 @@
 <!-- https://developers.home-assistant.io/docs/add-ons/presentation#keeping-a-changelog -->
 
+## 2.0.3
+
+- Add robots.txt disallowing all bots
+- improve logs with date and time
+- Experimental: Add html export all pages at once to print it to PDF
+
 ## 2.0.2
 
 - Fixed serving of assets

diff --git a/homedocs/config.yaml b/homedocs/config.yaml
@@ -1,6 +1,6 @@
 name: Homedocs
 description: Document stuff with Markdown
-version: "2.0.2"
+version: "2.0.3"
 slug: homedocs
 init: false
 url: https://github.com/masterwendu/homeassistant-addons/tree/main/homedocs

diff --git a/homedocs/server/bun.lockb b/homedocs/server/bun.lockb
diff --git a/homedocs/server/package.json b/homedocs/server/package.json
@@ -17,6 +17,8 @@
     "glob": "10.4.1",
     "markdown-it": "14.1.0",
     "markdown-it-emoji": "3.0.0",
+    "pino": "9.1.0",
+    "pino-pretty": "11.1.0",
     "zod": "3.23.8"
   },
   "devDependencies": {

diff --git a/homedocs/server/public/robots.txt b/homedocs/server/public/robots.txt
@@ -0,0 +1,2 @@
+User-agent: *
+Disallow: /
diff --git a/homedocs/server/scripts/build.ts b/homedocs/server/scripts/build.ts
@@ -1,10 +1,11 @@
 // import { build } from "bun"
+import logger from "../src/utils/logger"
 import { buildCss } from "./tailwind"
 
 // build css with tailwind and daisyui
 await buildCss()
 
-console.log('CSS build finished ✓')
+logger.info('CSS build finished ✓')
 
 // build the server
 // TODO use optimized bun build
@@ -14,4 +15,4 @@ console.log('CSS build finished ✓')
 //   target: 'bun',
 // })
 
-console.log('Server build finished ✓')
+logger.info('Server build finished ✓')
diff --git a/homedocs/server/src/fileWatcher.ts b/homedocs/server/src/fileWatcher.ts
@@ -1,6 +1,7 @@
 import chokidar from 'chokidar'
 import { buildDocs } from './htmlBuilder'
 import environmentVariables from './utils/environmentVariables'
+import logger from './utils/logger'
 
 let timeout: Timer | null = null
 
@@ -10,9 +11,9 @@ const triggerNewBuild = async () => {
 	}
 
 	timeout = setTimeout(async () => {
-		console.log('Triggering new build')
+		logger.info('Change detected')
 		await buildDocs()
-		console.log('Docs rebuilt')
+		logger.info('Docs rebuilt')
 	}, 1000)
 }
 
@@ -21,7 +22,7 @@ export const startWatcher = () => {
 		// TODO do not rebuild everything, only if needed
 		triggerNewBuild()
 	})
-	console.log(
+	logger.info(
 		`Watcher started, watching for changes in "${environmentVariables.docsBasePath}" folder`,
 	)
 }
diff --git a/homedocs/server/src/htmlBuilder/index.ts b/homedocs/server/src/htmlBuilder/index.ts
@@ -1,9 +1,13 @@
-import { $ } from 'bun'
+import { $, FileSink } from 'bun'
 import layout from '../templates/layout'
 import { generateNavigation } from '../templates/navigation'
 import environmentVariables from '../utils/environmentVariables'
 import { generateNavForFolder } from './navigation'
-import type { NavigationEntry } from './types'
+import type { Breadcrumb, NavigationEntry } from './types'
+import layoutTop from '../templates/merged/layoutTop'
+import layoutBottom from '../templates/merged/layoutBottom'
+import page from '../templates/merged/page'
+import logger from '../utils/logger'
 
 const buildHtml = async (
 	navigationEntry: NavigationEntry,
@@ -21,7 +25,7 @@ const buildHtml = async (
 	).toString()
 	const fileName = `./dist/docs/${navigationEntry.path || 'index'}.html`
 	await Bun.write(fileName, `<!doctype html>${html}`)
-	console.log(`Built ${fileName}`)
+	logger.info(`Built ${fileName}`)
 }
 
 const buildLevel = async (
@@ -49,3 +53,64 @@ export const buildDocs = async () => {
 
 	await buildLevel(navigationStructure, navigationStructure)
 }
+
+const buildLevelInOnePage = (
+	writer: FileSink,
+	navigationStructure: NavigationEntry[],
+	breadcrumbs: Breadcrumb[] = [],
+) => {
+	for (const navigationEntry of navigationStructure) {
+		if (typeof navigationEntry.htmlContent === 'string') {
+			writer.write(page(
+				navigationEntry.title,
+				navigationEntry.htmlContent,
+				[
+					...breadcrumbs,
+					{
+						name: navigationEntry.title,
+						isFolder: false,
+					},
+				],
+			).toString())
+			writer.flush()
+		}
+
+		if (navigationEntry.children) {
+			buildLevelInOnePage(
+				writer,
+				navigationEntry.children,
+				[
+					...breadcrumbs,
+					{
+						name: navigationEntry.title,
+						isFolder: navigationEntry.htmlContent === undefined,
+					},
+				],
+			)
+		}
+	}
+}
+
+export const buildDocsInOnePage = async () => {
+	const navigationStructure = await generateNavForFolder(
+		environmentVariables.docsBasePath,
+	)
+
+	await Bun.$`rm ./dist/mergedDocs.html`.quiet()
+
+	const file = Bun.file('./dist/mergedDocs.html')
+	const writer = file.writer();
+
+	writer.write(layoutTop)
+	writer.flush()
+
+	buildLevelInOnePage(writer, navigationStructure)
+
+	writer.write(layoutBottom)
+	writer.flush()
+	writer.end()
+
+	return file
+}
+
+await buildDocsInOnePage()
diff --git a/homedocs/server/src/htmlBuilder/types.ts b/homedocs/server/src/htmlBuilder/types.ts
@@ -7,3 +7,8 @@ export type NavigationEntry = {
 	children?: NavigationEntry[]
 	pathPrefix?: string
 }
+
+export type Breadcrumb = {
+	name: string
+	isFolder: boolean
+}
diff --git a/homedocs/server/src/index.ts b/homedocs/server/src/index.ts
@@ -1,5 +1,6 @@
 import { buildCss } from '../scripts/tailwind'
 import { startWatcher } from './fileWatcher'
+import logger from './utils/logger'
 import { webserver } from './webserver'
 
 // 2 parts
@@ -13,15 +14,15 @@ import { webserver } from './webserver'
 
 // if dev mode only rebuild css
 if (process.env.NODE_ENV !== 'production') {
-	console.log('Homedocs is running in development mode')
+	logger.info('Homedocs is running in development mode')
 	await buildCss()
-	console.log('Css built')
+	logger.info('Css built')
 }
 
 startWatcher()
 // await buildDocs()
-// console.log('Initial docs built')
+// logger.info('Initial docs built')
 
 webserver.listen(3000)
 
-console.log(`🦊 Elysia is running at ${webserver.server?.url}`)
+logger.info(`🦊 Elysia is running at ${webserver.server?.url}`)
diff --git a/homedocs/server/src/templates/merged/layoutBottom.ts b/homedocs/server/src/templates/merged/layoutBottom.ts
@@ -0,0 +1,5 @@
+export default `
+			</div>
+		</body>
+	</html>
+`
diff --git a/homedocs/server/src/templates/merged/layoutTop.ts b/homedocs/server/src/templates/merged/layoutTop.ts
@@ -0,0 +1,18 @@
+export default `
+	<html lang="en">
+		<head>
+			<title>Homedocs</title>
+			<meta charset="utf-8" />
+			<meta name="viewport" content="width=device-width, initial-scale=1" />
+			<link rel="stylesheet" href="./main.css" />
+			<link rel="icon" href="./favicon.svg" />
+		</head>
+		<body>
+			<div class="navbar bg-nav dark:bg-nav-dark dark:text-white justify-between">
+				<span class="btn btn-ghost text-xl">
+					<img class="h-8 mr-5" src="./favicon.svg" alt="Homedocs Logo" />
+					Homedocs
+				</span>
+			</div>
+			<div class="flex flex-col items-center justify-start">
+`
diff --git a/homedocs/server/src/templates/merged/page.tsx b/homedocs/server/src/templates/merged/page.tsx
@@ -0,0 +1,28 @@
+import { Breadcrumb } from "../../htmlBuilder/types";
+
+export default (
+	title: string,
+	content: string,
+  breadcrumbs: Breadcrumb[],
+) => (
+  <div class="py-10 px-3 max-w-screen-xl w-full">
+    <div class="text-sm breadcrumbs">
+      <ul>
+        {breadcrumbs.map((breadcrumb) => (
+          <li>
+            <div class="badge badge-outline">
+              {breadcrumb.isFolder ? (
+                <svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" class="w-4 h-4 stroke-current"><title>Folder icon</title><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M3 7v10a2 2 0 002 2h14a2 2 0 002-2V9a2 2 0 00-2-2h-6l-2-2H5a2 2 0 00-2 2z"></path></svg>
+              ) : ''}
+              {breadcrumb.name}
+            </div>
+          </li>
+        ))}
+      </ul>
+    </div>
+    <div class="prose">
+      {content}
+    </div>
+    <div class="divider"></div>
+  </div>
+)
diff --git a/homedocs/server/src/templates/navigation.tsx b/homedocs/server/src/templates/navigation.tsx
@@ -1,4 +1,4 @@
-import type { NavigationEntry } from '../utils/types'
+import type { NavigationEntry } from '../htmlBuilder/types'
 
 const subNavigation = (
 	navigation: NavigationEntry[],

diff --git a/homedocs/server/src/utils/logger.ts b/homedocs/server/src/utils/logger.ts
@@ -0,0 +1,9 @@
+import pino from 'pino'
+import pinoPretty from 'pino-pretty'
+
+const logger = pino(pinoPretty({
+  translateTime: 'yyyy-mm-dd HH:MM:ss.l',
+  ignore: 'pid,level,hostname'
+}))
+
+export default logger
diff --git a/homedocs/server/src/webserver.ts b/homedocs/server/src/webserver.ts
@@ -2,6 +2,7 @@ import type { BunFile } from 'bun'
 import { Elysia } from 'elysia'
 import notFoundPage from './templates/404'
 import environmentVariables from './utils/environmentVariables'
+import { buildDocsInOnePage } from './htmlBuilder'
 
 export const webserver = new Elysia({
 	serve: {
@@ -14,8 +15,12 @@ export const webserver = new Elysia({
 	const fileName = path.split('/').pop() ?? ''
 	if (fileName === 'main.css') {
 		return Bun.file('./dist/main.css')
+	}	else if (fileName === 'robots.txt') {
+		return Bun.file('./public/robots.txt')
 	} else if (fileName.startsWith('favicon')) {
 		return Bun.file('./public/favicon.svg')
+	} else if (path === '/html-export') {
+		return buildDocsInOnePage()
 	} else if (
 		fileName.includes('.') &&
 		(fileName.split('.').pop()?.length ?? 0) > 1