vscode-janus-debug

Visual Studio Code plugin for developing and debugging JavaScript on DOCUMENTS 5 and and other JANUS-based applications.

Features

This extension allows you to debug your JavaScript code directly on a JANUS-based server like DOCUMENTS, otris contract, and otris privacy. This includes launching a script from within VS Code and executing it remotely on the server, setting breakpoints, stepping through the code, and evaluating expressions¹.

This extensions includes lots of additional features that ease the development, especially on DOCUMENTS 5:

Download a single script, edit it with full IntelliSense, and upload it again
Upload all scripts from a local folder to a remote server
Download all scripts from a server to a local folder
Automatically upload a script every time it is saved
Set a script to conflict mode, meaning the script will not be uploaded if it has been changed on server
Compare a local script with the version that is stored on the remote server

Requirements

This extension is only compatible with the JANUS servers listed below. Not every version supports every feature:

Server version	Up-/downloading / running scripts	Remote debugging
DOCUMENTS 5.0a & DOCUMENTS 5.0b	X
DOCUMENTS 5.0c	X	X
privacy 6.1	X	X

If you suspect compatibility issues with your setup, please report them in the issue section.

Remote Debugging

If you want to use the remote debugging features you need at least DOCUMENTS 5.0c!

Add following line to your server's .ini file to enable the debugging engine:

JSDebugger yes

Then restart your server and make sure that your firewall rules allow access to port 8089.

Known Issues

We still see a lot of issues at this early stage.

Attach configuration is not working reliably (#18).
#import and #importFile are not working (#27).

Please have a look at our issue tracker for a complete list of issues.

Troubleshooting

If something doesn't work, please try to reproduce the issue and file a bug here if it is not already known. Please remember to

Include the version you are using in the report.
Tell us which server application you are debugging against and on what OS that server is running.
Include any logs, if possible.

You'll find the log files in your ${workspaceRoot} which is usually the folder you opened in VS Code. The log files are plain-text files so that you can inspect them yourself. We do not log password hashes but the log files might contain source code or other data that you may consider sensitive. Please make sure that you are fine with the data contained in the log file before submitting.

You can alter log behavior in the .vscode/launch.json file.

"log": {
    "fileName": "${workspaceRoot}/vscode-janus-debug-launch.log",
    "logLevel": {
        "default": "Debug",
    }
}

The default log level can be any of Debug, Info, Warn, or Error.

Development

If you want to hack on this VS Code extension start with following recipe:

Fork the repo on our GitHub project page and then

$ git clone https://github.com/your-user-name/vscode-janus-debug.git  # Clone the forked repo
$ cd vscode-janus-debug/  # Change into the source directory
$ npm i  # Install necessary dependencies

Then open the folder in VS Code and you're all set. There are two configurations in the launch.json file, one configuration that starts a new instance of VS Code with just our extension installed, the so called Extension Host, the other configuration executes all tests using mocha.

Make sure you read the contribution guide. Happy hacking!

Legal Notice

This Visual Studio Code extension is developed by otris software AG and was initially released in March 2017. It is licensed under the MIT License, (see LICENSE file).

About otris software AG

As a software-based data and document management specialist, otris software AG supports company decision-makers in realizing management responsibilities. The solutions from otris software are available for this purpose. They can be used track, control and document all administrative processes completely and with full transparency. otris software is based in Dortmund, Germany.

For more information about otris software AG visit our website otris.de or our Open Source repositories at github.com/otris.

Enjoy!

¹ It uses the jsrdbg Debug Protocol to attach to a remote server and debug the JavaScript code executed by SpiderMonkey. Check it out if you want to know more.

PhilippRo/vscode-janus-debug