Herramientas

STXT no necesita instalación para empezar. Según lo que quieras hacer:

Playground

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

• No hay nada que instalar ni cuenta que crear; el trabajo se guarda en el propio navegador.
• Viene con una semilla de documentos de ejemplo para tocar y romper.
• Un documento se puede compartir con un enlace que lleva el contenido dentro.

Es el sitio para seguir el tutorial sin salir del navegador.

Extensión de VS Code

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

code --install-extension stxt-lang.stxt

Qué aporta:

• 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

O sin instalar nada de forma permanente:

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 tus documentos tienen errores de el comando se ha usado mal, así que se puede usar directamente en un script. Ningún comando reescribe ficheros sin --write.

Bibliotecas

Tres implementaciones, una por ecosistema, con el mismo alcance y la misma versión. Las tres derivan de la especificación a través de un mismo pseudocódigo de referencia, y las tres pasan el mismo corpus de conformidad. Ninguna tiene dependencias en tiempo de ejecución.

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.

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.

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

O con Gradle:

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

Python

stxt en PyPI. Python puro, 3.10 o superior.

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 incidencias y propuestas se abren en el repositorio de la herramienta afectada; las que son del lenguaje en sí, en stxt-web.