kos-vscode

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 has client support for Visual Studio Code. The extension can be found here. Some work is currently being done to get a client in place for github's Atom editor as well. For additional client support such as sublime text, vim, notepad++ or others please post an issue with the requested editor.

Features

Currently the vscode client 0.6.0 implements the follow features

• synatx highlighting
• brace detection
• code snippets
• diagnostics on parsing errors
• go to definition
• symbol auto complete
• suffix auto complete
• function signature help
• file 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)

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

Settings

These settings are currently included with the tool

• kos-vscode.kerbalSpaceProgramPath Path to kerbal space program
• kos-vscode.completionCase Indicate the perferred completion case for built in symbols
• kos-vscode.telnetHost Host name of the telnet server
• kos-vscode.telnetPort Host port of the telnet server
• kos-vscode.lspPort Port to send lsp message to for the LSP Inspector
• kos-vscode.trace.server
  • verbosity Detail level of the logs
  • format Log format
  • level 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.

Changelog

[0.6.0] (2019-5-30)

Features

• Suffix Completion In addition to completion suggestions for variables, locks, and function, suffixes are suggested when the type is known. This should almost always be the case for common globals such as ship and body.
• Signature Help When the function can be determined signature help can now be provided. Currently the signature displays the types for each parameter but not the parameter name. In a feature release parameter name will be added.

Bug Fixes

• Type Hover Previously, on hover would not work past the first suffix trailer. This version rewrites a large part of the type checker to better resolve types for suffixes. On hover now reports types for all depths of suffix.

Other

• Instruction to Statement changed all references of instruction to statement to better align with the terminology of Kos