SSG Helper

SSG Helper 从你的 Hono 应用程序生成静态站点。它会检索已注册路由的内容，并将它们保存为静态文件。

用法

手动

如果你有一个简单的 Hono 应用程序，例如以下示例：

tsx

// index.tsx
const app = new Hono()

app.get('/', (c) => c.html('Hello, World!'))
app.use('/about', async (c, next) => {
  c.setRenderer((content, head) => {
    return c.html(
      <html>
        <head>
          <title>{head.title ?? ''}</title>
        </head>
        <body>
          <p>{content}</p>
        </body>
      </html>
    )
  })
  await next()
})
app.get('/about', (c) => {
  return c.render('Hello!', { title: 'Hono SSG Page' })
})

export default app

对于 Node.js，创建一个像这样的构建脚本：

// build.ts
import app from './index'
import { toSSG } from 'hono/ssg'
import fs from 'fs/promises'

toSSG(app, fs)

通过执行该脚本，文件将按如下方式输出：

bash

ls ./static
about.html  index.html

Vite 插件

使用 @hono/vite-ssg Vite 插件，你可以轻松处理这个过程。

toSSG

toSSG 是用于生成静态站点的核心函数，它接受一个应用程序和一个文件系统模块作为参数。它的基础如下：

输入

toSSG 的参数在 ToSSGInterface 中指定。

export interface ToSSGInterface {
  (
    app: Hono,
    fsModule: FileSystemModule,
    options?: ToSSGOptions
  ): Promise<ToSSGResult>
}

app 指定了带有已注册路由的 new Hono()。
fs 指定了以下对象，假设为 node:fs/promise。

export interface FileSystemModule {
  writeFile(path: string, data: string | Uint8Array): Promise<void>
  mkdir(
    path: string,
    options: { recursive: boolean }
  ): Promise<void | string>
}

为 Deno 和 Bun 使用适配器

如果你想在 Deno 或 Bun 上使用 SSG，则为每个文件系统提供了 toSSG 函数。

对于 Deno:

import { toSSG } from 'hono/deno'

toSSG(app) // 第二个参数是类型为 `ToSSGOptions` 的选项。

对于 Bun:

import { toSSG } from 'hono/bun'

toSSG(app) // 第二个参数是类型为 `ToSSGOptions` 的选项。

选项

选项在 ToSSGOptions 接口中指定。

export interface ToSSGOptions {
  dir?: string
  concurrency?: number
  beforeRequestHook?: BeforeRequestHook
  afterResponseHook?: AfterResponseHook
  afterGenerateHook?: AfterGenerateHook
  extensionMap?: Record<string, string>
}

dir 是静态文件的输出目的地。默认值是 ./static。
concurrency 是同时生成的最大文件并发数。默认值是 2。
extensionMap 是一个包含 Content-Type 作为键，扩展名字符串作为值的映射。它用于确定输出文件的文件扩展名。

每个 Hook 将在后面描述。

输出

toSSG 以以下 Result 类型返回结果。

export interface ToSSGResult {
  success: boolean
  files: string[]
  error?: Error
}

Hook

你可以通过在选项中指定以下自定义 Hook 来定制 toSSG 的处理过程。

export type BeforeRequestHook = (req: Request) => Request | false
export type AfterResponseHook = (res: Response) => Response | false
export type AfterGenerateHook = (
  result: ToSSGResult
) => void | Promise<void>

BeforeRequestHook/AfterResponseHook

toSSG 以应用程序中注册的所有路由为目标，但是如果有一些路由你想排除，你可以通过指定 Hook 来过滤它们。

例如，如果你只想输出 GET 请求，可以在 beforeRequestHook 中过滤 req.method。

toSSG(app, fs, {
  beforeRequestHook: (req) => {
    if (req.method === 'GET') {
      return req
    }
    return false
  },
})

例如，如果你只想在 StatusCode 为 200 或 500 时输出，可以在 afterResponseHook 中过滤 res.status。

toSSG(app, fs, {
  afterResponseHook: (res) => {
    if (res.status === 200 || res.status === 500) {
      return res
    }
    return false
  },
})

AfterGenerateHook

如果你想 Hook toSSG 的结果，请使用 afterGenerateHook。

toSSG(app, fs, {
  afterGenerateHook: (result) => {
    if (result.files) {
      result.files.forEach((file) => console.log(file))
    }
  })
})

生成文件

路由和文件名

以下规则适用于已注册的路由信息和生成的文件名。默认的 ./static 行为如下：

/ -> ./static/index.html
/path -> ./static/path.html
/path/ -> ./static/path/index.html

文件扩展名

文件扩展名取决于每个路由返回的 Content-Type。例如，来自 c.html 的响应将保存为 .html。

如果你想自定义文件扩展名，请设置 extensionMap 选项。

import { toSSG, defaultExtensionMap } from 'hono/ssg'

// 将 `application/x-html` 内容保存为 `.html`
toSSG(app, fs, {
  extensionMap: {
    'application/x-html': 'html',
    ...defaultExtensionMap,
  },
})

请注意，以斜杠结尾的路径将保存为 index.ext，而与扩展名无关。

// 保存到 ./static/html/index.html
app.get('/html/', (c) => c.html('html'))

// 保存到 ./static/text/index.txt
app.get('/text/', (c) => c.text('text'))

中间件

介绍支持 SSG 的内置中间件。

ssgParams

你可以使用类似于 Next.js 的 generateStaticParams 的 API。

示例：

app.get(
  '/shops/:id',
  ssgParams(async () => {
    const shops = await getShops()
    return shops.map((shop) => ({ id: shop.id }))
  }),
  async (c) => {
    const shop = await getShop(c.req.param('id'))
    if (!shop) {
      return c.notFound()
    }
    return c.render(
      <div>
        <h1>{shop.name}</h1>
      </div>
    )
  }
)

disableSSG

设置了 disableSSG 中间件的路由将从 toSSG 的静态文件生成中排除。

app.get('/api', disableSSG(), (c) => c.text('an-api'))

onlySSG

设置了 onlySSG 中间件的路由将在 toSSG 执行后被 c.notFound() 覆盖。

app.get('/static-page', onlySSG(), (c) => c.html(<h1>Welcome to my site</h1>))

SSG Helper ​

用法 ​

手动 ​

Vite 插件 ​

toSSG ​

输入 ​

为 Deno 和 Bun 使用适配器 ​

选项 ​

输出 ​

Hook ​

BeforeRequestHook/AfterResponseHook ​

AfterGenerateHook ​

生成文件 ​

路由和文件名 ​

文件扩展名 ​

中间件 ​

ssgParams ​

disableSSG ​

onlySSG ​