Skip to content

marklogic/mlxprs

Repository files navigation

MLXPRS: MarkLogic Extension for Visual Studio Code

Develop, run, and debug code for MarkLogic in the popular VS Code IDE

Visual Studio Code, also known as VS Code, is a free, cross-platform code editor and development tool from Microsoft. MLXPRS is a free, open-source extension for VS Code that increases the productivity of developers creating applications on MarkLogic.

Features

  • Syntax highlighting and IntelliSense for MarkLogic Server-Side JavaScript and XQuery
  • Interactive debugging of JavaScript and XQuery running in MarkLogic, including attaching to in-flight requests and inspecting live variables
  • Real-time query evaluation of JavaScript, XQuery, SQL, SPARQL, Optic, and GraphQL against a MarkLogic instance
  • View modules (read-only) in the editor
  • Run marklogic-unit-test module
  • Validate TDE templates and test the templates with node extraction
  • View high-level information about the currently connected MarkLogic server

JavaScript debugging requires version 2.0.0+ of the MarkLogic extension and MarkLogic 10.0-4+.

Getting started

Install this tool using the VS Code built-in marketplace. Search “MarkLogic” from the Extension tab of the activity bar. Click “Install” to download and install the extension.

For more information on installation, configuration and usage, please see the User Guide.

Credit

Aside from excellent development and extension support from Visual Studio Code,

  • Portions of Josh Johnson's vscode-xml project are re-used for XML formatting. The MIT license and source code are kept in the client/xmlFormatting folder of this project.
  • Christy Haragan's marklogic-node-typescript-definitions made this project possible.
  • Paxton Hare's marklogic-sublime xquery-ml.tmLanguage code is used for XQuery-ML syntax and snippets, and the MarkLogic Sublime project inspired this one.