Obsidian Fault Script - VS Code Extension

Documentação da extensão VS Code para linguagem Obsidian Fault Script (OFS).

Language / Idioma:

English
Portugues (Brasil)

English

What This Extension Provides

Syntax highlighting for .ofs files
Snippets for faster authoring
Hover documentation for OFS keywords and commands
Hover documentation for low-level OFS surfaces such as bedrock, rift, and fault_*
Hover/completion support for interop and layout metadata such as bind, abi, and monolith ... layout packed
Autocomplete for core language symbols
Autocomplete for attached libraries resolved from attach and OFS_LIB_PATH
Diagnostics using ofs check
Native assembly emission using ofs asm
Native VS Code Run and Debug integration (F5 / Run and Debug panel)
Command palette action: OFS: Check
Command palette action: OFS: Emit Native Assembly
Built-in OFS theme: Obsidian Fault Purple

This extension should be updated together with language changes. When OFS gains new syntax, stdlib modules, or package workflows, the extension grammar, snippets, hover docs, and README should be updated in the same change.

Requirements

VS Code ^1.85.0
OFS compiler (ofs) em PATH ou configurado em ofs.path

Settings

ofs.path : Path to OFS executable. Default: ofs.
ofs.diagnosticsOnType : Run diagnostics while typing (debounced). Default: true.
ofs.autoInstallCompiler : Automatically installs OFS compiler on extension activation when missing. Default: true.
ofs.preferEmbeddedCompiler : Prefer compiler embedded in extension (bin/<platform>/ofs) before workspace/system compiler. Default: true.

Commands

OFS: Check (ofs.checkFile)
OFS: Emit Native Assembly (ofs.emitAssembly)

The extension follows the current OFS direction: high-level and low-level OFS should coexist in the same codebase, while LLVM IR and target assembly remain inspection tools instead of the language's identity.

That includes:

small integer types such as u8, u16, u32, u64, i8, i32,
impl blocks for monolith methods,
namespace declarations,
function values and inline lambdas,
bedrock { ... } for typed low-level work,
rift vein for OFS-native interop boundaries,
bind and abi metadata for explicit external boundaries,
monolith ... layout native|packed|c for ABI-facing layout intent,
fault_* intrinsics for machine-like operations with OFS naming,
native graphics modules such as window and the unstable/native canvas package.

Run/Debug now uses native VS Code debug configurations (ofs-native) instead of custom extension buttons.

Install From VSIX

code --install-extension ofs-vscode-extension.vsix

Or in VS Code: Extensions -> ... -> Install from VSIX...

Important: do not use Visual Studio VSIXInstaller.exe; this package targets Visual Studio Code only.

Build Extension Package Locally

cd vscode-extension
npm ci
npm run package

Troubleshooting

ofs: command not found : Set ofs.path in settings or add OFS to PATH.
No diagnostics shown : Ensure ofs.diagnosticsOnType is enabled and the file is saved as .ofs.
Attach/autocomplete for libraries not appearing : Verify attach paths and OFS_LIB_PATH configuration.

Repository Links

Main repository: https://github.com/Samwns/Obsidian-Fault-Script
Issues: https://github.com/Samwns/Obsidian-Fault-Script/issues

Portugues (Brasil)

O Que Esta Extensao Oferece

Highlight de sintaxe para arquivos .ofs
Snippets para acelerar a escrita
Hover docs para palavras-chave e comandos OFS
Hover docs para superficies low-level da OFS como bedrock, rift e fault_*
Suporte de hover/autocomplete para metadados de interop e layout como bind, abi e monolith ... layout packed
Autocomplete para simbolos da linguagem
Autocomplete para bibliotecas anexadas via attach e OFS_LIB_PATH
Diagnosticos usando ofs check
Emissao de assembly nativo usando ofs asm
Integracao nativa com Executar/Depurar do VS Code (F5 / painel Run and Debug)
Acao na paleta de comandos: OFS: Check
Acao na paleta de comandos: OFS: Emit Native Assembly
Tema integrado: Obsidian Fault Purple
Suporte a compilador embutido (bin/<plataforma>/ofs) com fallback de auto-instalacao
Descoberta do compilador self-hosted no workspace (ofs/ofscc/ofscc, ofs/ofscc/ofscc_v2)

Esta extensao deve ser atualizada junto com a linguagem. Quando a OFS ganhar nova sintaxe, novos modulos de stdlib ou novos fluxos de pacote, a gramática, os snippets, os hovers e este README da extensao devem ser atualizados no mesmo conjunto de mudanças.

Requisitos

VS Code ^1.85.0
Compilador OFS no PATH ou configurado em ofs.path

Configuracoes

ofs.path : Caminho para o executavel OFS. Padrao: ofs.

Voce tambem pode configurar ofs.path para ofscc/ofscc_v2 durante os testes do compilador self-hosted.

ofs.diagnosticsOnType : Executa diagnosticos enquanto digita (com debounce). Padrao: true.
ofs.autoInstallCompiler : Instala automaticamente o compilador OFS ao ativar a extensao quando ele nao estiver presente. Padrao: true.
ofs.preferEmbeddedCompiler : Prioriza o compilador embutido na extensao (bin/<plataforma>/ofs) antes do compilador do workspace/sistema. Padrao: true.

Comandos

OFS: Check (ofs.checkFile)
OFS: Emit Native Assembly (ofs.emitAssembly)

A extensao segue a direcao atual da OFS: alto nivel e baixo nivel devem coexistir no mesmo codebase, enquanto LLVM IR e assembly nativo continuam como ferramentas de inspecao, nao como identidade da linguagem.

Isso inclui:

tipos pequenos como u8, u16, u32, u64, i8, i32,
blocos impl para métodos de monolith,
declarações namespace,
funções como valor e lambdas inline,
bedrock { ... } para trabalho low-level tipado,
rift vein para fronteiras de interoperabilidade nativas da OFS,
metadados bind e abi para fronteiras externas explicitas,
monolith ... layout native|packed|c para intencao de layout em tipos expostos por ABI,
intrinsics fault_* para operacoes machine-like com nomes da propria linguagem,
modulos graficos nativos como window e o pacote canvas, que deve ser tratado como nativo/instavel.

Executar/Depurar agora usa configuracoes nativas de debug do VS Code (ofs-native) no lugar de botoes customizados da extensao.

Instalar Via VSIX

code --install-extension ofs-vscode-extension.vsix

Ou no VS Code: Extensions -> ... -> Install from VSIX...

Importante: nao use o VSIXInstaller.exe do Visual Studio; este pacote e apenas para Visual Studio Code.

Gerar Pacote da Extensao Localmente

cd vscode-extension
npm ci
npm run package

Solucao de Problemas

ofs: command not found : Configure ofs.path ou adicione OFS no PATH.
Sem diagnosticos no editor : Verifique se ofs.diagnosticsOnType esta ativo e se o arquivo e .ofs.
Sem autocomplete para bibliotecas : Confira caminhos de attach e a variavel OFS_LIB_PATH.