@c-time/frelio-data-json-recipe

Frelio SSG のビルドレシピ（build-data-recipe）の型定義。

概要

ビルドレシピは、コンテンツをどのように変換して data-json を生成するかを定義する設定ファイルのスキーマ。コンテンツタイプごとの詳細ページ・一覧ページの生成ルール、静的ページの定義、カスタムフィールド変換などを記述する。

ランタイム依存なし。型定義と型ガードのみを提供する。

インストール

npm install @c-time/frelio-data-json-recipe

使用例

import type {
  FrelioBuildDataRecipe,
  ContentTypeRecipe,
  DetailPageRecipe,
  ListPageRecipe,
} from '@c-time/frelio-data-json-recipe'

import {
  isListPageRecipeWithPagination,
  isCustomFieldTransform,
} from '@c-time/frelio-data-json-recipe'

// レシピの型チェック
const recipe: FrelioBuildDataRecipe = {
  contentTypes: { /* ... */ },
  staticPages: [],
  templateIncludes: {},
}

// ページネーションの有無を判定
if (isListPageRecipeWithPagination(listRecipe)) {
  console.log(listRecipe.pagination.perPage)
}

主な型

カスタムフィールドのフォーマットタイプ

string, date, number, escape, toc, truncate, stripHtml, slug, lowercase, uppercase, default, count, first, last, join, url, picture, img, srcset, fileLink, relationList, constant など 25 種類以上。

型ガード

ライセンス

MIT