docs / Inicio rápido

Inicio rápido#

mini-format 1.0.0 implementa la especificación .mini 1.0. Los paquetes en PyPI y npm están previstos en el plan de tareas; hasta entonces se instala desde el repositorio.

Python#

git clone https://github.com/LiveLinDev/mini-format
cd mini-format
pip install -e .            # o bien: PYTHONPATH=src
mini forks                  # lista las 14 familias
mini validate forks/a/fixtures/valid.mini
mini prompt log --lang es   # bloque de especificación para el modelo
from minifmt import Registry, parse, dumps, spec_block

reg = Registry.load()                    # descubre forks/*/contract.json
c = reg.get("log")
instruccion = spec_block(c, lang="es")   # va en el prompt de sistema
doc = parse(respuesta, c, strict=False)  # tolerante: acumula errores en doc.errors
doc.records                              # registros válidos, tipados
for e in doc.errors:
    print(e)                             # E10 line 3 [level]: …

TypeScript#

Requiere Node ≥ 22.6. El código corre sin compilar con --experimental-strip-types.

cd mini-format/ts
npm test
import { Registry, parse, specBlock, createReader } from './src/index.ts';
const c = Registry.load().get('log');
const lenient = parse(texto, c, { strict: false });
lenient.invalidLines();   // líneas que hay que regenerar

Siguiente paso#

Lee la especificación para entender la cabecera, los tipos y los escapes, o abre el playground para validar y comparar tokens sin instalar nada.