michal-kapala/vscode-jitterbit

VS Code extension for Jitterbit Script

VS Code Jitterbit extension

Full-fledged Visual Studio Code language extension for Jitterbit scripts. It includes:

• language server
• syntax highlighting (TextMate grammar)
• language configuration
• file icon and color theme inspired by Jitterbit Studio

Language server features

Diagnostics

Support for textDocument/publishDiagnostics notification. Errors and warnings are provided by the underlying package.

File notifications

The extension keeps files in sync on editor-originating updates:

• create (workspace/didCreateFiles)
• delete (workspace/didDeleteFiles)
• rename (workspace/didRenameFiles)

Code completion

Support for textDocument/completion request. Jitterbit API definitions (system variables, functions and documentation) are provided by the underlying package.

Hover

Support for textDocument/hover request. Provides variable type information, function signatures and documentation for functions and system variables.

Signature help

Support for textDocument/signatureHelp request. Supports polymorphic functions.

Symbol highlight

Support for textDocument/documentHighlight request.

References

Support for textDocument/references request. Only variable and functions references are supported.

Note that the extension does not perform workspace indexing, thus it will only return the references in files that have been opened in the current editor session.

Renaming

Support for textDocument/rename request. Only variable renaming is supported.

Global/system variable renaming do not require $ in the input. The initial input completion or dotted names will use the segment including the current cursor position.

Similarly to references, only the occurences in files that have been opened in the current editor session will be updated.

Disclaimers

The language server was built using Microsoft's lsp-sample template.

It employs jitterbit-script package for script parsing and static analysis.

This extension is a community effort and as such is not affiliated with, endorsed, supported or maintained by @jitterbit.

The Jitterbit logo is a trademark of Jitterbit, Inc.

vscode-jitterbit's Issues

`Find All References` language feature

Reference provider API implementation

• local variables (file-scoped)
• global variables
• system variables
• functions

Docs

• update README with features
• license
• banner

Commands

Commands for shortcuts such as multiline commenting could be added to simplify the workflow.

Additionally, project file management commands could be added in future to transfer the Jitterbit files into and out of the workspace, e.g. the functionality of jitterbit-extractor.

• comment shortcut
• script execution
• script extraction from project files

feat: `SignatureHelp`

Support for textDocument/signatureHelp requests.

syntax highlighting incompatibility

Currently syntax highlighting breaks highlighting for other file types, this is likely a problem with scope names.

As a workaround you can simply disable the extension when working with other file types and enable it when needed.

Deploying scripts

Hi @michal-kapala,

This is brilliant thanks for sharing!

Have you found a streamlined process to deploy scripts to a Jitterbit project from VS code or you having to copy and paste into Jitterbit Studio?

`Rename` language feature

Rename

• local variables (current file)
• global variables (all opened files in the workspace)

`DocumentHighlight` language feature

Support for textDocument/documentHighlight requests.

`Hover` language feature

Hover API implementation

• variables
• function identifiers

`Completion` language feature

Completion provider API implementation

• system variables
  • docs
• functions
  • docs
• global variables
• local variables
• bool literals