Obsidian Fault Script - VS Code Extension
Dedicated documentation for the VS Code extension of Obsidian Fault Script (OFS).
Language / Idioma:
English
What This Extension Provides
- Syntax highlighting for
.ofs files
- Snippets for faster authoring
- Hover documentation for OFS keywords and commands
- Autocomplete for core language symbols
- Autocomplete for attached libraries resolved from
attach and OFS_LIB_PATH
- Diagnostics using
ofs check
- Native VS Code Run and Debug integration (F5 / Run and Debug panel)
- Command palette action:
OFS: Check
- Built-in OFS theme:
Obsidian Fault Purple
- Embedded compiler support (
bin/<platform>/ofs) with auto-install fallback
Requirements
- VS Code
^1.85.0
- OFS compiler in PATH or configured with
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)
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
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
- Autocomplete para simbolos da linguagem
- Autocomplete para bibliotecas anexadas via
attach e OFS_LIB_PATH
- Diagnosticos usando
ofs check
- Integracao nativa com Executar/Depurar do VS Code (F5 / painel Run and Debug)
- Acao na paleta de comandos:
OFS: Check
- Tema integrado:
Obsidian Fault Purple
- Suporte a compilador embutido (
bin/<plataforma>/ofs) com fallback de auto-instalacao
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.
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)
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.
Links
