Herramientas

STXT no necesita instalación para empezar. Según el uso previsto:

Playground

play.stxt.dev es un editor en el navegador, concebido como un VS Code simplificado: varios documentos a la vez, sus esquemas o plantillas al lado, errores de sintaxis y de validación durante la edición, autocompletado guiado por la gramática y hover con la definición de cada nodo.

• No requiere instalación ni cuenta; el trabajo se guarda en el propio navegador.
• Incluye una semilla de documentos de ejemplo.
• Un documento se puede compartir con un enlace que lleva el contenido dentro.

Permite seguir el tutorial sin salir del navegador.

Extensión de VS Code

La extensión oficial es STXT Language (stxt-lang.stxt). Desde la paleta de extensiones, buscando stxt, o desde el terminal:

code --install-extension stxt-lang.stxt

Funciones:

• Errores de sintaxis en tiempo real, y de esquema cuando hay una gramática que aplica.
• Coloreado semántico dirigido por el propio parser.
• Autocompletado con los nodos que permite el esquema y los valores de un ENUM.
• Información al pasar el ratón: nodo, nombre canónico, tipo, valores y descripción.
• Ir a la definición (F12): del nodo al Node: de su esquema o a su línea en la Structure de su plantilla.
• Formateo del documento.
• Resolución de esquemas y plantillas desde los directorios .stxt/ del proyecto, del usuario y del sistema, tal como describe la referencia de resolución.

Línea de comandos

El comando stxt es la interfaz para scripts, Makefile y pipelines de integración continua. Se publica en npm como @stxt-lang/cli y necesita Node 20 o superior.

npm install -g @stxt-lang/cli
stxt --version

Sin instalación permanente, con npx:

npx @stxt-lang/cli validate docs/

Los comandos:

Un ejemplo de uso en CI, que falla si algún documento no valida o no está bien formateado:

stxt validate --recursive docs/
stxt format --check --recursive docs/

El código de salida distingue los errores de los documentos (1) del uso incorrecto del comando (2), de modo que se puede usar directamente en un script. Ningún comando reescribe ficheros sin --write. Todas las opciones, las salidas y los códigos de salida están en la referencia de la línea de comandos.

Bibliotecas

Desde este portal se mantienen tres implementaciones oficiales —TypeScript/JavaScript, Java y Python—, y esperamos que aparezcan muchas más para otros lenguajes.

TypeScript / JavaScript

@stxt-lang/core en npm. Es el parser sobre el que corren la extensión, la línea de comandos y el playground. La guía completa —árbol, validación, resolución, JSON canónico, escritura— está en la biblioteca TypeScript.

npm install @stxt-lang/core

Un ejemplo mínimo:

import { Parser, InlineNode } from '@stxt-lang/core';

const result = new Parser().parseResult(text);
for (const error of result.getErrors()) {
	console.error(`line ${error.line} [${error.code}]: ${error.message}`);
}
const root = result.getNodes()[0];
if (root instanceof InlineNode) {
	console.log(root.getChild('Title')?.getText());
}

Java

dev.stxt:stxt-core en Maven Central. Java 17 o superior; módulo automático dev.stxt. La guía completa está en la biblioteca Java.

<dependency>
    <groupId>dev.stxt</groupId>
    <artifactId>stxt-core</artifactId>
    <version>1.0.0</version>
</dependency>

O con Gradle:

implementation 'dev.stxt:stxt-core:1.0.0'

Python

stxt en PyPI. Python puro, 3.10 o superior. La guía completa está en la biblioteca Python.

pip install stxt

Un ejemplo mínimo:

from stxt import Parser, InlineNode

result = Parser().parse_result(text)
for error in result.get_errors():
    print(f"line {error.line} [{error.code}]: {error.message}")
root = result.get_nodes()[0]
if isinstance(root, InlineNode):
    print(root.get_child("Title").get_text())

Código fuente

Todo el ecosistema vive en la organización stxt-lang de GitHub, con licencia MIT:

Las preguntas, las ideas y todo lo que sea del lenguaje en sí van a las discusiones de la organización; los errores, a las incidencias del repositorio de la herramienta afectada.