intract

Examples — Intract

Katalog examples/ pokazuje jak używać paczki intract w realistycznych scenariuszach.

Mapa przykładów

Folder Dla kogo Co pokazuje
showcase/ Przeglądarka / UX Interaktywny Dashboard prezentujący Intract live z edytorem i symulatorem
toon/ Integracja / CI Zewnętrzne adresowanie (.toon / intract.toon.yaml) z Makefile i skryptami
web-app/ Aplikacje webowe Dwie iteracji produktu (pass vs violation), mock UI, OpenAPI, Dockerfile
markdown-generator/ Content / dokumenty Generator Markdown pilnujący tematu, sekcji, formatu i zakazanych efektów
full-stack/ Pipeline / analiza Manifest require, duplikaty intencji, graf
integration_tests/ CI / QA 3 automatyczne scenariusze (run_examples.py)
python/ Pojedynczy kontrakt Minimalny @intract.v1 w Pythonie
typescript/ Frontend / API TypeScript + forbid:network
csharp/ .NET Kontrakt na metodzie C#
configs/ Konfiguracja Przykładowy intent.yaml

Szybki start

pip install -e .

# Demo web (mock + walidacja)
bash examples/web-app/run-demo.sh
python -m http.server 8765 --directory examples/web-app
# → http://localhost:8765/mock/index.html

# Integracje
python examples/integration_tests/run_examples.py

# Full-stack
python -m intract validate examples/full-stack --manifest examples/full-stack/intract.yaml

# Markdown generator
bash examples/markdown-generator/run-demo.sh
python -m intract validate examples/markdown-generator/pass \
  --manifest examples/markdown-generator/intract.yaml

Struktura (konwencja)

Każdy większy przykład ma:

examples/<name>/
  README.md          ← jak uruchomić, co oczekiwać
  intract.yaml       ← manifest projektu (opcjonalnie)
  …                  ← kod, artefakty, mock

Przykład web-app rozszerza to o iterations/<v1|v2>/ — symulacja kolejnych sprintów.

Powiązanie z komendami CLI

Komenda Przykład
intract validate web-app/iterations/v1-pass
intract graph full-stack, web-app
intract scan --all-artifacts web-app (OpenAPI + Dockerfile)
intract check --staged --hunks full-stack/README.md
intract planfile push integration_tests/02_*
intract duplicates full-stack

Więcej: docs/commands.md, docs/examples.md.