jonasouellet/vscode-zscript

ZScript language support for visual studio code

ZScript (ZBrush scripting language)

Description

ZScript language support for VS Code

(ZScript is used in zBrush to automate tasks and script workflows.)

Features

Intelligent autocomplete

• Provide valid zcommand name
• Provide the valid variable type
• Provide auto complete for command that require path (ex: <zscriptinsert, "myScript.txt">)
• Provide routine definition comment
• Provide routine definition arg type

• Provide window path (new in 1.4)

ZCommand Signature

Display information about each command argument (type, description)

Hover

Provide information about a symbol when hovering it.

Variables

• Display all the variables in the file.
• provide goto declaration functionality
• Variable has type.

Snippets

• Loop insert a loop command snippet.
• If insert a if command snippet.
• IfElse insert a if else command snippet.
• RoutineDef insert a routine definition snippet.
• RoutineDef1 insert a routine definition with one arg snippet.

Adding type for routine Definition

You can specifiy the type of your routine definition optional argument to have a better signature and help the autocomplete displaying the good variable type.

Support for zscriptinsert

Autocomplete will display variable defined in the inserted file.

Commands

• ZScript: Web Doc Open the zscript documentation web page in your browser
• ZScript: Web Command Reference" Open the zscript command reference web page in your browser.
• ZScript: Install File Icon Display the zbrush icon for zscript files.
• ZScript: Uninstall File Icon Remove the zscript icon display.

Color support

Future implementation

Color Provider

Implemented in 1.1.0 Some command require hexadecimal color (ex: 0xffffff). It is quite hard to know what the color is without looking somewhere else. Hopefully visual studio offer to provide color picker with ColorProvider.

Linter implementation

Implement a linter to display some potential error.

Release Notes

1.4.0

• Add Window path autocomplete

1.3.0

• Implemented rename
• Implemented find references

1.2.0

• Implementation of workspace symbol providers
• Implementation of folding ranges
• Implementation of document link for zscriptinset command

1.1.0

• Implementation of ColorProvider.

1.0.0

• Initial release.

vscode-zscript's Issues

IShowAction mistake in definition

Support for Additional Syntax Highlighting

Fantastic start on this extension, thank you! I wonder what you think about adding support for additional syntax highlighting.. For example: local variables, memory block commands, other command types, etc are colored differently for at a glance recognition? here is an example:
http://bradfolio.com/downloads/notepad-download-zscript-language/

import an invalid file with zscript insert stop parsing from working.

help!

RoutineCall argument only work when calling a routine with a docstring

stringdoesn't have escape character (\)

zscriptinsert should use backslashes on windows

zscript insert should use backslashes on windows instead of slashes.

Also, zscript string doesn't use backslashes as escape character

Error when parsing '<'

Parser doesn't parse the code properly when it encounters an '<' probably because of the zscriptinsert command

Math function doesn't show in autocomplete

[VarDef, dup, INT(value)]

MemWriteString, MemResize - No definition found

Indentation

Implement auto indentation.

Hovering on a function with comment could have a better display

use mardown with arg as list

coma get added event if there is already one

[IGet, "test"] -> changing "IGet" for another zscript command will add a coma after.

Text parsing support spaces and ':'

support spaces when parsing a text, also support character ':' ( ui path)
should stop parsing when encountering any other non letter character