200stack ドキュメント

設定ファイルのルール

設定ファイルは、適用範囲、ルール一覧、404 時の扱いで構成されます。どの項目が必須で、どの項目が用途別に変わるかを確認できます。

type RoutingConfig = {
  // 設定フォーマットのバージョンです。現在は "1" を指定します。
  version: "1"

  // 設定を適用するホストを限定したい場合に使います。
  scope?: {
    hosts?: string[]
  }

  // 上から順に評価されるルール一覧です。
  // 最初に一致した 1 件だけが適用されます。
  rules: RoutingRule[]

  // どのルールにも一致しなかった HTML リクエストの扱いです。
  notFound?: {
    destination: string
    status?: 200 | 404
    htmlOnly?: boolean
  }
}

type RoutingRule = RedirectRule | ForwardRule

type RedirectRule = {
  // ルールを見分けるための ID です。
  // 移行元や用途が分かる名前にします。
  id: string

  // redirect はブラウザの URL を変更します。
  type: "redirect"

  // どの URL に一致させるかを書きます。
  // :name は名前付きパラメータで、name の部分は任意の名前にできます。
  // :year(\\d{4}) は year という名前の値を 4 桁の数字に限定する例です。
  source: string

  // 遷移先です。source で付けた名前は {year} / {slug} のように埋め込めます。
  destination: string

  // 恒久移転は 301 / 308、一時移転は 302 / 307 を使います。
  status?: 301 | 302 | 307 | 308

  // path は既定です。regex では JavaScript RegExp に近い書き方を使います。
  patternSyntax?: "path" | "regex" | "glob"

  // クエリ文字列を引き継ぐ場合は preserve、捨てる場合は drop を指定します。
  query?: "preserve" | "drop" | "replace" | QueryConfig

  // 外部サイトへ redirect する場合だけ true にします。
  allowExternal?: boolean

  // 外部 redirect を許可するホストを明示します。
  allowlistHosts?: string[]
}

type ForwardRule = {
  // ルールを見分けるための ID です。
  id: string

  // forward は URL を変えずに、別の内部パスを返します。
  type: "forward"

  // どの URL に一致させるかを書きます。
  source: string

  // 同一サイト内の相対パスだけを指定できます。
  destination: string

  // path は既定です。regex では $1 / $2 の番号参照を使えます。
  patternSyntax?: "path" | "regex" | "glob"

  // クエリ文字列をどう扱うかを指定します。
  query?: "preserve" | "drop" | "replace" | QueryConfig
}

type QueryConfig = {
  mode?: "preserve" | "drop" | "merge" | "replace"
  params?: Record<string, string>
  encode?: "component" | "none"
}