File size: 7,921 Bytes
bde76b9 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 | import http from 'node:http'
import path from 'node:path'
import { existsSync } from 'node:fs'
import { promises as fs } from 'node:fs'
export type Language = 'en' | 'zh'
export type CoursePage = {
filePath: string
routePath: string
titleHint: string
}
export type ScreenshotTarget = {
language: Language
routePath: string
outputName: string
}
export const repoRoot = process.cwd()
export const docsRoot = path.resolve(repoRoot, 'docs')
export const distRoot = path.resolve(repoRoot, 'docs/.vitepress/dist')
export const artifactsRoot = path.resolve(repoRoot, 'artifacts')
export const pdfOutputRoot = path.resolve(artifactsRoot, 'pdfs')
export const readmeScreenshotsRoot = path.resolve(docsRoot, 'public/screenshots/readme')
export const docsBasePath = normalizeBasePath(
process.env.DOCS_BASE_PATH || '/learn-harness-engineering/'
)
const MIME_TYPES: Record<string, string> = {
'.css': 'text/css; charset=utf-8',
'.html': 'text/html; charset=utf-8',
'.ico': 'image/x-icon',
'.jpeg': 'image/jpeg',
'.jpg': 'image/jpeg',
'.js': 'text/javascript; charset=utf-8',
'.json': 'application/json; charset=utf-8',
'.md': 'text/markdown; charset=utf-8',
'.png': 'image/png',
'.svg': 'image/svg+xml',
'.txt': 'text/plain; charset=utf-8',
'.woff': 'font/woff',
'.woff2': 'font/woff2'
}
export const readmeScreenshotTargets: ScreenshotTarget[] = [
{ language: 'en', routePath: '/en/', outputName: 'en-home.png' },
{
language: 'en',
routePath: '/en/lectures/lecture-01-why-capable-agents-still-fail/',
outputName: 'en-lecture-01.png'
},
{ language: 'en', routePath: '/en/resources/', outputName: 'en-resources.png' },
{ language: 'zh', routePath: '/zh/', outputName: 'zh-home.png' },
{
language: 'zh',
routePath: '/zh/lectures/lecture-01-why-capable-agents-still-fail/',
outputName: 'zh-lecture-01.png'
},
{ language: 'zh', routePath: '/zh/resources/', outputName: 'zh-resources.png' }
]
export async function ensureDirectory(targetPath: string) {
await fs.mkdir(targetPath, { recursive: true })
}
export function toAbsoluteSiteUrl(origin: string, routePath: string) {
const normalizedOrigin = origin.replace(/\/$/, '')
const normalizedRoute = routePath.startsWith('/') ? routePath : `/${routePath}`
return `${normalizedOrigin}${docsBasePath.replace(/\/$/, '')}${normalizedRoute}`
}
export async function discoverCoursePages(language: Language): Promise<CoursePage[]> {
const languageRoot = path.resolve(docsRoot, language)
const files = await walkMarkdownFiles(languageRoot)
return files
.filter((filePath) => shouldIncludeInCoursePdf(path.relative(languageRoot, filePath).replace(/\\/g, '/')))
.sort((left, right) => compareCourseFiles(language, left, right))
.map((filePath) => ({
filePath,
routePath: sourceFileToRoutePath(language, filePath),
titleHint: path.basename(filePath, '.md')
}))
}
export async function startStaticServer(rootDir = distRoot) {
const server = http.createServer(async (request, response) => {
try {
const requestUrl = new URL(request.url || '/', 'http://127.0.0.1')
const filePath = resolveStaticFilePath(rootDir, requestUrl.pathname)
if (!filePath) {
response.statusCode = 404
response.end('Not Found')
return
}
const data = await fs.readFile(filePath)
const ext = path.extname(filePath)
response.setHeader('Content-Type', MIME_TYPES[ext] || 'application/octet-stream')
response.end(data)
} catch (error) {
response.statusCode = 500
response.end(error instanceof Error ? error.message : 'Unknown server error')
}
})
const address = await new Promise<http.AddressInfo>((resolve, reject) => {
server.once('error', reject)
server.listen(0, '127.0.0.1', () => {
const currentAddress = server.address()
if (!currentAddress || typeof currentAddress === 'string') {
reject(new Error('Failed to bind static export server'))
return
}
resolve(currentAddress)
})
})
return {
origin: `http://127.0.0.1:${address.port}`,
close: async () =>
await new Promise<void>((resolve, reject) => {
server.close((error) => {
if (error) {
reject(error)
return
}
resolve()
})
})
}
}
function normalizeBasePath(input: string) {
const withLeadingSlash = input.startsWith('/') ? input : `/${input}`
return withLeadingSlash.endsWith('/') ? withLeadingSlash : `${withLeadingSlash}/`
}
async function walkMarkdownFiles(targetDir: string): Promise<string[]> {
const entries = await fs.readdir(targetDir, { withFileTypes: true })
const nested = await Promise.all(
entries.map(async (entry) => {
const fullPath = path.join(targetDir, entry.name)
if (entry.isDirectory()) {
return await walkMarkdownFiles(fullPath)
}
if (entry.isFile() && entry.name.endsWith('.md')) {
return [fullPath]
}
return []
})
)
return nested.flat()
}
function shouldIncludeInCoursePdf(relativePath: string) {
if (relativePath.includes('/code/')) return false
if (relativePath === 'index.md') return true
if (relativePath.startsWith('lectures/')) return true
if (relativePath.startsWith('projects/')) return true
if (relativePath === 'resources/index.md') return true
if (relativePath === 'resources/templates/index.md') return true
if (relativePath.startsWith('resources/reference/')) return true
if (relativePath.startsWith('resources/openai-advanced/')) return true
return false
}
function compareCourseFiles(language: Language, left: string, right: string) {
const languageRoot = path.resolve(docsRoot, language)
const leftRelative = path.relative(languageRoot, left).replace(/\\/g, '/')
const rightRelative = path.relative(languageRoot, right).replace(/\\/g, '/')
const leftWeight = sortWeight(leftRelative)
const rightWeight = sortWeight(rightRelative)
if (leftWeight !== rightWeight) return leftWeight - rightWeight
return leftRelative.localeCompare(rightRelative)
}
function sortWeight(relativePath: string) {
if (relativePath === 'index.md') return 0
if (relativePath.startsWith('lectures/')) return 1
if (relativePath.startsWith('projects/')) return 2
if (relativePath === 'resources/index.md') return 3
if (relativePath.startsWith('resources/templates/')) return 4
if (relativePath.startsWith('resources/reference/')) return 5
if (relativePath.startsWith('resources/openai-advanced/')) return 6
return 99
}
function sourceFileToRoutePath(language: Language, filePath: string) {
const languageRoot = path.resolve(docsRoot, language)
const relativePath = path.relative(languageRoot, filePath).replace(/\\/g, '/')
if (relativePath === 'index.md') {
return `/${language}/`
}
if (relativePath.endsWith('/index.md')) {
return `/${language}/${relativePath.slice(0, -'index.md'.length)}`
}
return `/${language}/${relativePath.replace(/\.md$/, '')}`
}
function resolveStaticFilePath(rootDir: string, pathname: string) {
const normalizedPath = pathname.replace(/\/+/g, '/')
if (!normalizedPath.startsWith(docsBasePath)) {
return null
}
const relativePath = normalizedPath.slice(docsBasePath.length).replace(/^\/+/, '')
const candidates = buildPathCandidates(rootDir, relativePath)
return candidates.find((candidate) => existsSync(candidate)) || null
}
function buildPathCandidates(rootDir: string, relativePath: string) {
if (!relativePath) {
return [path.join(rootDir, 'index.html')]
}
if (relativePath.endsWith('/')) {
return [path.join(rootDir, relativePath, 'index.html')]
}
if (path.extname(relativePath)) {
return [path.join(rootDir, relativePath)]
}
return [
path.join(rootDir, `${relativePath}.html`),
path.join(rootDir, relativePath, 'index.html')
]
}
|