Boriel Basic VSCode Extension

Descripción

La extensión Boriel Basic VSCode está diseñada para facilitar el desarrollo de programas en el lenguaje Boriel Basic dentro del editor Visual Studio Code. Boriel Basic es un compilador que permite crear software para computadoras retro como el ZX Spectrum, proporcionando una experiencia de programación moderna para plataformas clásicas.

Funcionalidades

• Resaltado de sintaxis: Coloreado de palabras clave, comentarios, cadenas, números y estructuras del lenguaje en archivos .bas y .zxbas. El resaltado también funciona en bloques de código Boriel Basic dentro de archivos Markdown.
• Compilación integrada: Compila directamente tus archivos .bas desde VSCode usando el compilador Boriel Basic incluido (Windows, Linux y macOS). Genera .tap o .bin en la carpeta dist/. Configurable desde los ajustes de la extensión.
• Autocompletado (LSP): Sugerencias inteligentes de palabras clave, funciones, variables y símbolos definidos en el proyecto, proporcionadas por el Language Server.
• Ir a la definición (LSP): Pulsa F12 o usa clic derecho → Go to Definition para saltar directamente a donde se define una variable, función o etiqueta.
• Buscar referencias (LSP): Localiza todos los usos de un símbolo en el proyecto con clic derecho → Find All References (Shift+F12).
• Documentación al pasar el ratón (LSP): Muestra documentación e información de tipo de variables y funciones al situar el cursor sobre ellas.
• Diagnósticos en tiempo real (LSP): Errores y advertencias subrayados directamente en el editor a medida que escribes, sin necesidad de compilar.
• Formato e indentación (LSP): Formatea el documento con Shift+Alt+F. Opcionalmente convierte las palabras clave a mayúsculas o minúsculas según la opción borielBasic.formatKeywords.
• Rename de símbolos (LSP): Renombra variables, funciones y etiquetas en todos los ficheros del proyecto a la vez pulsando F2 sobre cualquier símbolo.
• Refactor – Extract Method (LSP): Selecciona un bloque de código, abre el menú de refactoring (clic derecho → Refactor… o el icono de bombilla) y elige Extract Method para extraer el bloque a una nueva subrutina.
• Exportar sprites ZXP: Convierte archivos .zxp a código Boriel Basic listo para usar (clic derecho sobre el archivo → Export ZXP to Boriel Basic). Instala automáticamente la librería zxp2boriel en un entorno virtual Python la primera vez.
• Actualización del LSP: Actualiza el servidor de lenguaje a la última versión publicada en npm mediante el comando Boriel Basic: Actualizar Boriel Basic LSP (paleta de comandos).
• Depuración con ZEsarUX: Depura tus programas Boriel Basic directamente desde VSCode usando el emulador ZEsarUX como backend de debug. Soporta puntos de ruptura, inspección de variables y ejecución paso a paso.

Depuración con ZEsarUX

Para depurar un programa necesitas configurar un archivo .vscode/launch.json en tu proyecto:

{
    "version": "0.2.0",
    "configurations": [
        {
            "type": "borielbasic",
            "request": "launch",
            "name": "Debug Boriel Basic (ZEsarUX)",
            "program": "${workspaceFolder}\\dist\\main.tap",
            "sourceFile": "src/main.bas",
            "zesaruxPath": "C:\\path\\to\\ZEsarUX\\zesarux.exe",
            "debugPort": 10000,
            "stopOnEntry": false
        }
    ]
}

Pasos para depurar:

1. Añade puntos de ruptura en tu código .bas haciendo clic en el margen izquierdo del editor.
2. Pulsa F5 o ve a la vista de Depuración (Ctrl+Shift+D) y selecciona la configuración Debug con ZEsarUX.
3. ZEsarUX se lanzará automáticamente y la ejecución se detendrá en los breakpoints definidos.

Nota: ZEsarUX debe estar instalado en tu sistema. Descárgalo desde https://github.com/chernandezba/zesarux.

Instalación

1. Descarga e instala Visual Studio Code.
2. Busca "Boriel Basic" en la sección de extensiones de VSCode.
3. Instala la extensión y reinicia el editor si es necesario.

Uso

1. Abre un archivo .bas o crea uno nuevo.
2. Escribe tu código en Boriel Basic.
3. Usa los comandos disponibles en la paleta de comandos (Ctrl+Shift+P o Cmd+Shift+P) para compilar o ejecutar tu programa.
4. Visualiza los resultados en el emulador o revisa los errores en la consola.

Requisitos

• Opcional: Un emulador compatible con ZX Spectrum para probar tus programas.

Contribuciones

Si deseas contribuir al desarrollo de esta extensión, por favor, abre un issue o envía un pull request en el repositorio oficial.

Licencia

Este proyecto está bajo la licencia MIT. Consulta el archivo LICENSE para más detalles.