SSG 助手

SSG 助手从您的 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) // The second argument is an option typed `ToSSGOptions`.

对于 Bun

import { toSSG } from 'hono/bun'

toSSG(app) // The second argument is an option typed `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 作为键和扩展名字符串作为值的映射。这用于确定输出文件的扩展名。

每个钩子将在后面描述。

输出

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

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

钩子

您可以通过在选项中指定以下自定义钩子来自定义 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 目标是应用程序中注册的所有路由，但是如果有一些您想排除的路由，您可以通过指定一个钩子来过滤它们。

例如，如果您只想输出 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

如果您想挂钩 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'

// Save `application/x-html` content with `.html`
toSSG(app, fs, {
  extensionMap: {
    'application/x-html': 'html',
    ...defaultExtensionMap,
  },
})

请注意，以斜杠结尾的路径将保存为 index.ext，而不管扩展名是什么。

// save to ./static/html/index.html
app.get('/html/', (c) => c.html('html'))

// save to ./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 助手 ​

用法 ​

手动 ​

Vite 插件 ​

toSSG ​

输入 ​

使用 Deno 和 Bun 的适配器 ​

选项 ​

输出 ​

钩子 ​

BeforeRequestHook/AfterResponseHook ​

AfterGenerateHook ​

生成文件 ​

路由和文件名 ​

文件扩展名 ​

中间件 ​

ssgParams ​

disableSSG ​

onlySSG ​