methanol 0.0.9 → 0.0.11

package/src/pages.js

@@ -28,7 +28,6 @@ import { compilePageMdx } from './mdx.js'
 import { createStageLogger } from './stage-logger.js'
 
 const isPageFile = (name) => name.endsWith('.mdx') || name.endsWith('.md')
-const isInternalPage = (name) => name.startsWith('_') || name.startsWith('.')
 const isIgnoredEntry = (name) => name.startsWith('.') || name.startsWith('_')
 
 const pageMetadataCache = new Map()
@@ -107,17 +106,17 @@ const resolveLanguageForRoute = (languages = [], routePath = '/') => {
 	return best || rootLanguage
 }
 
-export const routePathFromFile = (filePath, pagesDir = state.PAGES_DIR) => {
-	if (!filePath.endsWith('.mdx') && !filePath.endsWith('.md')) {
+export const routePathFromFile = (path, pagesDir = state.PAGES_DIR) => {
+	if (!path.endsWith('.mdx') && !path.endsWith('.md')) {
 		return null
 	}
-	const relPath = relative(pagesDir, filePath)
+	const relPath = relative(pagesDir, path)
 	if (relPath.startsWith('..')) {
 		return null
 	}
 	const name = relPath.replace(/\.(mdx|md)$/, '')
 	const baseName = name.split(/[\\/]/).pop()
-	if (isInternalPage(baseName)) {
+	if (isIgnoredEntry(baseName)) {
 		return null
 	}
 	const normalized = name.replace(/\\/g, '/')
@@ -147,8 +146,8 @@ const parseFrontmatter = (raw) => {
 	}
 }
 
-const parsePageMetadata = async (filePath) => {
-	const raw = await readFile(filePath, 'utf-8')
+const parsePageMetadata = async (path) => {
+	const raw = await readFile(path, 'utf-8')
 	const { data: frontmatter, content, matter } = parseFrontmatter(raw)
 	let title = frontmatter.title
 	return {
@@ -198,13 +197,21 @@ const buildPagesTree = (pages, options = {}) => {
 		}
 		return routePath
 	}
+	const buildDirRoutePath = (dir) => {
+		const localPath = dir ? `/${dir}/` : '/'
+		if (!rootPrefix) return normalizeRoutePath(localPath)
+		return normalizeRoutePath(`${rootPrefix}${localPath}`)
+	}
+	const resolveDirFsPath = (dir) => {
+		if (!rootDir) return resolve(state.PAGES_DIR, dir)
+		return resolve(state.PAGES_DIR, join(rootDir, dir))
+	}
 	const currentRouteWithinRoot = resolveRouteWithinRoot(currentRoutePath)
 	const isUnderRoot = (page) => {
 		if (!rootDir) return true
 		return page.routePath === rootPath || (rootPrefix && page.routePath.startsWith(`${rootPrefix}/`))
 	}
 	const treePages = pages
-		.filter((page) => !page.isInternal)
 		.filter((page) => isUnderRoot(page))
 		.map((page) => {
 			if (!rootDir) return page
@@ -267,10 +274,10 @@ const buildPagesTree = (pages, options = {}) => {
 		const dir = {
 			type: 'directory',
 			name,
-			path: `/${path}`,
+			path: resolveDirFsPath(path),
 			children: [],
 			depth,
-			routePath: null,
+			routePath: buildDirRoutePath(path),
 			routeHref: null,
 			title: null,
 			weight: null,
@@ -291,9 +298,9 @@ const buildPagesTree = (pages, options = {}) => {
 	}
 	for (const page of treePages) {
 		if (page.hidden && !(includeHiddenRoot && page.routePath === rootPath)) {
-			const isHidden404 = page.routePath === '/404'
+			const isHiddenSpecial = page.routePath === '/404' || page.routePath === '/offline'
 			const shouldExposeHidden =
-				!isHidden404 &&
+				!isHiddenSpecial &&
 				page.hiddenByFrontmatter === true &&
 				(
 					page.routePath === currentRoutePath ||
@@ -404,7 +411,7 @@ const walkPages = async function* (dir, basePath = '') {
 		const relativePath = join(basePath, name).replace(/\\/g, '/')
 		const isIndex = name === 'index'
 		const routePath = isIndex ? (basePath ? `/${basePath}/` : '/') : `/${relativePath}`
-		yield { routePath, filePath: fullPath, isIndex }
+		yield { routePath, path: fullPath, isIndex }
 	}
 
 	for (const { entry, fullPath } of dirs) {
@@ -412,39 +419,45 @@ const walkPages = async function* (dir, basePath = '') {
 	}
 }
 
-export const buildPageEntry = async ({ filePath, pagesDir, source }) => {
-	const routePath = routePathFromFile(filePath, pagesDir)
+export const buildPageEntry = async ({ path, pagesDir, source }) => {
+	const routePath = routePathFromFile(path, pagesDir)
 	if (!routePath) return null
-	const relPath = relative(pagesDir, filePath).replace(/\\/g, '/')
+	const relPath = relative(pagesDir, path).replace(/\\/g, '/')
 	const name = relPath.replace(/\.(mdx|md)$/, '')
 	const baseName = name.split('/').pop()
 	const dir = name.split('/').slice(0, -1).join('/')
 	const dirName = dir ? dir.split('/').pop() : ''
 	const isIndex = baseName === 'index'
 	const segments = routePath.split('/').filter(Boolean)
-	const stats = await stat(filePath)
-	const cached = pageMetadataCache.get(filePath)
+	const stats = await stat(path)
+	const cached = pageMetadataCache.get(path)
 	let metadata = null
 	if (cached && cached.mtimeMs === stats.mtimeMs) {
 		metadata = cached.metadata
 	} else {
-		metadata = await parsePageMetadata(filePath)
-		pageMetadataCache.set(filePath, { mtimeMs: stats.mtimeMs, metadata })
+		metadata = await parsePageMetadata(path)
+		pageMetadataCache.set(path, { mtimeMs: stats.mtimeMs, metadata })
 	}
-	const derived = pageDerivedCache.get(filePath)
+	const derived = pageDerivedCache.get(path)
 	const exclude = Boolean(metadata.frontmatter?.exclude)
 	const frontmatterHidden = metadata.frontmatter?.hidden
 	const hiddenByFrontmatter = frontmatterHidden === true
 	const isNotFoundPage = routePath === '/404'
-	const hidden = frontmatterHidden === false
-		? false
-		: frontmatterHidden === true
-			? true
-			: isNotFoundPage || Boolean(metadata.frontmatter?.isRoot)
+	const isOfflinePage = routePath === '/offline'
+	const isSpecialPage = isNotFoundPage || isOfflinePage
+	const isSiteRoot = routePath === '/'
+	const frontmatterIsRoot = Boolean(metadata.frontmatter?.isRoot)
+	const hidden = isSpecialPage
+		? true
+		: frontmatterHidden === false
+			? false
+			: frontmatterHidden === true
+				? true
+				: frontmatterIsRoot
 	return {
 		routePath,
 		routeHref: withBase(routePath),
-		filePath,
+		path,
 		source,
 		relativePath: relPath,
 		name: baseName,
@@ -452,11 +465,10 @@ export const buildPageEntry = async ({ filePath, pagesDir, source }) => {
 		segments,
 		depth: segments.length,
 		isIndex,
-		isInternal: isInternalPage(baseName),
 		title: metadata.title || derived?.title || (baseName === 'index' ? (dirName || 'Home') : baseName),
 		weight: parseWeight(metadata.frontmatter?.weight),
 		date: parseDate(metadata.frontmatter?.date) || parseDate(stats.mtime),
-		isRoot: Boolean(metadata.frontmatter?.isRoot),
+		isRoot: isSiteRoot || frontmatterIsRoot,
 		hidden,
 		hiddenByFrontmatter,
 		exclude,
@@ -468,9 +480,7 @@ export const buildPageEntry = async ({ filePath, pagesDir, source }) => {
 			size: stats.size,
 			createdAt: stats.birthtime?.toISOString?.() || null,
 			updatedAt: stats.mtime?.toISOString?.() || null
-		},
-		createdAt: stats.birthtime?.toISOString?.() || null,
-		updatedAt: stats.mtime?.toISOString?.() || null
+		}
 	}
 }
 
@@ -481,7 +491,7 @@ const collectPagesFromDir = async (pagesDir, source) => {
 	const pages = []
 	for await (const page of walkPages(pagesDir)) {
 		const entry = await buildPageEntry({
-			filePath: page.filePath,
+			path: page.path,
 			pagesDir,
 			source
 		})
@@ -523,7 +533,12 @@ const collectPages = async () => {
 
 const buildIndexFallback = (pages, siteName) => {
 	const visiblePages = pages
-		.filter((page) => !page.isInternal && page.routePath !== '/')
+		.filter(
+			(page) =>
+				page.routePath !== '/' &&
+				page.routePath !== '/404' &&
+				page.routePath !== '/offline'
+		)
 		.sort((a, b) => a.routePath.localeCompare(b.routePath))
 
 	const lines = [
@@ -574,7 +589,7 @@ const buildNavSequence = (nodes, pagesByRoute) => {
 	const seen = new Set()
 	const addEntry = (entry) => {
 		if (!entry.routePath) return
-		const key = entry.filePath || entry.routePath
+		const key = entry.path || entry.routePath
 		if (seen.has(key)) return
 		seen.add(key)
 		result.push(entry)
@@ -616,14 +631,13 @@ export const buildPagesContext = async ({ compileAll = true } = {}) => {
 		pages.unshift({
 			routePath: '/',
 			routeHref: withBase('/'),
-			filePath: resolve(state.PAGES_DIR, 'index.md'),
+			path: resolve(state.PAGES_DIR, 'index.md'),
 			relativePath: 'index.md',
 			name: 'index',
 			dir: '',
 			segments: [],
 			depth: 0,
 			isIndex: true,
-			isInternal: false,
 			title: state.SITE_NAME || 'Methanol Site',
 			weight: null,
 			date: null,
@@ -648,10 +662,10 @@ export const buildPagesContext = async ({ compileAll = true } = {}) => {
 		}
 	}
 	const getPageByRoute = (routePath, options = {}) => {
-		const { filePath } = options || {}
-		if (filePath) {
+		const { path } = options || {}
+		if (path) {
 			for (const page of pages) {
-				if (page.routePath === routePath && page.filePath === filePath) {
+				if (page.routePath === routePath && page.path === path) {
 					return page
 				}
 			}
@@ -717,26 +731,26 @@ export const buildPagesContext = async ({ compileAll = true } = {}) => {
 		pagesTree,
 		getPagesTree,
 		derivedTitleCache: pageDerivedCache,
-		setDerivedTitle: (filePath, title, toc) => {
-			if (!filePath) return
-			pageDerivedCache.set(filePath, { title, toc })
+		setDerivedTitle: (path, title, toc) => {
+			if (!path) return
+			pageDerivedCache.set(path, { title, toc })
 		},
-		clearDerivedTitle: (filePath) => {
-			if (!filePath) return
-			pageDerivedCache.delete(filePath)
+		clearDerivedTitle: (path) => {
+			if (!path) return
+			pageDerivedCache.delete(path)
 		},
 		refreshPagesTree: () => {
 			pagesTreeCache.clear()
 			navSequenceCache.clear()
 			pagesContext.pagesTree = getPagesTree('/')
 		},
-		getSiblings: (routePath, filePath = null) => {
+		getSiblings: (routePath, path = null) => {
 			if (!routePath) return { prev: null, next: null }
 			const sequence = getNavSequence(routePath)
 			if (!sequence.length) return { prev: null, next: null }
 			let index = -1
-			if (filePath) {
-				index = sequence.findIndex((entry) => entry.filePath === filePath)
+			if (path) {
+				index = sequence.findIndex((entry) => entry.path === path)
 			}
 			if (index < 0) {
 				index = sequence.findIndex((entry) => entry.routePath === routePath)
@@ -748,7 +762,7 @@ export const buildPagesContext = async ({ compileAll = true } = {}) => {
 					routePath: entry.routePath,
 					routeHref: entry.routeHref,
 					title: entry.title || entry.name || entry.routePath,
-					filePath: entry.filePath || null
+					path: entry.path || null
 				}
 			}
 			return {
@@ -775,7 +789,10 @@ export const buildPagesContext = async ({ compileAll = true } = {}) => {
 		for (let i = 0; i < pages.length; i++) {
 			const page = pages[i]
 			if (logEnabled) {
-				stageLogger.update(compileToken, `Compiling MDX [${i + 1}/${totalPages}] ${page.filePath}`)
+				stageLogger.update(
+					compileToken,
+					`Compiling MDX [${i + 1}/${totalPages}] ${page.routePath || page.path}`
+				)
 			}
 			await compilePageMdx(page, pagesContext, {
 				lazyPagesTree: true,

package/src/public-assets.js

@@ -110,7 +110,7 @@ export const preparePublicAssets = async ({ themeDir, userDir, targetDir }) => {
 	}
 }
 
-export const updateAsset = async ({ type, filePath, themeDir, userDir, targetDir, relPath }) => {
+export const updateAsset = async ({ type, path, themeDir, userDir, targetDir, relPath }) => {
 	const targetPath = resolve(targetDir, relPath)
 
 	if (type === 'unlink') {

package/src/{rewind.js → reframe.js}

@@ -58,7 +58,7 @@ export function env(parentEnv) {
 		const component = ({ children: childrenProp, ...props }, ...children) => {
 			const id = renderCount++
 			const idStr = id.toString(16)
-			const script = `$$rwnd(${JSON.stringify(key)},${id},${Object.keys(props).length ? JSON5.stringify(props) : '{}'})`
+			const script = `$$rfrm(${JSON.stringify(key)},${id},${Object.keys(props).length ? JSON5.stringify(props) : '{}'})`
 
 			return (R) => {
 				return [

package/src/rehype-plugins/link-resolve.js

@@ -76,8 +76,8 @@ const resolvePagesRoot = (filePath) => {
 
 export const linkResolve = () => {
 	return (tree, file) => {
-		const baseDir = file?.path ? dirname(file.path) : file?.cwd || process.cwd()
-		const pagesRoot = resolvePagesRoot(file?.path || null)
+		const baseDir = file.path ? dirname(file.path) : file.cwd || process.cwd()
+		const pagesRoot = resolvePagesRoot(file.path || null)
 		visit(tree, (node) => {
 			if (!isElement(node) || node.tagName !== 'a') {
 				return

package/src/stage-logger.js

@@ -21,6 +21,7 @@
 import { style } from './logger.js'
 
 const now = () => (typeof performance !== 'undefined' ? performance.now() : Date.now())
+const log = console.log.bind(console)
 
 export const createStageLogger = (enabled) => {
 	let lastLength = 0
@@ -28,13 +29,13 @@ export const createStageLogger = (enabled) => {
 	const writeLine = (text, newline) => {
 		if (!process.stdout || !process.stdout.write) {
 			if (newline) {
-				console.log(text)
+				log(text)
 			}
 			return
 		}
 		if (!isTty) {
 			if (newline) {
-				console.log(text)
+				log(text)
 			}
 			return
 		}

package/src/state.js

@@ -101,7 +101,7 @@ const withCommonOptions = (y) =>
 			type: 'boolean',
 			default: false
 		})
-		.option('code-highlighting', {
+		.option('highlight', {
 			describe: 'Enable or disable code highlighting',
 			type: 'boolean',
 			coerce: (value) => {
@@ -125,6 +125,14 @@ const withCommonOptions = (y) =>
 			requiresArg: true,
 			nargs: 1
 		})
+		.option('search', {
+			describe: 'Enable search indexing (pagefind)',
+			type: 'boolean'
+		})
+		.option('pwa', {
+			describe: 'Enable PWA support',
+			type: 'boolean'
+		})
 
 const parser = yargs(hideBin(process.argv))
 	.scriptName('methanol')
@@ -152,9 +160,11 @@ export const cli = {
 	CLI_OUTPUT_DIR: argv.output || null,
 	CLI_CONFIG_PATH: argv.config || null,
 	CLI_SITE_NAME: argv['site-name'] || null,
-	CLI_CODE_HIGHLIGHTING: typeof argv['code-highlighting'] === 'boolean' ? argv['code-highlighting'] : null,
+	CLI_CODE_HIGHLIGHTING: typeof argv.highlight === 'boolean' ? argv.highlight : null,
 	CLI_VERBOSE: Boolean(argv.verbose),
-	CLI_BASE: argv.base || null
+	CLI_BASE: argv.base || null,
+	CLI_SEARCH: argv.search,
+	CLI_PWA: argv.pwa
 }
 
 export const state = {
@@ -183,6 +193,7 @@ export const state = {
 	PAGEFIND_ENABLED: false,
 	PAGEFIND_OPTIONS: null,
 	PAGEFIND_BUILD: null,
+	PWA_ENABLED: false,
 	USER_PRE_BUILD_HOOKS: [],
 	USER_POST_BUILD_HOOKS: [],
 	USER_PRE_BUNDLE_HOOKS: [],
@@ -194,6 +205,8 @@ export const state = {
 	STARRY_NIGHT_ENABLED: false,
 	STARRY_NIGHT_OPTIONS: null,
 	GFM_ENABLED: true,
+	PWA_ENABLED: false,
+	PWA_OPTIONS: null,
 	CURRENT_MODE: 'production',
 	RESOLVED_MDX_CONFIG: undefined,
 	RESOLVED_VITE_CONFIG: undefined

package/src/utils.js

@@ -1,9 +1,31 @@
+/* Copyright Yukino Song, SudoMaker Ltd.
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ * 	http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import NullProtoObj from 'null-prototype-object'
+
 export const cached = (fn) => {
 	let cache = null
 	return () => (cache ?? (cache = fn()))
 }
 
 export const cachedStr = (fn) => {
-	const cache = Object.create(null)
+	const cache = new NullProtoObj()
 	return (key) => (cache[key] ?? (cache[key] = fn(key)))
 }

package/src/vite-plugins.js

@@ -26,7 +26,7 @@ import { normalizePath } from 'vite'
 import { state } from './state.js'
 import { resolveBasePrefix } from './config.js'
 import { genRegistryScript } from './components.js'
-import { INJECT_SCRIPT, LOADER_SCRIPT, PAGEFIND_LOADER_SCRIPT } from './assets.js'
+import { INJECT_SCRIPT, LOADER_SCRIPT, PAGEFIND_LOADER_SCRIPT, PWA_INJECT_SCRIPT } from './client/virtual-module/assets.js'
 import { projectRequire } from './node-loader.js'
 
 const require = createRequire(import.meta.url)
@@ -129,9 +129,22 @@ const virtualModuleMap = {
 	get 'registry.js'() {
 		return `export const registry = ${genRegistryScript()}`
 	},
-	loader: LOADER_SCRIPT,
-	'inject.js': INJECT_SCRIPT,
-	'pagefind-loader': PAGEFIND_LOADER_SCRIPT
+	get loader() {
+		return LOADER_SCRIPT()
+	},
+	get 'inject.js'() {
+		return INJECT_SCRIPT()
+	},
+	get 'pagefind-loader'() {
+		return PAGEFIND_LOADER_SCRIPT()
+	},
+	get 'pwa-inject'() {
+		if (state.PWA_ENABLED) {
+			return PWA_INJECT_SCRIPT()
+		}
+
+		return ''
+	}
 }
 
 const getModuleIdSegment = (id, start) => {