JSON local

Conteúdo que vive no repositório em JSON, transformado em páginas estáticas pelo sitelo/data. Sem API, sem base de dados e sem JavaScript no cliente. Código completo em examples/json.

O que obténs

Estrutura do projeto

my-site/
  sitelo.config.js
  data/
    site.json              # definições globais do site
    categories.json        # um objeto, indexado por slug
    products/              # um ficheiro por produto
      aeron-chair.json
      jarvis-desk.json
      tolomeo-lamp.json
  src/
    lib/
      catalogue.js         # o único módulo que toca em sitelo/data
    index.ht.js            # / — categorias e todos os produtos
    products/
      [slug].ht.js         # /products/:slug — uma página por ficheiro JSON
    categories/
      [slug].ht.js         # /categories/:slug — uma página por chave

Os dados vivem fora de src/, por isso o sitelo nunca os trata como páginas ou recursos.

1. Põe o conteúdo em data/

Um ficheiro por produto. O nome do ficheiro é o slug, por isso aeron-chair.json passa a ser /products/aeron-chair sem que nada no ficheiro o diga:

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

As categorias, essas, ficam num único ficheiro: um objeto indexado por slug, que o readJsonCollection lê da mesma maneira, como coleção.

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

2. Lê tudo num só sítio

Um pequeno módulo só de servidor envolve as leituras. Nada no HTML lhe faz referência, por isso nunca chega ao browser — e como o sitelo/data memoriza por ficheiro, todas as páginas que chamam estes helpers continuam a analisar cada ficheiro JSON uma só vez em todo o build.

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

/** Definições globais: um ficheiro JSON, analisado tal como está. */
export function getSite() {
  return readJson('data/site.json')
}

/** Uma entrada por ficheiro, slug tirado do nome do ficheiro. */
export function getProducts() {
  return readJsonCollection('data/products', { sort: 'name' })
}

/** Um ficheiro com um objeto indexado por slug — a chave passa a ser o slug. */
export function getCategories() {
  return readJsonCollection('data/categories.json')
}

/** Produtos de uma categoria, do mais barato para o mais caro. */
export async function getProductsInCategory(slug) {
  const products = await readJsonCollection('data/products', { sort: 'price' })
  return products.filter((product) => product.category === slug)
}

3. Lista tudo na página inicial

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

4. Uma página por ficheiro JSON

generateStaticParams devolve um slug por ficheiro durante o build; data() carrega a entrada correspondente a cada página.

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: 'pt' },
    head(
      title(data.product.name),
      link({ rel: 'stylesheet', href: '/css/styles.css' }),
    ),
    body(
      h1(data.product.name),
      p(data.product.summary),
      dl(
        dt('Categoria'),
        dd(data.product.category),
        dt('Lançamento'),
        dd(data.product.released),
        dt('Disponibilidade'),
        dd(data.product.inStock ? 'Em stock' : 'Esgotado'),
      ),
    ),
  )

5. Edita e vê

npm install
npm run build

Com o sitelo, mudar um preço recarrega a página aberta — o servidor de desenvolvimento vigia os ficheiros JSON que as páginas realmente leem. Slugs duplicados, ficheiros em falta e JSON inválido falham o build, identificando o caminho.

Documentação de carregamento de dados · Documentação de rotas · Documentação de configuração