methanol 0.0.0 → 0.0.1

package/src/mdx.js

@@ -0,0 +1,254 @@
+/* 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 { compile, run } from '@mdx-js/mdx'
+import * as JSXFactory from 'refui/jsx-runtime'
+import * as JSXDevFactory from 'refui/jsx-dev-runtime'
+import rehypeSlug from 'rehype-slug'
+import extractToc from '@stefanprobst/rehype-extract-toc'
+import withTocExport from '@stefanprobst/rehype-extract-toc/mdx'
+import { HTMLRenderer } from './renderer.js'
+import { signal, computed, read, Suspense, nextTick } from 'refui'
+import { createPortal } from 'refui/extras'
+import { pathToFileURL } from 'url'
+import { existsSync } from 'fs'
+import { resolve } from 'path'
+import { state } from './state.js'
+import { resolveUserMdxConfig } from './config.js'
+import { methanolCtx } from './rehype-plugins/methanol-ctx.js'
+import { linkResolve } from './rehype-plugins/link-resolve.js'
+
+// Workaround for Vite: it doesn't support resolving module/virtual modules in script src in dev mode
+const RWND_INJECT = HTMLRenderer.rawHTML`<script type="module" src="/.methanol_virtual_module/inject.js"></script>`
+const RWND_FALLBACK = HTMLRenderer.rawHTML`<script>
+	if (!window.$$rwnd) {
+		const l = []
+		const r = function(k,i,p) {
+			l.push([k,i,p,document.currentScript])
+		}
+		r.$$loaded = l
+		window.$$rwnd = r
+	}
+</script>`
+
+let cachedHeadAssets = null
+
+const resolveUserHeadAssets = () => {
+	if (cachedHeadAssets) {
+		return cachedHeadAssets
+	}
+	const assets = []
+	const pagesDir = state.PAGES_DIR
+	if (!pagesDir) return assets
+	if (existsSync(resolve(pagesDir, 'style.css'))) {
+		assets.push(HTMLRenderer.c('link', { rel: 'stylesheet', href: '/style.css' }))
+	}
+	if (existsSync(resolve(pagesDir, 'index.js'))) {
+		assets.push(HTMLRenderer.c('script', { type: 'module', src: '/index.js' }))
+	} else if (existsSync(resolve(pagesDir, 'index.ts'))) {
+		assets.push(HTMLRenderer.c('script', { type: 'module', src: '/index.ts' }))
+	}
+	if (state.CURRENT_MODE === 'production') {
+		cachedHeadAssets = assets
+	}
+	return assets
+}
+
+export const buildPageContext = ({ routePath, filePath, pageMeta, pagesContext }) => {
+	const page = pageMeta
+	const pagesTree = pagesContext?.getPagesTree ? pagesContext.getPagesTree(routePath) : pagesContext?.pagesTree || []
+	const language = pagesContext?.getLanguageForRoute ? pagesContext.getLanguageForRoute(routePath) : null
+	return {
+		routePath,
+		filePath,
+		page,
+		pages: pagesContext?.pages || [],
+		pagesTree,
+		pagesByRoute: pagesContext?.pagesByRoute || new Map(),
+		languages: pagesContext?.languages || [],
+		language,
+		site: pagesContext?.site || null
+	}
+}
+
+const findTitleFromToc = (toc = []) => {
+	let minDepth = Infinity
+	const scanDepth = (items) => {
+		for (const item of items) {
+			if (typeof item?.depth === 'number') {
+				minDepth = Math.min(minDepth, item.depth)
+			}
+			if (item?.children?.length) {
+				scanDepth(item.children)
+			}
+		}
+	}
+	scanDepth(toc)
+	if (!Number.isFinite(minDepth)) return null
+	let result = null
+	const findFirst = (items) => {
+		for (const item of items) {
+			if (item?.depth === minDepth && item?.value) {
+				result = item.value
+				return true
+			}
+			if (item?.children?.length && findFirst(item.children)) {
+				return true
+			}
+		}
+		return false
+	}
+	findFirst(toc)
+	return result
+}
+
+let cachedMdxConfig = null
+
+const resolveMdxConfig = async () => {
+	const userMdxConfig = await resolveUserMdxConfig()
+	if (cachedMdxConfig) {
+		return cachedMdxConfig
+	}
+	const baseMdxConfig = {
+		outputFormat: 'function-body',
+		jsxRuntime: 'automatic',
+		jsxImportSource: 'refui',
+		development: state.CURRENT_MODE !== 'production',
+		elementAttributeNameCase: 'html',
+		rehypePlugins: [rehypeSlug, extractToc, [withTocExport, { name: 'toc' }]]
+	}
+	const mdxConfig = { ...baseMdxConfig, ...userMdxConfig }
+	if (userMdxConfig.rehypePlugins.length) {
+		mdxConfig.rehypePlugins = [...baseMdxConfig.rehypePlugins, ...userMdxConfig.rehypePlugins]
+	}
+	mdxConfig.rehypePlugins.push(linkResolve)
+	mdxConfig.rehypePlugins.push(methanolCtx)
+	return (cachedMdxConfig = mdxConfig)
+}
+
+export const compileMdx = async ({ content, filePath, ctx }) => {
+	const mdxConfig = await resolveMdxConfig()
+	const runtimeFactory = mdxConfig.development ? JSXDevFactory : JSXFactory
+	const compiled = await compile({ value: content, path: filePath }, mdxConfig)
+
+	return await run(compiled, {
+		...runtimeFactory,
+		baseUrl: pathToFileURL(filePath).href,
+		ctx,
+		rawHTML: HTMLRenderer.rawHTML
+	})
+}
+
+export const compilePageMdx = async (page, pagesContext) => {
+	if (!page || page.content == null || page.mdxComponent) return
+	const mdxModule = await compileMdx({
+		content: page.content,
+		filePath: page.filePath,
+		ctx: buildPageContext({
+			routePath: page.routePath,
+			filePath: page.filePath,
+			pageMeta: page,
+			pagesContext
+		})
+	})
+	page.mdxComponent = mdxModule.default
+	page.toc = mdxModule.toc
+	const shouldUseTocTitle = page.frontmatter?.title == null
+	if (shouldUseTocTitle) {
+		const nextTitle = findTitleFromToc(page.toc) || page.title
+		if (nextTitle !== page.title) {
+			page.title = nextTitle
+			if (typeof pagesContext?.refreshPagesTree === 'function') {
+				pagesContext.refreshPagesTree()
+			}
+		}
+	}
+	if (typeof pagesContext?.setDerivedTitle === 'function') {
+		pagesContext.setDerivedTitle(
+			page.filePath,
+			shouldUseTocTitle ? page.title : null,
+			page.toc
+		)
+	}
+}
+
+export const renderHtml = async ({
+	routePath,
+	filePath,
+	components,
+	pagesContext,
+	pageMeta: explicitPageMeta = null
+}) => {
+	const pageMeta =
+		explicitPageMeta ||
+		(pagesContext.getPageByRoute
+			? pagesContext.getPageByRoute(routePath, { filePath })
+			: pagesContext.pagesByRoute.get(routePath))
+
+	const ctx = buildPageContext({
+		routePath,
+		filePath,
+		pageMeta,
+		pagesContext
+	})
+
+	const [Head, Outlet] = createPortal()
+	const ExtraHead = () => {
+		return [RWND_INJECT, ...resolveUserHeadAssets(), Outlet(), RWND_FALLBACK]
+	}
+
+	await compilePageMdx(pageMeta, pagesContext)
+	const mdxComponent = pageMeta?.mdxComponent
+
+	const Page = ({ components: extraComponents, ...props }, ...children) =>
+		mdxComponent({
+			children,
+			...props,
+			components: {
+				...components,
+				...extraComponents,
+				head: Head,
+				Head
+			}
+		})
+
+	const template = state.USER_THEME.template
+
+	const renderResult = await new Promise((r) => {
+		const result = HTMLRenderer.c(
+			Suspense,
+			{
+				onLoad() {
+					nextTick(() => r(result))
+				}
+			},
+			() =>
+				template({
+					ctx,
+					Page,
+					ExtraHead,
+					HTMLRenderer,
+					components
+				})
+		)
+	})
+
+	return HTMLRenderer.serialize(renderResult)
+}

package/src/node-loader.js

@@ -0,0 +1,88 @@
+/* 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 { readFile } from 'node:fs/promises'
+import { dirname, extname, join, resolve as pathResolve, relative } from 'node:path'
+import { fileURLToPath, pathToFileURL } from 'node:url'
+import { createRequire } from 'node:module'
+import { transform } from 'esbuild'
+
+const __filename = fileURLToPath(import.meta.url)
+const __dirname = dirname(__filename)
+
+const projectRoot = pathResolve('.', '__virtual__.js')
+const projectRootURL = pathToFileURL(projectRoot)
+export const projectRequire = createRequire(projectRootURL)
+
+const require = createRequire(import.meta.url)
+
+const EXTS = new Set(['.jsx', '.tsx', '.ts', '.mts', '.cts'])
+
+export async function load(url, context, nextLoad) {
+	if (url.startsWith('node:') || url.startsWith('data:')) {
+		return nextLoad(url, context, nextLoad)
+	}
+
+	const pathname = new URL(url).pathname
+	const ext = extname(pathname).toLowerCase()
+	if (!EXTS.has(ext)) {
+		return nextLoad(url, context, nextLoad)
+	}
+
+	const source = await readFile(fileURLToPath(url), 'utf-8')
+	const loader = ext === '.tsx' ? 'tsx' : ext === '.jsx' ? 'jsx' : 'ts'
+	const result = await transform(source, {
+		loader,
+		format: 'esm',
+		jsx: 'automatic',
+		jsxImportSource: 'refui',
+		sourcemap: 'inline',
+		sourcefile: fileURLToPath(url)
+	})
+
+	return {
+		format: 'module',
+		shortCircuit: true,
+		source: result.code
+	}
+}
+
+const startPos = 'methanol'.length
+export async function resolve(specifier, context, nextResolve) {
+	if (specifier === 'refui' || specifier.startsWith('refui/')) {
+		try {
+			// Use user installed rEFui when possible
+			return await nextResolve(specifier, { ...context, parentURL: projectRootURL })
+		} catch (e) {
+			return await nextResolve(specifier, { ...context, parentURL: import.meta.url })
+		}
+	} else if (specifier === 'methanol' || specifier.startsWith('methanol/')) {
+		// Force only one Metnanol instance
+		const filePath = require.resolve('..' + specifier.slice(startPos))
+		return {
+			__proto__: null,
+			shortCircuit: true,
+			format: 'module',
+			url: pathToFileURL(filePath).href
+		}
+	} else {
+		return await nextResolve(specifier, context)
+	}
+}

package/src/pagefind.js

@@ -0,0 +1,99 @@
+/* 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 { access } from 'fs/promises'
+import { constants } from 'fs'
+import { join } from 'path'
+import { spawn } from 'child_process'
+import { state } from './state.js'
+
+const resolvePagefindBin = async () => {
+	const binName = process.platform === 'win32' ? 'pagefind.cmd' : 'pagefind'
+	const candidates = [
+		join(state.PROJECT_ROOT, 'node_modules', '.bin', binName),
+		join(state.ROOT_DIR, 'node_modules', '.bin', binName)
+	]
+	for (const candidate of candidates) {
+		try {
+			await access(candidate, constants.X_OK)
+			return candidate
+		} catch {}
+	}
+	return null
+}
+
+const toKebabCase = (value) =>
+	String(value)
+		.replace(/([a-z0-9])([A-Z])/g, '$1-$2')
+		.replace(/_/g, '-')
+		.toLowerCase()
+
+const buildArgsFromOptions = (options) => {
+	if (!options) return []
+	if (Array.isArray(options)) {
+		return options.map(String)
+	}
+	if (typeof options !== 'object') return []
+	const args = []
+	for (const [rawKey, rawValue] of Object.entries(options)) {
+		if (!rawKey) continue
+		const key = String(rawKey)
+		const normalized = toKebabCase(key.replace(/^--/, ''))
+		if (normalized === 'site' || normalized === 'site-dir' || normalized === 'source') {
+			continue
+		}
+		const flag = key.startsWith('--') ? key : `--${normalized}`
+		if (rawValue === true) {
+			args.push(flag)
+		} else if (rawValue === false || rawValue == null) {
+			continue
+		} else {
+			args.push(flag, String(rawValue))
+		}
+	}
+	return args
+}
+
+const runCommand = (command, args, options) =>
+	new Promise((resolve) => {
+		const child = spawn(command, args, {
+			stdio: 'inherit',
+			...options
+		})
+		child.on('close', (code) => resolve(code === 0))
+		child.on('error', () => resolve(false))
+	})
+
+export const runPagefind = async () => {
+	const bin = await resolvePagefindBin()
+	if (!bin) {
+		console.log('Pagefind not found; skipping search indexing.')
+		return false
+	}
+	console.log('Running Pagefind search indexing...')
+	const extraArgs = buildArgsFromOptions(state.PAGEFIND_BUILD_OPTIONS)
+	const ok = await runCommand(bin, ['--site', state.DIST_DIR, ...extraArgs], {
+		cwd: state.PROJECT_ROOT
+	})
+	if (!ok) {
+		console.warn('Pagefind failed to build search index.')
+	}
+	return ok
+}