Lokalny JSON

Treść, która żyje w repozytorium jako JSON, zamieniona w statyczne strony przez sitelo/data. Bez API, bez bazy danych i bez JavaScriptu po stronie klienta. Pełne źródło w examples/json.

Co dostajesz

Układ projektu

my-site/
  sitelo.config.js
  data/
    site.json              # ustawienia całej witryny
    categories.json        # jeden obiekt, kluczowany slugiem
    products/              # jeden plik na produkt
      aeron-chair.json
      jarvis-desk.json
      tolomeo-lamp.json
  src/
    lib/
      catalogue.js         # jedyny moduł dotykający sitelo/data
    index.ht.js            # / — kategorie i wszystkie produkty
    products/
      [slug].ht.js         # /products/:slug — jedna strona na plik JSON
    categories/
      [slug].ht.js         # /categories/:slug — jedna strona na klucz

Dane leżą poza src/, więc sitelo nigdy nie traktuje ich jak stron ani zasobów.

1. Umieść treść w data/

Jeden plik na produkt. Nazwa pliku jest slugiem, więc aeron-chair.json staje się /products/aeron-chair — nic w pliku nie musi tego mówić:

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

Kategorie to natomiast jeden plik: obiekt kluczowany slugiem, który readJsonCollection czyta tak samo jak kolekcję.

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

2. Czytaj je w jednym miejscu

Mały moduł wyłącznie serwerowy opakowuje odczyty. Nic w HTML-u się do niego nie odwołuje, więc nigdy nie trafia do przeglądarki — a ponieważ sitelo/data memoizuje per plik, każda strona wołająca te pomocniki i tak parsuje każdy plik JSON raz na cały build.

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

/** Ustawienia całej witryny: jeden plik JSON, parsowany bez zmian. */
export function getSite() {
  return readJson('data/site.json')
}

/** Jeden wpis na plik, slug brany z nazwy pliku. */
export function getProducts() {
  return readJsonCollection('data/products', { sort: 'name' })
}

/** Jeden plik z obiektem kluczowanym slugiem — klucz staje się slugiem. */
export function getCategories() {
  return readJsonCollection('data/categories.json')
}

/** Produkty z jednej kategorii, od najtańszego. */
export async function getProductsInCategory(slug) {
  const products = await readJsonCollection('data/products', { sort: 'price' })
  return products.filter((product) => product.category === slug)
}

3. Wypisz wszystko na stronie głównej

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: 'pl' },
    head(
      title(data.site.title),
      link({ rel: 'stylesheet', href: '/css/styles.css' }),
    ),
    body(
      h1(data.site.title),
      h2('Kategorie'),
      ul(
        ...data.categories.map((category) =>
          li(a({ href: `/categories/${category.slug}` }, category.name)),
        ),
      ),
      h2('Wszystkie produkty'),
      ul(
        ...data.products.map((product) =>
          li(a({ href: `/products/${product.slug}` }, product.name)),
        ),
      ),
    ),
  )

4. Jedna strona na plik JSON

generateStaticParams zwraca podczas buildu slug na plik; data() wczytuje dla każdej strony pasujący wpis.

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: 'pl' },
    head(
      title(data.product.name),
      link({ rel: 'stylesheet', href: '/css/styles.css' }),
    ),
    body(
      h1(data.product.name),
      p(data.product.summary),
      dl(
        dt('Kategoria'),
        dd(data.product.category),
        dt('Premiera'),
        dd(data.product.released),
        dt('Dostępność'),
        dd(data.product.inStock ? 'Dostępny' : 'Niedostępny'),
      ),
    ),
  )

5. Edytuj i obserwuj

npm install
npm run build

Pod sitelo zmiana ceny przeładowuje otwartą stronę — serwer deweloperski obserwuje pliki JSON, które strony rzeczywiście czytały. Zduplikowane slugi, brakujące pliki i wadliwy JSON przerywają build ze wskazaniem winnej ścieżki.

Dokumentacja wczytywania danych · Dokumentacja routingu · Dokumentacja konfiguracji