Локальный JSON

Контент, который лежит в репозитории в виде JSON, превращается в статические страницы через sitelo/data. Без API, без базы данных и без клиентского JavaScript. Полный исходник — в examples/json.

Что получится

Структура проекта

my-site/
  sitelo.config.js
  data/
    site.json              # общие настройки сайта
    categories.json        # один объект, ключи — слаги
    products/              # по файлу на товар
      aeron-chair.json
      jarvis-desk.json
      tolomeo-lamp.json
  src/
    lib/
      catalogue.js         # единственный модуль, который обращается к sitelo/data
    index.ht.js            # / — категории и все товары
    products/
      [slug].ht.js         # /products/:slug — по странице на JSON-файл
    categories/
      [slug].ht.js         # /categories/:slug — по странице на ключ

Данные лежат вне src/, поэтому sitelo никогда не считает их страницами или ресурсами.

1. Положите контент в data/

По файлу на товар. Имя файла и есть slug, поэтому aeron-chair.json становится /products/aeron-chair — в самом файле об этом ничего писать не нужно:

{
  "name": "Aeron Chair",
  "category": "seating",
  "price": 1395,
  "released": "2022-04-01",
  "summary": "Mesh task chair with adjustable lumbar support.",
  "inStock": true
}

Категории, наоборот, живут в одном файле: объект, ключи которого — слаги; readJsonCollection читает его точно так же, как коллекцию.

{
  "seating": {
    "name": "Seating",
    "description": "Chairs and stools for long working days."
  },
  "desks": {
    "name": "Desks",
    "description": "Fixed-height and sit-stand work surfaces."
  }
}

2. Читайте в одном месте

Небольшой серверный модуль оборачивает чтение. В HTML на него нет ссылок, поэтому он никогда не попадает в браузер, — а поскольку sitelo/data запоминает результат по файлу, сколько бы страниц ни вызывало эти помощники, каждый JSON-файл разбирается за сборку один раз.

import { readJson, readJsonCollection } from 'sitelo/data'

/** Общие настройки: один JSON-файл, разобранный как есть. */
export function getSite() {
  return readJson('data/site.json')
}

/** По записи на файл, slug берётся из имени файла. */
export function getProducts() {
  return readJsonCollection('data/products', { sort: 'name' })
}

/** Один файл с объектом, ключи которого — слаги; ключ и становится слагом. */
export function getCategories() {
  return readJsonCollection('data/categories.json')
}

/** Товары одной категории, сначала самые дешёвые. */
export async function getProductsInCategory(slug) {
  const products = await readJsonCollection('data/products', { sort: 'price' })
  return products.filter((product) => product.category === slug)
}

3. Выведите всё на главной

import { html, head, title, link, body, h1, h2, ul, li, a } from 'javascript-to-html'
import { getCategories, getProducts, getSite } from './lib/catalogue.js'

export async function data() {
  return {
    site: await getSite(),
    categories: await getCategories(),
    products: await getProducts(),
  }
}

export default ({ data }) =>
  html({ lang: 'ru' },
    head(
      title(data.site.title),
      link({ rel: 'stylesheet', href: '/css/styles.css' }),
    ),
    body(
      h1(data.site.title),
      h2('Категории'),
      ul(
        ...data.categories.map((category) =>
          li(a({ href: `/categories/${category.slug}` }, category.name)),
        ),
      ),
      h2('Все товары'),
      ul(
        ...data.products.map((product) =>
          li(a({ href: `/products/${product.slug}` }, product.name)),
        ),
      ),
    ),
  )

4. По странице на JSON-файл

generateStaticParams возвращает slug для каждого файла во время сборки, а data() подгружает для страницы нужную запись.

import { html, head, title, link, body, h1, p, dl, dt, dd } from 'javascript-to-html'
import { getProduct, getProducts } from '../lib/catalogue.js'

export async function generateStaticParams() {
  const products = await getProducts()
  return products.map((product) => ({ slug: product.slug }))
}

export async function data({ params }) {
  const product = await getProduct(params.slug)
  if (!product) throw new Error(`Unknown product: ${params.slug}`)
  return { product }
}

export default ({ data }) =>
  html({ lang: 'ru' },
    head(
      title(data.product.name),
      link({ rel: 'stylesheet', href: '/css/styles.css' }),
    ),
    body(
      h1(data.product.name),
      p(data.product.summary),
      dl(
        dt('Категория'),
        dd(data.product.category),
        dt('Выпущен'),
        dd(data.product.released),
        dt('Наличие'),
        dd(data.product.inStock ? 'В наличии' : 'Нет в наличии'),
      ),
    ),
  )

5. Правьте и смотрите

npm install
npm run build

В режиме sitelo изменение цены перезагружает открытую страницу — dev-сервер следит за теми JSON-файлами, которые страницы действительно читают. Повторяющиеся слаги, отсутствующие файлы и некорректный JSON останавливают сборку с указанием пути.

Документация по загрузке данных · Документация по маршрутизации · Документация по конфигурации