Przejdź do treści
Biblioteka skilli
Programowanie · Budowanie i kod

yuka

/yuka

Pisze lub zmienia aplikację webową w Yuka, frameworku OCaml z renderowaniem po stronie serwera i wyspami.

Repozytorium
yuka ↗
Licencja
MIT
Ostatnia zmiana repozytorium
13.11.2026

Ocena i bezpieczeństwo

90/ 100Klasa: dobry
Format25 / 25
Frontmatter z nazwą i opisem, poprawna nazwa, opis do 1024 znaków, nazwa zgodna z folderem.
Odkrywalność25 / 25
Opis mówi, kiedy użyć skilla, ma sensowną długość i jest w 3. osobie.
Treść25 / 35
Co najmniej 150 słów i do 500 linii, nagłówki, listy kroków, przykłady albo kod.
Higiena15 / 15
Bez zaślepek typu TODO, bez ścieżek Windows, z licencją.
Ryzykobrak sygnałów w skanie
Pliki w paczce
7
Skrypty
0
Komentarze HTML
0
Adresy URL w SKILL.md
1
Przestarzałość

Brak sygnałów. Repozytorium zmienione 13.11.2026, bez odwołań do wycofanych modeli i API.

Licencja

MIT, otwarta: można używać i zmieniać, z zachowaniem informacji o autorze.

Co robi i kiedy

Pisze lub zmienia aplikację webową w Yuka, frameworku OCaml z renderowaniem po stronie serwera i wyspami.

Oryginalny opis (EN)

Write or change a web app built with Yuka, the OCaml web framework with server-rendered pages and islands. Use when a project depends on the `yuka` opam package, or the task names Yuka, `Routes.ml`, `let[@client]`, `Yuka.Client` or `Yuka.State`. Not for general OCaml, Melange or mlx syntax questions.

Jak działa

  1. Model
  2. References
  3. Rules
  4. Check
Sekcje z nagłówków SKILL.md, w oryginale · 88 linii, 676 słów
Podgląd SKILL.md
---
name: yuka
description: Write or change a web app built with Yuka, the OCaml web framework with server-rendered pages and islands. Use when a project depends on the `yuka` opam package, or the task names Yuka, `Routes.ml`, `let[@client]`, `Yuka.Client` or `Yuka.State`. Not for general OCaml, Melange or mlx syntax questions.
---

# Yuka

Yuka is experimental and its API changes. Do not write Yuka code from
memory: read the reference for the task first. The references are copies
of the `docs/` directory of the Yuka repository.

## Model

- The server renders each page to HTML and streams slow parts when they
  are ready.
- An island is a component that also runs in the browser. Only islands
  ship JavaScript. A page with no island loads none.
- A component is a function that runs once. After the first render, only
  holes, memos and effects run again, when a State they read changes.
  There is no virtual DOM and no dependency list.
- Markup is mlx (JSX for OCaml) in `.mlx` files. Text children are string
  literals or `Yuka.text`, and `class` is written `class_`.
- An app has three parts: a shared library (native and Melange) for
  components and islands, a server executable for pages, and a client
  entry. `Routes.ml` holds the route tree; `yuka routes` reads it and
  writes the `Routes` and `Yuka_routes` modules.

## References

Read the one that matches the task:

- [Getting started](references/getting-started.md): install, project
  layout, every dune rule, the server and client entries, `yuka dev`, the
  production bundle. Read it to create an app or to fix a build rule.
- [Islands](references/islands.md): `let[@client] make`, `<Yuka.Client>`,
  props and codecs, start strategies, children. Read it before you write
  or use an interactive component.
- [State](references/state.md): State, holes, memos, effects, batches,
  what runs on the server. Read it before you write code that updates the
  page.
- [Router](references/router.md): `Routes.ml` nodes, path and search
  params, loaders, guards, layouts, links, client navigation. Read it
  before you add or change a route or a link.
- [Security](references/security.md): escaping, blocked URL schemes,
  `script` and `style` rules. Read it when markup takes user input, or
  when a URL or attribute does not show as written.

The references do not cover remote data (`Yuka.Remote`), server actions
(`Yuka.Action`, `Yuka.Server.Action`), forms (`Yuka.Form`), live data
(`Yuka.Live`, `Yuka.Topic`), `<Yuka.Await>`, `<Yuka.Show>`, `Yuka.each`
or `Yuka.Catch`. For these, read the doc comments of `yuka.mli`
(`find "$(opam var lib)/yuka" -name yuka.mli`) and the `demo/` directory
of <https://github.com/davesnx/yuka>.

## Rules

Each rule prevents a build error or a bug that the references explain.

- An island is `let[@client] make ~(label : type) ... () = ...` at the top
  level of an `.mlx` file in the shared library. One island per file; the
  file name is the tag (`counter.mlx` gives `<Counter />`).
- A page must wrap an island in `<Yuka.Client>`. Without it, the component
  prints HTML only and gets no code in the browser.
- An event handler or a hole outside an island does not compile ("Type
  Yuka.client is not compatible with type Yuka.server"). Move it to an
  island.
- An island cannot contain `<Yuka.Client>` in its own markup. Pass the
  inner island as children from the page.
- Each island prop needs a codec. Put `[@@deriving codec]` on your records
  and variants. A function cannot be a prop.
- The ppx makes a hole only where the expression itself contains
  `Yuka.State.get`. For a read inside another function, write
  `Yuka.hole (fun () -> ...)`.
- Create a State inside `make`, not at the top level of a module.
- Do not copy one State into another with an effect. Use `Yuka.State.memo`.
- Code that needs the browser goes in an effect or an event handler:
  effects do not run on the server.
- Build links with the generated functions (`Routes.hello ~name ()`), not
  with string paths. Every link function ends with `()`.
- An editor does not check `Routes.ml`. Run `dune build` and read the
  errors of `yuka routes`.
- In `Routes.ml`, write a custom param type with its module path
  (`:tab<Model.tab>`), and define `tab_param` in the shared library.
- The client `dune` lists `yuka.js` in `libraries`, and the shared library
  has `(modes native melange)`.

## Check

Run `dune build` after each change. The type checker reports a wrong
prop, param, link or server/client mix. Then load the changed page from
the running server and confirm the result.
Pliki w paczce (7)
  • SKILL.md 4 KB
  • dune 1 KB
  • references/getting-started.md 9 KB
  • references/islands.md 7 KB
  • references/router.md 12 KB
  • references/security.md 3 KB
  • references/state.md 10 KB

Wersje

W bazie nie ma innych skilli o nazwie yuka.

Migawka bazy z 13.11.2026 · wersja paczki fd189c83ae27 (skrót SHA-256 całej paczki)

Pobrania w ostatnich 30 dniach: 0 · ranking

Zgłoś problem z tym skillem: szkodliwa treść, błędny opis albo prośba autora o usunięcie.

Podobne skille

  • 100project-setup
    Opisuje standardy plików metadanych projektów OCaml: inicjalizację biblioteki lub modułu, wydanie przez opam, CI oraz wymagane pliki .mli i .ocamlformat.
  • 95result
    Podpowiada wzorce typu Result w OCaml 5.x: obsługa błędów, łańcuchy let* i wyciąganie wartości z Ok i Error.
  • 100ocaml
    Pomaga w programowaniu funkcyjnym w OCaml: algebraiczne typy danych, dopasowanie wzorców, moduły i Dune, przy narzędziach do analizy statycznej, kompilatorach i oprogramowaniu wysokiej niezawodności.
  • 100astro-static-islands
    Pomaga budować serwisy treściowe w Astro z wyspami statycznymi i minimalnym JavaScriptem po stronie klienta.
  • 100astro-islands
    Dodaje interaktywność do stron Astro przez dyrektywy client:* oraz renderuje dynamiczną treść serwera przez server:defer.
  • 85nuxt
    Pomaga w aplikacjach Nuxt, czyli pełnostackowym frameworku Vue z renderowaniem po stronie serwera, trasami serwerowymi i middleware.

Uwagi i zgłoszenia

Wiadomość trafi do Bartosza Sokolińskiego. Adres e-mail jest potrzebny tylko do odpowiedzi. Szczegóły w polityce prywatności.