kos-vscode
v1.1.5
Published
Syntax highlighting, auto-complete, and language diagnostics for KerboScript in Kerbal Operating System.
Downloads
73
Maintainers
Readme
kOS Language Server
A language server for Kerboscript within the KOS mod for Kerbal Space Program. A language server can provide features typical to an IDE language for the supported target language, in this case Kerboscript.
The project currently supports the following clients
- Visual Studio Code via the kOS extension
- Vim via kerbovim
- Atom only with syntax highlight via the kos-ide plugin
For additional client support such as sublime text, emacs, notepad++ or others please post an issue with the requested editor.
Features
Currently the vscode client 1.1.5 implements the follow features
- syntax highlighting
- brace detection
- code snippets
- diagnostics on parsing errors
- go to definition for symbols and run statements
- symbol auto complete
- suffix auto complete
- manual completion triggering
- rename symbol
- unreachable code detection
- function signature help
- file symbol lookup
- workspace symbol lookup
- identify symbols that don't exist
- identify unused symbols
- identify symbols that shadow (hide) an existing variable
- identify symbols that may not exist at runtime
- on hover type definitions (experimental)
- full workspace loading and change propagation
- documentation searching
Directives
The language server includes several comment directives that can be included extra functionality
\\ #include <file path>
: Include a script file in the current files scope even if no run is present\\ #region
: Foldable region start\\ #endRegion
: Foldable region end
Commands
All commands can be launched with ctrl+shift+p
- launch kerbal space program
kOS: Start Kerbal Space Program
- launch telnet client using
kOS: Connect Telnet Client
- Route server logging to LSP inspector
kOS: Route Logging to LSP inspector
- Route server logging to Vscode
kOS: Route Logging to Vscode
- Search kOS Documentation
kOS: Search Documentation
Workspace Configuration
The workspace can be configured with a file called ksconfig.json
. The following is an example
{
"archive": "..",
"bodies": ["earth", "moon", "sun"],
"linting": {
"control-flow-break": "off"
}
}
This will set the archive folder to correspond to the folder above, the valid bodes to be earth
, moon
and sun
and to turn off linting related to invalid break statements. More info can be found here.
Global Configuration
These settings are currently included with the tool
kos-vscode.kerbalSpaceProgramPath
Path to kerbal space programkos-vscode.completionCase
Indicate the preferred completion case for built in symbolskos-vscode.telnetHost
Host name of the telnet serverkos-vscode.telnetPort
Host port of the telnet serverkos-vscode.lspPort
Port to send lsp message to for the LSP Inspectorkos-vscode.trace.server
verbosity
Detail level of the logsformat
Log formatlevel
Message level
Influence
This project is heavily inspired by the crafting interpreters series. Definitely check it out if your interested in creating your own language, or language tooling.